Usage: skeema pull [<options>] [<environment>]
Updates the existing filesystem representation of the schemas on a DB instance. Use this command when changes have been applied to the database manually or outside of Skeema, in order to make the filesystem representation reflect those changes.
You may optionally pass an environment name as a CLI arg. This will affect which section of .skeema config files is used for processing. For example, running skeema pull staging will apply config directives from the [staging] section of config files, as well as any sectionless directives at the top of the file. If no environment name is supplied, the default is “production”.
Pull Options
| Option | Description |
|---|---|
| format | Reformat SQL statements to match canonical SHOW CREATE (enabled by default; disable with skip-format) |
| include-auto-inc | Include starting auto-inc values in new table files, and update in existing files |
| new-schemas | Detect any new schemas and populate new dirs for them (enabled by default; disable with skip-new-schemas) |
| strip-definer | Omit DEFINER clauses when writing procs, funcs, views, and triggers to filesystem |
| strip-partitioning | Omit PARTITION BY clause when writing partitioned tables to filesystem |
| update-partitioning | Update PARTITION BY clauses in existing table files |
| update-seed-inserts | Update INSERTs based on result of querying _seed_* views |
| update-views | Update definitions of existing views, using canonical form |
Workspace Options
| Option | Description |
|---|---|
| docker-cleanup | With workspace=docker, specifies how to clean up containers |
| temp-schema | Name of temporary schema for intermediate operations, created and dropped each run |
| temp-schema-binlog | Controls whether temp schema DDL operations are replicated |
| temp-schema-environment | Offload the temp schema to a different host, as configured by the specified environment |
| temp-schema-threads | Max number of concurrent CREATE/DROP with workspace=temp-schema |
| workspace | Specifies where to run intermediate operations |
Global Options
| Option | Description |
|---|---|
| connect-options | Comma-separated session options to set upon connecting to each database instance |
| debug | Enable debug logging |
| help | Display usage information for the specified command |
| host-wrapper | External bin to shell out to for host lookup; see manual for template vars |
| ignore-func | Ignore functions that match regex |
| ignore-proc | Ignore stored procedures that match regex |
| ignore-schema | Ignore schemas that match regex |
| ignore-table | Ignore tables or views that match regex |
| ignore-trigger | Ignore triggers that match regex |
| ignore-view | Ignore views that match regex |
| my-cnf | Parse ~/.my.cnf for configuration (enabled by default; disable with skip-my-cnf) |
| password | Password for database user; omit value to prompt from TTY |
| server-public-key-path | File path to server public key in PEM format; omit to obtain from server |
| ssh | Tunnel MySQL connections thru SSH to this hostname or user@hostname:port |
| ssh-to-db | SSH to database host in order to establish database connections locally |
| ssl-ca | File path to certificate authority in PEM format |
| ssl-cert | File path to client-side public key in PEM format |
| ssl-key | File path to client-side private key in PEM format |
| ssl-mode | Specify desired connection security SSL/TLS usage |
| ssl-verify-server-cert | Verify server-side cert matches server hostname |
| user | Username to connect to database host |
| version | Display program version |