Prerequisites
- Account access
- Database credentials
- SELECT permissions on metadata tables
- Credits (5 free included)
1
Login & Access
Navigate to the 3X Metadata Intelligence platform and sign in. You will land on the main dashboard.
2
Configure Database Connection
Navigate to Database Settings and select your database type (PostgreSQL, MySQL, Snowflake, etc.).
| Field | Description |
|---|---|
| Host | Database server address |
| Port | Database port (e.g., 5432, 3306) |
| Database Name | Name of the database to document |
| Username | User with read permissions |
| Password | Database password |
Tip: Always click Test Connection to verify connectivity before saving.
3
Configure Output Options
Sample Rows (Default: 5)
Extracts example data to help AI understand patterns. Recommended 5-10 rows.
PII Detection
Automatically identifies sensitive columns like Emails, Names, and SSNs.
Confidence Scoring
Assigns a 0-100% score to each AI-generated description.
Relationship Analysis
Detects foreign keys and maps dependencies across tables.
4
Generate & Export
Select your AI model (GPT-4 or Claude 3.5) and click Generate Documentation. Processing takes 2-5 minutes for small datasets.
Export Formats
| Format | Best For |
|---|---|
Excel (.xlsx) | Business stakeholders, easy sharing |
JSON (.json) | Developers, programmatic integration |
HTML (.html) | Hosting on internal wikis |
PDF (.pdf) | Audits and formal reporting |
Common Issues
Connection Fails
Check firewall/VPN settings and verify the database user has SELECT permissions.
No Tables Visible
Ensure the user has access to `information_schema` or `pg_catalog`.
Generation Timeout
Try reducing the table count for the first run (start with 1-5 tables).