Method: projects.instances.databases.getDdl

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API.

HTTP request


GET https://spanner.googleapis.com/v1/{database=projects/*/instances/*/databases/*}/ddl

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
database

string

Required. The database whose schema we wish to get. Values are of the form projects/<project>/instances/<instance>/databases/<database>

Authorization requires the following IAM permission on the specified resource database:

  • spanner.databases.getDdl

Request body

The request body must be empty.

Response body

The response for databases.getDdl.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "statements": [
    string
  ],
  "protoDescriptors": string
}
Fields
statements[]

string

A list of formatted DDL statements defining the schema of the database specified in the request.
protoDescriptors

string (bytes format)

Proto descriptors stored in the database. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. For more details, see protobuffer self description.

A base64-encoded string.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/spanner.admin
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.