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 URL uses gRPC Transcoding syntax.

Path parameters

Parameters
database

string

Required. The database whose schema we wish to get.

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

  • spanner.databases.getDdl

Request body

The request body must be empty.

Response body

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

The response for databases.getDdl.

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

string

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

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.

Try it!

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Cloud Spanner Documentation