Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify postgresql support #186

Merged
merged 1 commit into from
Jan 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,14 @@ $ gcloud beta emulators spanner start
$ export SPANNER_EMULATOR_HOST=localhost:9010
```

## Spanner PostgreSQL Interface

This driver works specifically with the Spanner GoogleSQL dialect. For the
Spanner PostgreSQL dialect, Go's
[database/sql](https://golang.org/pkg/database/sql/) package can be used
directly after setting up the
[PGAdapter](https://cloud.google.com/spanner/docs/pgadapter).

## Troubleshooting

The driver will retry any Aborted error that is returned by Cloud Spanner
Expand Down
4 changes: 0 additions & 4 deletions docs/limitations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,6 @@ Partition Reads
~~~~~~~
Partition Reads can be done by unwrapping the Spanner-specific `SpannerConn` interface and doing the parition reads using that interface.

PostgreSQL
~~~~~~~
Spanner databases that use the PostgreSQL dialect are not yet supported.

Backups
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Backups are not supported by this driver. Use the [Cloud Spanner Go client library](https://github.com/googleapis/google-cloud-go/tree/main/spanner) to manage backups programmatically.