Skip to content
NSchema

import

Read the live database schema and write it out as desired-schema source files. Use this to adopt an existing database into NSchema: import it, then check the generated files into source control and manage further changes with plan / apply.

Terminal window
nschema import --out-dir ./schemas

Options

Section titled “Options”
  • -o, --out-dir <path> — directory to write the imported files into. Defaults to the current directory.
  • -s, --scope <address> — limit the import to a schema (app) or a single object (app.orders). May be repeated.
  • -f, --force — overwrite existing project files in the output directory. Without it, import refuses to run against a directory that already contains them, so a re-import can’t silently clobber hand-edited schema (the same guard new applies to a non-empty directory).

What it writes

Section titled “What it writes”

One file per major object, grouped by type under a directory per schema — app/schema.nsql for the schema’s own declarations, app/tables/orders.nsql, app/views/…, app/routines/…, and a top-level extensions.nsql for the database-global extensions.

A re-import merges into the files that are already there rather than replacing them, and a file it merges into keeps the name it has: a project imported before the .nsql extension existed stays in its .sql files, so nothing ends up declared twice.

See Adopting an existing database for the full workflow.