Skip to content

Commit

Permalink
changed README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gingersamurai committed Aug 29, 2023
1 parent a8e9126 commit 1778ea5
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Goose supports [embedding SQL migrations](#embedded-sql-migrations), which means
thus no driver `panic()` conflict within your codebase!
- goose pkg doesn't have any vendor dependencies anymore
- We use timestamped migrations by default but recommend a hybrid approach of using timestamps in the development process and sequential versions in production.
- Supports missing (out-of-order) migrations with the `-allow-missing` flag, or if using as a library supply the functional option `goose.WithAllowMissing()` to Up, UpTo or UpByOne.
- Supports missing (out-of-order) migrations with the `-allow-missing` flag, or if using as a library supply the functional option `goose.WithAllowMissing()` to Up, UpTo or UpByOne. YDB Doesn't support this feature.
- Supports applying ad-hoc migrations without tracking them in the schema table. Useful for seeding a database after migrations have been applied. Use `-no-versioning` flag or the functional option `goose.WithNoVersioning()`.

# Install
Expand All @@ -41,7 +41,7 @@ This will install the `goose` binary to your `$GOPATH/bin` directory.

For a lite version of the binary without DB connection dependent commands, use the exclusive build tags:

$ go build -tags='no_postgres no_mysql no_sqlite3' -o goose ./cmd/goose
$ go build -tags='no_postgres no_mysql no_sqlite3 no_ydb' -o goose ./cmd/goose

For macOS users `goose` is available as a [Homebrew Formulae](https://formulae.brew.sh/formula/goose#default):

Expand Down Expand Up @@ -79,7 +79,7 @@ Examples:
goose mssql "sqlserver://user:password@dbname:1433?database=master" status
goose clickhouse "tcp://127.0.0.1:9000" status
goose vertica "vertica://user:password@localhost:5433/dbname?connection_load_balance=1" status
goose ydb "grpcs://localhost:2135/local?query_mode=scripting&go_fake_tx=scripting&go_query_bind=declare,numeric" status
goose ydb "grpc://localhost:2136/local?query_mode=scripting&go_fake_tx=scripting&go_query_bind=declare,numeric" status
Options:
Expand Down Expand Up @@ -126,7 +126,6 @@ Create a new SQL migration.
$ Created new file: 20170506082420_add_some_column.sql

Edit the newly created file to define the behavior of your migration.
For ydb first line should be `-- +goose NO TRANSACTION`, because ydb is not supported create table in transaction.

You can also create a Go migration, if you then invoke it with [your own goose binary](#go-migrations):

Expand Down

0 comments on commit 1778ea5

Please sign in to comment.