getDdl method

Future<GetDatabaseDdlResponse> getDdl(
  1. String database, {
  2. String? $fields,
})

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.

Request parameters:

database - Required. The database whose schema we wish to get. Values are of the form projects//instances//databases/ Value must have pattern ^projects/\[^/\]+/instances/\[^/\]+/databases/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GetDatabaseDdlResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GetDatabaseDdlResponse> getDdl(
  core.String database, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$database') + '/ddl';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GetDatabaseDdlResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}