gcloud: Thu Jan 18 10:21:20 UTC 2024

gcloud/alpha/spanner/migrate/cleanup

@@ -0,0 +1,70 @@
+NAME
+    gcloud alpha spanner migrate cleanup - cleanup migration resources given a
+        data migration job id
+
+SYNOPSIS
+    gcloud alpha spanner migrate cleanup --job-id=JOB_ID
+        --target-profile=TARGET_PROFILE [--data-shard-ids=DATA_SHARD_IDS]
+        [--dataflow] [--datastream] [--log-level=LOG_LEVEL] [--monitoring]
+        [--pub-sub] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Cleanup migration resources given a data migration job id.
+
+EXAMPLES
+    To cleanup resources for a data migration job, specify the jobId and the
+    boolean flags for the resources that need to be cleaned up. For sharded
+    migrations, specific data shard Ids can also be provided.
+
+        For a all shards of a sharded migration, or a non-sharded migration:
+        $ gcloud alpha spanner migrate cleanup --job-id="XXX" \
+            --target-profile="XXX" --datastream --dataflow --pub-sub \
+            --monitoring
+
+        For a subset of shards of a sharded migration:
+        $ gcloud alpha spanner migrate cleanup --job-id="XXX" \
+            --data-shard-ids="lorem,epsum" --target-profile="XXX" \
+            --datastream --dataflow --pub-sub --monitoring
+
+REQUIRED FLAGS
+     --job-id=JOB_ID
+        The job Id of an existing migration job.
+
+     --target-profile=TARGET_PROFILE
+        Flag for specifying connection profile for target database (e.g.,
+        "dialect=postgresql)".
+
+OPTIONAL FLAGS
+     --data-shard-ids=DATA_SHARD_IDS
+        Relevant to sharded migrations. Optional comma separated list of data
+        shard Ids, if nothing is specified, all shards are cleaned up.
+
+     --dataflow
+        Cleanup dataflow resource(s).
+
+     --datastream
+        Cleanup datastream resource(s).
+
+     --log-level=LOG_LEVEL
+        To configure the log level for the execution (INFO, VERBOSE).
+
+     --monitoring
+        Cleanup monitoring dashboard(s).
+
+     --pub-sub
+        Cleanup pubsub resource(s).
+
+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 help for details.
+
+NOTES
+    This command is currently in alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist.
+

gcloud/alpha/spanner/migrate/data

@@ -4,9 +4,9 @@ NAME
 
 SYNOPSIS
     gcloud alpha spanner migrate data --session=SESSION --source=SOURCE
-        [--dry-run] [--log-level=LOG_LEVEL] [--prefix=PREFIX]
-        [--skip-foreign-keys] [--source-profile=SOURCE_PROFILE]
-        [--target=TARGET] [--target-profile=TARGET_PROFILE]
+        --target-profile=TARGET_PROFILE [--dry-run] [--log-level=LOG_LEVEL]
+        [--prefix=PREFIX] [--skip-foreign-keys]
+        [--source-profile=SOURCE_PROFILE] [--target=TARGET]
         [--write-limit=WRITE_LIMIT] [GCLOUD_WIDE_FLAG ...]
 
 DESCRIPTION
@@ -28,6 +28,10 @@ REQUIRED FLAGS
         Flag for specifying source database (e.g., PostgreSQL, MySQL,
         DynamoDB).
 
+     --target-profile=TARGET_PROFILE
+        Flag for specifying connection profile for target database (e.g.,
+        "dialect=postgresql)".
+
 OPTIONAL FLAGS
      --dry-run
         Flag for generating DDL and schema conversion report without creating a
@@ -50,10 +54,6 @@ OPTIONAL FLAGS
         Specifies the target database, defaults to Spanner (accepted values:
         Spanner) (default "Spanner").
 
-     --target-profile=TARGET_PROFILE
-        Flag for specifying connection profile for target database (e.g.,
-        "dialect=postgresql)".
-
      --write-limit=WRITE_LIMIT
         Number of parallel writers to Cloud Spanner during bulk data migrations
         (default 40).

gcloud/alpha/spanner/migrate/help

@@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS
 COMMANDS
     COMMAND is one of the following:
 
+     cleanup
+        (ALPHA) Cleanup migration resources given a data migration job id.
+
      data
         (ALPHA) Migrate data from a source database to Cloud Spanner given a
         schema.

gcloud/alpha/spanner/migrate/schema

@@ -3,10 +3,10 @@ NAME
         to Cloud Spanner
 
 SYNOPSIS
-    gcloud alpha spanner migrate schema --source=SOURCE [--dry-run]
-        [--log-level=LOG_LEVEL] [--prefix=PREFIX]
-        [--source-profile=SOURCE_PROFILE] [--target=TARGET]
-        [--target-profile=TARGET_PROFILE] [GCLOUD_WIDE_FLAG ...]
+    gcloud alpha spanner migrate schema --source=SOURCE
+        --target-profile=TARGET_PROFILE [--dry-run] [--log-level=LOG_LEVEL]
+        [--prefix=PREFIX] [--source-profile=SOURCE_PROFILE] [--target=TARGET]
+        [GCLOUD_WIDE_FLAG ...]
 
 DESCRIPTION
     (ALPHA) Migrate schema from a source database to Cloud Spanner.
@@ -22,6 +22,10 @@ REQUIRED FLAGS
         Flag for specifying source database (e.g., PostgreSQL, MySQL,
         DynamoDB).
 
+     --target-profile=TARGET_PROFILE
+        Flag for specifying connection profile for target database (e.g.,
+        "dialect=postgresql)".
+
 OPTIONAL FLAGS
      --dry-run
         Flag for generating DDL and schema conversion report without creating a
@@ -41,10 +45,6 @@ OPTIONAL FLAGS
         Specifies the target database, defaults to Spanner (accepted values:
         Spanner) (default "Spanner").
 
-     --target-profile=TARGET_PROFILE
-        Flag for specifying connection profile for target database (e.g.,
-        "dialect=postgresql)".
-
 GCLOUD WIDE FLAGS
     These flags are available to all commands: --access-token-file, --account,
     --billing-project, --configuration, --flags-file, --flatten, --format,

gcloud/alpha/spanner/migrate/schema-and-data

@@ -3,11 +3,11 @@ NAME
         database to Cloud Spanner given a schema
 
 SYNOPSIS
-    gcloud alpha spanner migrate schema-and-data --source=SOURCE [--dry-run]
-        [--log-level=LOG_LEVEL] [--prefix=PREFIX] [--skip-foreign-keys]
+    gcloud alpha spanner migrate schema-and-data --source=SOURCE
+        --target-profile=TARGET_PROFILE [--dry-run] [--log-level=LOG_LEVEL]
+        [--prefix=PREFIX] [--skip-foreign-keys]
         [--source-profile=SOURCE_PROFILE] [--target=TARGET]
-        [--target-profile=TARGET_PROFILE] [--write-limit=WRITE_LIMIT]
-        [GCLOUD_WIDE_FLAG ...]
+        [--write-limit=WRITE_LIMIT] [GCLOUD_WIDE_FLAG ...]
 
 DESCRIPTION
     (ALPHA) Migrate data from a source database to Cloud Spanner given a
@@ -24,6 +24,10 @@ REQUIRED FLAGS
         Flag for specifying source database (e.g., PostgreSQL, MySQL,
         DynamoDB).
 
+     --target-profile=TARGET_PROFILE
+        Flag for specifying connection profile for target database (e.g.,
+        "dialect=postgresql)".
+
 OPTIONAL FLAGS
      --dry-run
         Flag for generating DDL and schema conversion report without creating a
@@ -46,10 +50,6 @@ OPTIONAL FLAGS
         Specifies the target database, defaults to Spanner (accepted values:
         Spanner) (default "Spanner").
 
-     --target-profile=TARGET_PROFILE
-        Flag for specifying connection profile for target database (e.g.,
-        "dialect=postgresql)".
-
      --write-limit=WRITE_LIMIT
         Number of parallel writers to Cloud Spanner during bulk data migrations
         (default 40).