Update sqlite and sqlite3 docs with comparison

nicheinc · May 5, 2021 · ffdcb52 · ffdcb52
1 parent 512097b
commit ffdcb52
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/database/sqlite/README.md b/database/sqlite/README.md
@@ -2,12 +2,16 @@
 
 `sqlite://path/to/database?query`
 
-Unlike other migrate database drivers, the sqlite driver will automatically wrap each migration in an implicit transaction by default.  Migrations must not contain explicit `BEGIN` or `COMMIT` statements.  This behaviour may change in a future major release.  (See below for a workaround.)
+Unlike other migrate database drivers, the sqlite 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.)
 
-The auxiliary query parameters listed below may be supplied to tailor migrate behaviour.  All auxiliary query parameters are optional.
+The auxiliary query parameters listed below may be supplied to tailor migrate behavior.  All auxiliary query parameters are optional.
 
 | URL Query  | WithInstance Config | Description |
 |------------|---------------------|-------------|
 | `x-migrations-table` | `MigrationsTable` | Name of the migrations table.  Defaults to `schema_migrations`. |
 | `x-no-tx-wrap` | `NoTxWrap` | Disable implicit transactions when `true`.  Migrations may, and should, contain explicit `BEGIN` and `COMMIT` statements. |
 
+## Notes
+
+* Uses the `modernc.org/sqlite` sqlite db driver (pure Go)
+  * Has [limited `GOOS` and `GOARCH` support](https://pkg.go.dev/modernc.org/sqlite?utm_source=godoc#hdr-Supported_platforms_and_architectures)
diff --git a/database/sqlite3/README.md b/database/sqlite3/README.md
@@ -2,12 +2,15 @@
 
 `sqlite3://path/to/database?query`
 
-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 behaviour may change in a future major release.  (See below for a workaround.)
+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.)
 
-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 behaviour.  All auxiliary query parameters are optional.
+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.
 
 | URL Query  | WithInstance Config | Description |
 |------------|---------------------|-------------|
 | `x-migrations-table` | `MigrationsTable` | Name of the migrations table.  Defaults to `schema_migrations`. |
 | `x-no-tx-wrap` | `NoTxWrap` | Disable implicit transactions when `true`.  Migrations may, and should, contain explicit `BEGIN` and `COMMIT` statements. |
 
+## Notes
+
+* Uses the `github.com/mattn/go-sqlite3` sqlite db driver (cgo)