- NAME
-
- gcloud database-migration objects lookup - lookup a DMS migration job object
- SYNOPSIS
-
-
gcloud database-migration objects lookup(--database=DATABASE--schema=SCHEMA--table=TABLE) (--migration-job=MIGRATION_JOB:--region=REGION) [--endpoint-mode=ENDPOINT_MODE] [--type=TYPE] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Lookup a migration job object by its source object identifier (e.g. database)
- EXAMPLES
-
To lookup an existing migration job object:
gcloud database-migration objects lookup --migration-job=my-job --location=us-central1 --database=my-database - REQUIRED FLAGS
-
-
The source object identifier.
At least one of these must be specified:
--database=DATABASE- The name of the database to lookup.
--schema=SCHEMA- The name of the schema to lookup.
--table=TABLE- The name of the table to lookup.
-
Migration job resource - The migration job to list migration job objects. The
arguments in this group can be used to specify the attributes of this resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
To set the
projectattribute:-
provide the argument
--migration-jobon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
--migration-job=MIGRATION_JOB-
ID of the migration_job or fully qualified identifier for the migration_job.
To set the
migration_jobattribute:-
provide the argument
--migration-jobon the command line.
This flag argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--region=REGION-
The Cloud region for the migration_job.
To set the
regionattribute:-
provide the argument
--migration-jobon the command line with a fully specified name; -
provide the argument
--regionon the command line.
-
provide the argument
-
provide the argument
-
The source object identifier.
- OPTIONAL FLAGS
-
--endpoint-mode=ENDPOINT_MODE-
Specifies endpoint mode for a given command. Regional endpoints provide enhanced
data residency and reliability by ensuring your request is handled entirely
within the specified Google Cloud region. This differs from global endpoints,
which may process parts of the request outside the target region. Overrides the
default
regional/endpoint_modeproperty value for this command invocation.ENDPOINT_MODEmust be one of:global- (Default) Use global rather than regional endpoints.
regional- Only use regional endpoints. An error will be raised if a regional endpoint is not available for a given command.
regional-preferred- Use regional endpoints when available, otherwise use global endpoints. Recommended for most users.
--type=TYPE-
The type of the object to lookup. If not provided, the default is DATABASE.
TYPEmust be one of:DATABASE,SCHEMA,TABLE.
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - REGIONAL ENDPOINTS
-
This command supports regional endpoints. To use regional endpoints for this
command, use the
--endpoint-mode=regional-preferredflag. To use regional endpoints by default, run$ gcloud config set regional/endpoint_mode regional-preferred.
gcloud database-migration objects lookup
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 2026-06-23 UTC.