dbmate 2.18.0 → 2.19.0

package/README.md

@@ -6,7 +6,7 @@
 
 Dbmate is a database migration tool that will keep your database schema in sync across multiple developers and your production servers.
 
-It is a standalone command line tool that can be used with Go, Node.js, Python, Ruby, PHP, or any other language or framework you are using to write database-backed applications. This is especially helpful if you are writing multiple services in different languages, and want to maintain some sanity with consistent development tools.
+It is a standalone command line tool that can be used with Go, Node.js, Python, Ruby, PHP, Rust, C++, or any other language or framework you are using to write database-backed applications. This is especially helpful if you are writing multiple services in different languages, and want to maintain some sanity with consistent development tools.
 
 For a comparison between dbmate and other popular database schema migration tools, please see [Alternatives](#alternatives).
 
@@ -23,6 +23,7 @@ For a comparison between dbmate and other popular database schema migration tool
     - [SQLite](#sqlite)
     - [ClickHouse](#clickhouse)
     - [BigQuery](#bigquery)
+    - [Spanner](#spanner)
   - [Creating Migrations](#creating-migrations)
   - [Running Migrations](#running-migrations)
   - [Rolling Back Migrations](#rolling-back-migrations)
@@ -50,7 +51,7 @@ For a comparison between dbmate and other popular database schema migration tool
 - Database connection URL is defined using an environment variable (`DATABASE_URL` by default), or specified on the command line
 - Built-in support for reading environment variables from your `.env` file
 - Easy to distribute, single self-contained binary
-- Does not try to upsell you on a SaaS service
+- Doesn't try to upsell you on a SaaS service
 
 ## Installation
 
@@ -85,7 +86,7 @@ $ sudo chmod +x /usr/local/bin/dbmate
 Install using [Scoop](https://scoop.sh)
 
 ```pwsh
-scoop install dbmate
+$ scoop install dbmate
 ```
 
 **Docker**
@@ -104,20 +105,6 @@ If you wish to create or apply migrations, you will need to use Docker's [bind m
 $ docker run --rm -it --network=host -v "$(pwd)/db:/db" ghcr.io/amacneil/dbmate new create_users_table
 ```
 
-**Heroku**
-
-To use dbmate on Heroku, either use the NPM method, or store the linux binary in your git repository:
-
-```sh
-$ mkdir -p bin
-$ curl -fsSL -o bin/dbmate https://github.com/amacneil/dbmate/releases/latest/download/dbmate-linux-amd64
-$ chmod +x bin/dbmate
-$ git add bin/dbmate
-$ git commit -m "Add dbmate binary"
-$ git push heroku master
-$ heroku run bin/dbmate --help
-```
-
 ## Commands
 
 ```sh
@@ -291,18 +278,20 @@ DATABASE_URL="clickhouse://username:password@127.0.0.1:9000/database_name?on_clu
 [See other supported connection options](https://github.com/ClickHouse/clickhouse-go#dsn).
 
 #### BigQuery
+
 Follow the following format for `DATABASE_URL` when connecting to actual BigQuery in GCP:
 
 ```
 bigquery://projectid/location/dataset
 ```
+
 `projectid` (mandatory) - Project ID
 
 `dataset` (mandatory) - Dataset name within the Project
 
 `location` (optional) - Where Dataset is created
 
-*NOTE: Follow [this doc](https://cloud.google.com/docs/authentication/provide-credentials-adc) on how to set `GOOGLE_APPLICATION_CREDENTIALS` environment variable for proper Authentication*
+_NOTE: Follow [this doc](https://cloud.google.com/docs/authentication/provide-credentials-adc) on how to set `GOOGLE_APPLICATION_CREDENTIALS` environment variable for proper Authentication_
 
 Follow the following format if trying to connect to a custom endpoint e.g. [BigQuery Emulator](https://github.com/goccy/bigquery-emulator)
 
@@ -312,6 +301,32 @@ bigquery://host:port/projectid/location/dataset?disable_auth=true
 
 `disable_auth` (optional) - Pass `true` to skip Authentication, use only for testing and connecting to emulator.
 
+#### Spanner
+
+Spanner support is currently limited to databases using the [PostgreSQL Dialect](https://cloud.google.com/spanner/docs/postgresql-interface), which must be chosen during database creation. For future Spanner with GoogleSQL support, see [this discussion](https://github.com/amacneil/dbmate/discussions/369).
+
+Spanner with the Postgres interface requires that the [PGAdapter](https://cloud.google.com/spanner/docs/pgadapter) is running. Use the following format for `DATABASE_URL`, with the host and port set to where the PGAdapter is running:
+
+```shell
+DATABASE_URL="spanner-postgres://127.0.0.1:5432/database_name?sslmode=disable"
+```
+
+Note that specifying a username and password is not necessary, as authentication is handled by the PGAdapter (they will be ignored by the PGAdapter if specified).
+
+Other options of the [postgres driver](#postgresql) are supported.
+
+Spanner also doesn't allow DDL to be executed inside explicit transactions. You must therefore specify `transaction:false` on migrations that include DDL:
+
+```sql
+-- migrate:up transaction:false
+CREATE TABLE ...
+
+-- migrate:down transaction:false
+DROP TABLE ...
+```
+
+Schema dumps are not currently supported, as `pg_dump` uses functions that are not provided by Spanner.
+
 ### Creating Migrations
 
 To create a new migration, run `dbmate new create_users_table`. You can name the migration anything you like. This will create a file `db/migrations/20151127184807_create_users_table.sql` in the current directory:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dbmate",
-  "version": "2.18.0",
+  "version": "2.19.0",
   "description": "A lightweight, framework-agnostic database migration tool",
   "repository": "https://github.com/amacneil/dbmate",
   "homepage": "https://github.com/amacneil/dbmate#readme",
@@ -24,12 +24,12 @@
     "build": "tsc --build"
   },
   "optionalDependencies": {
-    "@dbmate/linux-ia32": "2.18.0",
-    "@dbmate/linux-x64": "2.18.0",
-    "@dbmate/linux-arm": "2.18.0",
-    "@dbmate/linux-arm64": "2.18.0",
-    "@dbmate/darwin-x64": "2.18.0",
-    "@dbmate/darwin-arm64": "2.18.0",
-    "@dbmate/win32-x64": "2.18.0"
+    "@dbmate/linux-ia32": "2.19.0",
+    "@dbmate/linux-x64": "2.19.0",
+    "@dbmate/linux-arm": "2.19.0",
+    "@dbmate/linux-arm64": "2.19.0",
+    "@dbmate/darwin-x64": "2.19.0",
+    "@dbmate/darwin-arm64": "2.19.0",
+    "@dbmate/win32-x64": "2.19.0"
   }
 }