1010| ` port ` | The port to bind to. |
1111| ` database ` | The name of the database to connect to. |
1212
13- | URL Query Params | Description |
14- | :----------------------------:| :--------------------------------------------------------------------------------------------------------------------------:|
15- | ` x-auth-token ` | Authentication token. |
16- | ` x-migrations-table ` | Name of the migrations table (default ` schema_migrations ` ). |
17- | ` x-lock-table ` | Name of the table which maintains the migration lock (default ` schema_lock ` ). |
18- | ` x-force-lock ` | Enables force lock acquisition to fix faulty migrations which may not have released the schema lock (disabled by default). |
19- | ` x-use-grpcs ` | Enables gRPCS protocol for YDB connections (default grpc). |
20- | ` x-tls-ca ` | The location of the CA (certificate authority) file. |
21- | ` x-tls-insecure-skip-verify ` | Controls whether a client verifies the server's certificate chain and host name. |
22- | ` x-tls-min-version ` | Controls the minimum TLS version that is acceptable, use 1.0, 1.1, 1.2 or 1.3 (default 1.2). |
13+ | URL Query Params | Description |
14+ | :----------------------------:| :--------------------------------------------------------------------------------------------:|
15+ | ` x-auth-token ` | Authentication token. |
16+ | ` x-migrations-table ` | Name of the migrations table (default ` schema_migrations ` ). |
17+ | ` x-lock-table ` | Name of the table which maintains the migration lock (default ` schema_lock ` ). |
18+ | ` x-use-grpcs ` | Enables gRPCS protocol for YDB connections (default grpc). |
19+ | ` x-tls-ca ` | The location of the CA (certificate authority) file. |
20+ | ` x-tls-insecure-skip-verify ` | Controls whether a client verifies the server's certificate chain and host name. |
21+ | ` x-tls-min-version ` | Controls the minimum TLS version that is acceptable, use 1.0, 1.1, 1.2 or 1.3 (default 1.2). |
2322
2423### Secure connection
2524
@@ -39,4 +38,11 @@ Through the url query, you can change the default behavior:
3938 ` ydb://user:password@host:port/database `
4039- To connect to YDB using [ token] ( https://ydb.tech/docs/en/recipes/ydb-sdk/auth-access-token ) you need to specify token
4140 as query parameter:
42- ` ydb://host:port/database?x-auth-token=<YDB_TOKEN> `
41+ ` ydb://host:port/database?x-auth-token=<YDB_TOKEN> `
42+
43+ ### Locks
44+
45+ If golang-migrate fails to acquire the lock and no migrations are currently running.
46+ This may indicate that one of the migrations did not complete successfully.
47+ In this case, you need to analyze the previous migrations, rollback if necessary, and manually remove the lock from the
48+ ` x-lock-table ` .
0 commit comments