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 SQL files into. Defaults to the current directory.
  • -s, --scope <name> — limit the import to specific database schemas (namespaces). May be repeated.
  • -f, --force — overwrite existing .sql files in the output directory. Without it,import refuses to run against a directory that already contains .sql files, so a re-import can’t silently clobber hand-edited schema (the same guard scaffold applies to a non-empty directory).

See Adopting an existing database for the full workflow.