README
¶
Skeema is a tool for managing MySQL and MariaDB schema changes in a declarative fashion using pure SQL. The Skeema CLI tool allows you to:
- Export CREATE TABLE statements to the filesystem, for tracking in a repo (git, hg, svn, etc)
- Diff changes in the schema repo against live DBs to automatically generate DDL
- Manage multiple environments (e.g. dev, staging, prod) and keep them in sync with ease
- Configure use of online schema change tools, such as pt-online-schema-change, for performing ALTERs
- Apply configurable linter rules to proactively catch schema design problems and enforce company policies
Skeema supports a pull-request-based workflow for schema change submission, review, and execution. This permits your team to manage schema changes in exactly the same way as you manage code changes.
Products and downloads
This repo is the free open source Community edition of the Skeema CLI. The Community edition supports management of tables and routines (procs/funcs). Builds are provided for Linux and MacOS.
The paid Premium edition of the Skeema CLI adds support for managing views and triggers, and also includes a native Windows build, among other improvements.
A companion SaaS product, Skeema Cloud Linter, is also available to simplify CI setup for schema repos stored on GitHub.
For download links and more information, visit skeema.io.
Documentation
- Installation
- Getting started: usage examples and screencasts
- Requirements: supported database versions, required privileges, supported DB features, and edge cases
- Recommended workflow: recommended flow from development to production deployments
- Configuration guide: option handling, config file format, and command-line option usage
- Command reference: usage instructions for each command in the Skeema CLI
- Options reference: detailed information on every Skeema option
- Frequently asked questions
Credits
Created and maintained by @evanelias.
Additional contributions by:
Support for stored procedures and functions generously sponsored by Psyonix.
Support for partitioned tables generously sponsored by Etsy.
License
Copyright 2021 Skeema LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Documentation
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
applier
Package applier handles execution of generating diffs between schemas, and appropriate application of the generated DDL.
|
Package applier handles execution of generating diffs between schemas, and appropriate application of the generated DDL. |
|
dumper
Package dumper handles writing SQL statements, obtained from objects in a live schema, to files in a directory.
|
Package dumper handles writing SQL statements, obtained from objects in a live schema, to files in a directory. |
|
linter
Package linter handles logic around linting schemas and returning results.
|
Package linter handles logic around linting schemas and returning results. |
|
tengo
Package tengo (Go La Tengo) is a database automation library.
|
Package tengo (Go La Tengo) is a database automation library. |
|
workspace
Package workspace provides functions for interacting with a temporary MySQL schema.
|
Package workspace provides functions for interacting with a temporary MySQL schema. |