Method: googleapis.spanner.v1.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.

For more information about retries and long-running operations, see Understand connectors.

Arguments

Parameters
database

string

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

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of GetDatabaseDdlResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- getDdl:
    call: googleapis.spanner.v1.projects.instances.databases.getDdl
    args:
        database: ...
    result: getDdlResult

JSON

[
  {
    "getDdl": {
      "call": "googleapis.spanner.v1.projects.instances.databases.getDdl",
      "args": {
        "database": "..."
      },
      "result": "getDdlResult"
    }
  }
]