github.com/scraniel/migrate@v0.0.0-20230320185700-339088f36cee/database/sqlite3/README.md (about)

     1  # sqlite3
     2  
     3  `sqlite3://path/to/database?query`
     4  
     5  Unlike other migrate database drivers, the sqlite3 driver will automatically wrap each migration in an implicit transaction by default.  Migrations must not contain explicit `BEGIN` or `COMMIT` statements.  This behavior may change in a future major release.  (See below for a workaround.)
     6  
     7  Refer to [upstream documentation](https://github.com/mattn/go-sqlite3/blob/master/README.md#connection-string) for a complete list of query parameters supported by the sqlite3 database driver.  The auxiliary query parameters listed below may be supplied to tailor migrate behavior.  All auxiliary query parameters are optional.
     8  
     9  | URL Query  | WithInstance Config | Description |
    10  |------------|---------------------|-------------|
    11  | `x-migrations-table` | `MigrationsTable` | Name of the migrations table.  Defaults to `schema_migrations`. |
    12  | `x-no-tx-wrap` | `NoTxWrap` | Disable implicit transactions when `true`.  Migrations may, and should, contain explicit `BEGIN` and `COMMIT` statements. |
    13  
    14  ## Notes
    15  
    16  * Uses the `github.com/mattn/go-sqlite3` sqlite db driver (cgo)