Schema management CLI for MySQL
Clone or download
Permalink
Failed to load latest commit information.
doc Docs: Escape brackets in ipv6 format example Oct 16, 2018
testdata init, pull: Always store default-character-set and default-collation Aug 24, 2018
vendor diff/push: Fix all remaining bugs in column reordering Sep 4, 2018
.gitignore travis CI: auto-goreleaser upon tagging Jul 11, 2018
.goreleaser.yml goreleaser: change archive and checksum filenames for future releases Jul 11, 2018
.travis.yml travis CI: auto-goreleaser upon tagging Jul 11, 2018
Gopkg.lock diff/push: Fix all remaining bugs in column reordering Sep 4, 2018
Gopkg.toml Switch from godep to dep; fix support for Golang 1.9 (#27) Jun 14, 2018
LICENSE Add skeleton README, along with NOTICE and LICENSE (Apache v2) Oct 18, 2016
NOTICE Docs: update supported database version/flavor list in requirements.md Jul 9, 2018
README.md MySQL 8.0: fix ability to concurrently drop tables that have foreign … Aug 24, 2018
cache.go Update dep github.com/skeema/tengo, and update affected callsites May 31, 2018
cmd_add_env.go Track database flavor (vendor and version) in .skeema files Aug 1, 2018
cmd_diff.go push: new option --foreign-key-checks Jun 30, 2018
cmd_init.go init, pull: Always store default-character-set and default-collation Aug 24, 2018
cmd_lint.go Minor improvements to `skeema lint`, testing Jun 7, 2018
cmd_pull.go init, pull: Always store default-character-set and default-collation Aug 24, 2018
cmd_push.go pull, push, diff: Permit .skeema to override flavor Aug 24, 2018
configutils.go password option: if not supplied, check env var MYSQL_PWD Aug 29, 2018
configutils_test.go password option: if not supplied, check env var MYSQL_PWD Aug 29, 2018
ddlstatement.go push: new option --foreign-key-checks Jun 30, 2018
ddlstatement_test.go password option: if not supplied, check env var MYSQL_PWD Aug 29, 2018
dir.go Dir.InstanceDefaultParams(): Set 3 more session variables Aug 28, 2018
dir_test.go Dir.InstanceDefaultParams(): Set 3 more session variables Aug 28, 2018
exit.go Misc minor fixes and refactoring May 25, 2018
exit_test.go Add integration test suite for extensive coverage May 25, 2018
log.go Update dep github.com/skeema/tengo, and simplify pull and push Jun 6, 2018
shellout.go Misc minor fixes and refactoring May 25, 2018
shellout_test.go Misc minor fixes and refactoring May 25, 2018
skeema.go diff/push: Fix all remaining bugs in column reordering Sep 4, 2018
skeema_cmd_test.go Dir.InstanceDefaultParams(): Set 3 more session variables Aug 28, 2018
skeema_test.go init, pull: Always store default-character-set and default-collation Aug 24, 2018
sqlfile.go Fix two misspellings in comments [ci skip] Jul 6, 2018
sqlfile_test.go Add integration test suite for extensive coverage May 25, 2018
target.go diff/push: Fix all remaining bugs in column reordering Sep 4, 2018

README.md

Skeema

build status code coverage latest release

Skeema is a tool for managing MySQL tables and schema changes. It provides a CLI tool allowing 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 (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
  • Convert non-online migrations from Rails, Django, etc into online schema changes in production

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.

Downloading

Pre-built skeema binaries for Linux and macOS can be downloaded from the releases page.

Compiling

Compiling from scratch requires the Go programming language toolchain, version 1.9 or higher.

To download, build from master, and install (or upgrade) Skeema, run:

go get -u github.com/skeema/skeema

Documentation

Status

Skeema is generally available, having reached v1 release milestone in July 2018. Prior to that, it was in public beta since October 2016.

The skeema binary is supported on macOS and Linux. For now, it cannot be compiled on Windows.

Tagged releases are tested against the following databases, all running on Linux:

  • MySQL 5.5, 5.6, 5.7, 8.0
  • Percona Server 5.6, 5.7
  • MariaDB 10.1, 10.2, 10.3

Outside of a tagged release, every commit to the master branch is automatically tested against MySQL 5.6 and 5.7.

A few uncommon MySQL features -- such as partitioning, fulltext indexes, spatial types, virtual columns -- are not yet supported. Skeema is able to create or drop tables using these features, but not alter them. The output of skeema diff and skeema push clearly displays when this is the case. You may still make such alters directly/manually (outside of Skeema), and then update the corresponding CREATE TABLE files via skeema pull.

Credits

Created and maintained by @evanelias.

Additional contributions by:

License

Copyright 2018 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.