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 theOperations API.

HTTP request


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

The URLs usegRPC Transcoding syntax.

Path parameters

Parameters
database

string

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

Authorization requires the followingIAM permission on the specified resourcedatabase:

  • spanner.databases.getDdl

Request body

The request body must be empty.

Response body

The response fordatabases.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-serializedgoogle.protobuf.FileDescriptorSet. For more details, see protobufferself 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 theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-12 UTC.