Skip to content
PtahDocs
v0.22.0

Graphic preview

100%

This page documents v0.22.0, an older release. Read it in v0.26.0, the latest release

Page type: how-to

Configure the Spanner provider

Diagnose an absent or unusable Spanner executable provider and verify an explicitly trusted installation.

Use this page when an explicit Spanner provider selection reports a missing or unusable installation. You need a trusted executable artifact, its checksum, and a host that supports the artifact’s protocol.

The official provider ID is github.com/stokaro/ptah-spanner-plugin. Its designated repository is stokaro/ptah-spanner-plugin. The catalog recognizes spanner, cloudspanner, google-spanner, and google_spanner as engine names.

Official Spanner executable artifacts remain under development in issue #4204. The catalog reserves this identity. Its repository publishes no release with ptah-provider.json, so ptah providers install spanner refuses with provider_no_release.

This provider is optional. Select it explicitly for Spanner work. A PostgreSQL URL does not select Spanner, and a failed provider never falls back to PostgreSQL.

List the catalog without executing providers:

Terminal window
ptah providers list --json

The Spanner entry reports its provider ID, repository and setup link. An empty installations array means this invocation selected no manifest.

When you have a compatible Spanner artifact, verify its publisher and checksum before authorizing it. Create an explicit manifest using the executable-provider procedure. Set provider_id to github.com/stokaro/ptah-spanner-plugin and declare the canonical engine spanner. Copy the artifact’s actual aliases into engines[].aliases.

Given the reviewed manifest at providers.json, run:

Terminal window
ptah providers check --provider-config providers.json \
--provider-engine spanner --json

A successful check reports "status": "compatible". Read the verification contract before treating that result as database capability evidence.

With no configured installation, an explicit selection reports provider_missing, engine ID spanner, and this setup page. A disabled entry reports provider_disabled. Missing executable bytes, checksum mismatches, startup failures, and incompatible protocols have distinct codes.

Use the failure reference to correct the reported installation state, then repeat the check above.

Pass --provider-config providers.json --provider-engine spanner to supported native schema commands. This explicitly requires the executable provider; an absent or failed installation cannot select an embedded implementation.

The native provider workflow describes inspection, saved plans, application, and its protocol limitations. The catalog does not add provider selection to Atlas-compatible commands or the language server.