forked from golang-migrate/migrate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add cockroachdb README and add ForceLock functionality
Adds a readme to the cockroachdb database package, following the postgres readme style. Also adds the ability to force acquisition of the migration lock via a connect URL parameter/WithInstance config, to allow for fixing cases where an implementation error causes the schema lock to not be released. Lastly, tweaks the CLI readme to include information on building a CLI for databases other than postgres.
- Loading branch information
Showing
3 changed files
with
45 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# cockroachdb | ||
|
||
`cockroachdb://user:password@host:port/dbname?query` (`cockroach://`, and `crdb-postgres://` work, too) | ||
|
||
| URL Query | WithInstance Config | Description | | ||
|------------|---------------------|-------------| | ||
| `x-migrations-table` | `MigrationsTable` | Name of the migrations table | | ||
| `x-lock-table` | `LockTable` | Name of the table which maintains the migration lock | | ||
| `x-force-lock` | `ForceLock` | Force lock acquisition to fix faulty migrations which may not have released the schema lock (Boolean, default is `false`) | | ||
| `dbname` | `DatabaseName` | The name of the database to connect to | | ||
| `user` | | The user to sign in as | | ||
| `password` | | The user's password | | ||
| `host` | | The host to connect to. Values that start with / are for unix domain sockets. (default is localhost) | | ||
| `port` | | The port to bind to. (default is 5432) | | ||
| `connect_timeout` | | Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely. | | ||
| `sslcert` | | Cert file location. The file must contain PEM encoded data. | | ||
| `sslkey` | | Key file location. The file must contain PEM encoded data. | | ||
| `sslrootcert` | | The location of the root certificate file. The file must contain PEM encoded data. | | ||
| `sslmode` | | Whether or not to use SSL (disable\|require\|verify-ca\|verify-full) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters