// Reference

Data Analytics

Automated SQL generation, schema introspection, and interactive dashboard exports. Use the database analyst command to inspect tables, preview query structures, and export charts securely.

🛡Strict Read-Only Guardrails: The database analysis engine enforces a strict read-only model. It checks and blocks any queries containing modifications or structural adjustments (such as INSERT, UPDATE, DELETE, DROP, or ALTER). The AI has no write permissions over your database, ensuring data cannot be created, modified, or deleted.

Starting Data Analysis

Uneven connects securely to your target databases (including PostgreSQL, MySQL, SQLite, MongoDB, and Redis). The database URL can be supplied using the --db flag, via a local environment variable, or defined inside your project settings:

terminal
# Using command line arguments
uneven analyze --db postgresql://user:pass@localhost:5432/mydb

# Or set environmental variable first
export DATABASE_URL="postgresql://user:pass@localhost:5432/mydb"
uneven analyze

Analysis Modes

Uneven supports two operation modes for database analysis: Automated Mode for quick reports and Interactive Mode for custom exploration.

1. Automated Mode (One-Shot Report)

Pass a natural language prompt directly with the command. The engine automatically translates your intent, connects to the database, runs the generated SQL query, exports the report, and exits:

terminal
uneven analyze --prompt "list users registered last month grouped by country"

2. Interactive Mode (Exploratory Chat)

By omitting the prompt argument, you enter an interactive chat loop. The engine inspects schemas, suggests potential analyses, and awaits your instructions:

terminal
uneven analyze

# Shell starts:
# Select tables to analyze [1-10] > 1, 2, 4
# Generates custom schema metrics and suggests 3 topics...
# Type query or choose a topic [1-3] > _

Export Options & Reports

Once an analysis completes, you can export findings into multiple developer-friendly formats. Configure exports using the command line flags or choose options inside the interactive shell:

FlagType / FormatDescription
--report htmlInteractive DashboardCreates a self-contained HTML page containing modern charts and formatted data tables.
--report excelExcel SpreadsheetSaves raw tabular results directly into .xlsx spreadsheet workbooks.
--report bothCombined ReportGenerates both the Excel workbook and the HTML dashboard simultaneously.
--package-exeStandalone ApplicationPackages HTML dashboards into portable desktop executable applications (.exe).
--theme light/darkVisual ThemeSwitches the visual styling theme of the HTML dashboard report.

Configuring Database Access

You configure all database settings directly from the agent chat using the /analyze command — no configuration files required. Just type / in the chat and follow the interactive menu, or use the shorthand commands below:

/analyze db — Set Connection URL

Sets the database connection string the agent will use when running analysis:

chat
/analyze db postgresql://user:pass@localhost:5432/mydb
/analyze db mysql://root:pass@localhost/shop

/analyze tables — Authorize Tables

Defines which tables the agent is allowed to read and introspect. Tables not listed here are completely off-limits:

chat
/analyze tables users orders products
/analyze tables invoices clients

/analyze mask — Protect Sensitive Data

Hides or anonymizes sensitive columns and tables during retrieval. The agent will never expose masked values in reports or dashboards:

chat
/analyze mask password_hash cpf credit_card_cvv
/analyze mask tables admin_logs columns email phone