Send feedback
Method: projects.instances.databases.getDdl
Stay organized with collections
Save and categorize content based on your preferences.
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. Values are of the form projects/<project>/instances/<instance>/databases/<database>
Authorization requires the following IAM permission on the specified resource database
:
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
]
}
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 .
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-23 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?