Usage: skeema init [<options>] [<environment>]
Creates a filesystem representation of the schemas on a DB instance. For each schema on the instance (or just the single schema specified by schema), a subdir with a .skeema config file will be created. Each directory will be populated with .sql files containing CREATE statements for every table and routine in the schema.
You may optionally pass an environment name as a CLI arg. This will affect which section of .skeema config files the host-related options are written to. For example, running skeema init staging will add config directives to the [staging] section of config files. If no environment name is supplied, the default is “production”, so directives will be written to the [production] section of the file.
Init Options
| Option | Description |
|---|---|
| dir | Subdir name to use for this host’s schemas |
| host | Database hostname or IP address |
| include-auto-inc | Include starting auto-inc values in table files |
| port | Port to use for database host |
| schema | Only import the one specified schema; skip creation of subdirs for each schema |
| socket | Absolute path to Unix socket file used if host is localhost |
| 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 |
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 |