Skip to content
NSchema

format

Reformats your .sql DDL files to a canonical layout.

Terminal window
nschema format                       # format every .sql file under the current directory
nschema format ./schemas/users.sql   # format a single file
nschema format --check               # CI: fail if anything is unformatted
cat users.sql | nschema format -     # format stdin to stdout

nschema format [path] rewrites a single .sql file, or every .sql file found recursively under a directory, in place, and lists the files it changed. path defaults to the current directory.

Options

Section titled “Options”
  • --check — write nothing; list the files that need formatting and exit 2 if any do (errors exit 1). For CI.
  • nschema format - — read DDL from stdin and write the formatted result to stdout, for editor integration.