Sandbox::https://github.com/googleapis/nodejs-spanner/blob/main/samples/database-get-ddl.js

This repository was archived by the owner on Mar 4, 2026. It is now read-only.

Repository navigation

History

/**

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

* http://www.apache.org/licenses/LICENSE-2.0

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

// sample-metadata:

// title: Gets the schema definition of an existing database

// usage: node database-get-ddl.js <INSTANCE_ID> <DATABASE_ID> <PROJECT_ID>

'use strict';

function main(instanceId, databaseId, projectId) {

// [START spanner_get_database_ddl]

/**

* TODO(developer): Uncomment the following lines before running the sample.

// const projectId = 'my-project-id';

// const instanceId = 'my-instance-id';

// const databaseId = 'my-database-id';

// Imports the Google Cloud client library

const {Spanner} = require('@google-cloud/spanner');

// creates a client

const spanner = new Spanner({

projectId: projectId,

});

const databaseAdminClient = spanner.getDatabaseAdminClient();

async function getDatabaseDdl() {

// Get the schema definition of the database.

const [ddlStatements] = await databaseAdminClient.getDatabaseDdl({

database: databaseAdminClient.databasePath(

projectId,

instanceId,

databaseId,

});

console.log(

`Retrieved database DDL for ${databaseAdminClient.databasePath(

projectId,

instanceId,

databaseId,

)}:`,

);

ddlStatements.statements.forEach(element => {

console.log(element);

});

}

getDatabaseDdl();

// [END spanner_get_database_ddl]

}

process.on('unhandledRejection', err => {

console.error(err.message);

process.exitCode = 1;

});

main(...process.argv.slice(2));

FilesExpand file tree

database-get-ddl.js

Latest commit

History

database-get-ddl.js

File metadata and controls