schedata

Import your existing database into Schedata and explore, document, and optimize it — in one command.

npm i -g schedata
schedata

schedata detects a database running on your machine (Docker or a local port), reads its structure locally, and imports it into a Schedata project. It only sends the schema — table, column, index, and foreign-key definitions. Your data, rows, and connection credentials never leave your machine.

Quick start

npm i -g schedata
schedata            # detect → log in → pick/create a project → import

On first run it opens your browser to authorize the CLI, then walks you through importing.

Commands

| Command | What it does | | --- | --- | | schedata / schedata import | Guided import: detect a local DB, introspect it, push it to a project | | schedata login | Authenticate (opens the browser; --no-browser to paste a token) | | schedata logout | Remove stored credentials | | schedata whoami | Show the signed-in user and org | | schedata projects | List your projects |

Scripting

# Non-interactive import into a brand-new project
schedata import --db postgres://user:pass@localhost:5432/app --create "My App" --yes

Flags: --db <url>, --create <name>, --project <id|name>, --engine <e>, -y/--yes, --api-url <url>, --token <token>. Env: SCHEDATA_TOKEN, SCHEDATA_API_URL.

Supported databases

PostgreSQL · MySQL / MariaDB · SQL Server · MongoDB (schema inferred by sampling).

The CLI auto-discovers databases running in Docker (reading the container's published port and environment for connection details), or probes common localhost ports. You can always pass --db <connection-url> or enter details manually.

How it works

Everything connects and introspects locally. Only a structural schema is uploaded, over an authenticated HTTPS request, and it flows through the same change pipeline as everything else in Schedata. The API token is scoped and revocable from your org's Tokens page, and stored locally in ~/.schedata/config.json.