.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH SKEEMA "1" "September 2022" "skeema version 1.8.2-community (snapshot build from source)" "User Commands"
.SH NAME
skeema \- declarative database schema management system
.SH SYNOPSIS
.B skeema
[\fI\,<options>\/\fR] \fI\,<command>\/\fR
.SH DESCRIPTION
Skeema is a declarative schema management system for MySQL and MariaDB. It
allows you to export a database schema to the filesystem, and apply online
schema changes by modifying CREATE statements in .sql files.
.SS "Commands:"
.TP
add\-environment
Add a new named environment to an existing host directory
.TP
diff
Compare a DB instance's schemas to the filesystem
.TP
format
Normalize format of filesystem representation of database objects
.TP
help
Display usage information
.TP
init
Save a DB instance's schemas to the filesystem
.TP
lint
Check for problems in filesystem representation of database objects
.TP
pull
Update the filesystem representation of schemas
.TP
push
Alter objects on DBs to reflect the filesystem representation
.TP
version
Display program version
.SS "Global Options:"
.TP
\fB\-o\fR, \fB\-\-connect\-options\fR value
Comma\-separated session options to set upon connecting to each database instance
.TP
\fB\-\-debug\fR
Enable debug logging
.TP
\-?, \fB\-\-help\fR[=\fI\,value\/\fR]
Display usage information for the specified command
.TP
\fB\-H\fR, \fB\-\-host\-wrapper\fR value
External bin to shell out to for host lookup; see manual for template vars
.TP
\fB\-\-ignore\-schema\fR value
Ignore schemas that match regex
.TP
\fB\-\-ignore\-table\fR value
Ignore tables that match regex
.TP
\fB\-\-[skip\-]my\-cnf\fR
Parse ~/.my.cnf for configuration (enabled by default; disable with \fB\-\-skip\-my\-cnf\fR)
.TP
\fB\-p\fR, \fB\-\-password\fR[=\fI\,value\/\fR]
Password for database user; omit value to prompt from TTY (default no password)
.TP
\fB\-\-ssl\-mode\fR value
Specify desired connection security SSL/TLS usage (valid values: "disabled", "preferred", "required")
.TP
\fB\-u\fR, \fB\-\-user\fR value
Username to connect to database host (default "root")
.TP
\fB\-\-version\fR
Display program version
.PP
Complete documentation for this command suite is available online:
https://www.skeema.io/docs/commands