migrate method

Future<Operation> migrate(
  1. MigrateSchemaRequest request,
  2. String name, {
  3. String? $fields,
})

Executes SQL migration steps against the active database schema.

This operation compares submitted migration steps against the schema migration ledger (firebasesql.schema_migrations), executes unapplied DDL, and records applied steps. It does NOT persist the GraphQL schema to the control plane.

request - The metadata request object.

Request parameters:

name - Required. Resource name of the target schema: projects/{project}/locations/{location}/services/{service}/schemas/{schema} Note: Only schemas/main is supported (singleton schema per service). Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/services/\[^/\]+/schemas/\[^/\]+$.

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

Completes with a Operation.

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<Operation> migrate(
  MigrateSchemaRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':migrate';

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