gcloud: Wed Apr 16 10:41:40 UTC 2025

gcloud/alpha/bigtable/help

@@ -36,6 +36,9 @@ GROUPS
      logical-views
         (ALPHA) Manage Bigtable logical views.
 
+     materialized-views
+        (ALPHA) Manage Bigtable materialized views.
+
      operations
         (ALPHA) Manage Cloud Bigtable operations.
 

gcloud/alpha/bigtable/instances/tables/create

@@ -6,7 +6,9 @@ SYNOPSIS
     gcloud alpha bigtable instances tables create (TABLE : --instance=INSTANCE)
         --column-families=[COLUMN_FAMILIES,...]
         [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD]
-        [--deletion-protection] [--splits=[SPLITS,...]]
+        [--deletion-protection]
+        [--row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE]
+        [--row-key-schema-pre-encoded-bytes] [--splits=[SPLITS,...]]
         [--automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD
           | --enable-automated-backup] [GCLOUD_WIDE_FLAG ...]
 
@@ -125,6 +127,34 @@ OPTIONAL FLAGS
      --deletion-protection
         Once specified, the table is deletion protected.
 
+     --row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE
+        The row key schema for the table. The schema is defined in a YAML or
+        JSON file, equivalent to the StructType protobuf message.
+
+        Example YAML:
+
+            encoding:
+              delimitedBytes:
+                delimiter: '#'
+            fields:
+            - fieldName: field1
+              type:
+                bytesType:
+                  encoding:
+                    raw: {}
+            - fieldName: field2
+              type:
+                bytesType:
+                  encoding:
+                    raw: {}
+
+     --row-key-schema-pre-encoded-bytes
+        By default, Base64 encoding is applied to all binary fields in the
+        YAML/JSON file (for example, encoding.delimitedBytes.delimiter).
+
+        Use this to indicate that all binary fields are already encoded in the
+        YAML/JSON file and should not be encoded again.
+
      --splits=[SPLITS,...]
         Row keys where the table should initially be split. For example:
         car,key

gcloud/alpha/bigtable/instances/tables/update

@@ -4,11 +4,14 @@ NAME
 
 SYNOPSIS
     gcloud alpha bigtable instances tables update (TABLE : --instance=INSTANCE)
-        [--async] [--deletion-protection]
+        [--async] [--deletion-protection] [--row-key-schema-pre-encoded-bytes]
         [--automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD
           | --disable-automated-backup | --enable-automated-backup]
         [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD
-          | --clear-change-stream-retention-period] [GCLOUD_WIDE_FLAG ...]
+          | --clear-change-stream-retention-period]
+        [--clear-row-key-schema
+          | --row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE]
+        [GCLOUD_WIDE_FLAG ...]
 
 DESCRIPTION
     (ALPHA) Update an existing new Cloud Bigtable table with the specified
@@ -92,6 +95,16 @@ FLAGS
      --deletion-protection
         Once specified, the table is deletion protected.
 
+     --row-key-schema-pre-encoded-bytes
+        By default, Base64 encoding is applied to all binary fields in the
+        YAML/JSON file (for example, encoding.delimitedBytes.delimiter).
+
+        Use this to indicate that all binary fields are already encoded in the
+        YAML/JSON file and should not be encoded again.
+
+        This field is only used when row-key-schema-definition-file is set. It
+        is ignored if clear-row-key-schema is set.
+
      At most one of these can be specified:
 
        --automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD
@@ -120,6 +133,35 @@ FLAGS
           This disables the change stream and eventually removes the change
           stream data.
 
+     Whether to update or clear the row key schema in the updated table. Only
+     one of these flags can be set.
+
+     At most one of these can be specified:
+
+       --clear-row-key-schema
+          Whether to clear the row key schema in the updated table.
+
+       --row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE
+          The row key schema for the table. The schema is defined in a YAML or
+          JSON file, equivalent to the StructType protobuf message.
+
+          Example YAML:
+
+              encoding:
+                delimitedBytes:
+                  delimiter: '#'
+              fields:
+              - fieldName: field1
+                type:
+                  bytesType:
+                    encoding:
+                      raw: {}
+              - fieldName: field2
+                type:
+                  bytesType:
+                    encoding:
+                      raw: {}
+
 GCLOUD WIDE FLAGS
     These flags are available to all commands: --access-token-file, --account,
     --billing-project, --configuration, --flags-file, --flatten, --format,

gcloud/alpha/bigtable/materialized-views/create

@@ -0,0 +1,80 @@
+NAME
+    gcloud alpha bigtable materialized-views create - create a new Bigtable
+        materialized view
+
+SYNOPSIS
+    gcloud alpha bigtable materialized-views create
+        (MATERIALIZED_VIEW : --instance=INSTANCE) --query=QUERY [--async]
+        [--deletion-protection=DELETION_PROTECTION] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Create a new Bigtable materialized view.
+
+EXAMPLES
+    To create a materialized view, run:        $ gcloud alpha bigtable materialized-views create \
+            my-materialized-view-id --instance=my-instance-id \
+            --query="SELECT my-column-family FROM my-table \
+        --deletion-protection=false"
+
+POSITIONAL ARGUMENTS
+     Materialized view resource - The materialized view to create. 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 project attribute:
+      ◆ provide the argument materialized_view on the command line with a
+        fully specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       MATERIALIZED_VIEW
+          ID of the materialized view or fully qualified identifier for the
+          materialized view.
+
+          To set the name attribute:
+          ▸ provide the argument materialized_view on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --instance=INSTANCE
+          Bigtable instance for the materialized view.
+
+          To set the instance attribute:
+          ▸ provide the argument materialized_view on the command line with a
+            fully specified name;
+          ▸ provide the argument --instance on the command line.
+
+REQUIRED FLAGS
+     --query=QUERY
+        The query of the view.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+     --deletion-protection=DELETION_PROTECTION
+        Whether the view is protected from deletion.
+
+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. These variants are also available:
+
+        $ gcloud bigtable materialized-views create
+
+        $ gcloud beta bigtable materialized-views create
+

gcloud/alpha/bigtable/materialized-views/delete

@@ -0,0 +1,67 @@
+NAME
+    gcloud alpha bigtable materialized-views delete - delete a Bigtable
+        materialized view
+
+SYNOPSIS
+    gcloud alpha bigtable materialized-views delete
+        (MATERIALIZED_VIEW : --instance=INSTANCE) [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Delete a Bigtable materialized view.
+
+EXAMPLES
+    To delete a materialized view, run:
+
+        $ gcloud alpha bigtable materialized-views delete \
+            my-materialized-view-id --instance=my-instance-id
+
+POSITIONAL ARGUMENTS
+     Materialized view resource - The materialized view to delete. 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 project attribute:
+      ◆ provide the argument materialized_view on the command line with a
+        fully specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       MATERIALIZED_VIEW
+          ID of the materialized view or fully qualified identifier for the
+          materialized view.
+
+          To set the name attribute:
+          ▸ provide the argument materialized_view on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --instance=INSTANCE
+          Bigtable instance for the materialized view.
+
+          To set the instance attribute:
+          ▸ provide the argument materialized_view on the command line with a
+            fully specified name;
+          ▸ provide the argument --instance on the command line.
+
+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. These variants are also available:
+
+        $ gcloud bigtable materialized-views delete
+
+        $ gcloud beta bigtable materialized-views delete
+

gcloud/alpha/bigtable/materialized-views/describe

@@ -0,0 +1,67 @@
+NAME
+    gcloud alpha bigtable materialized-views describe - describe an existing
+        Bigtable materialized view
+
+SYNOPSIS
+    gcloud alpha bigtable materialized-views describe
+        (MATERIALIZED_VIEW : --instance=INSTANCE) [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Describe an existing Bigtable materialized view.
+
+EXAMPLES
+    To view a materialized view's description, run:
+
+        $ gcloud alpha bigtable materialized-views describe \
+            my-materialized-view-id --instance=my-instance-id
+
+POSITIONAL ARGUMENTS
+     Materialized view resource - The materialized view to describe. 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 project attribute:
+      ◆ provide the argument materialized_view on the command line with a
+        fully specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       MATERIALIZED_VIEW
+          ID of the materialized view or fully qualified identifier for the
+          materialized view.
+
+          To set the name attribute:
+          ▸ provide the argument materialized_view on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --instance=INSTANCE
+          Bigtable instance for the materialized view.
+
+          To set the instance attribute:
+          ▸ provide the argument materialized_view on the command line with a
+            fully specified name;
+          ▸ provide the argument --instance on the command line.
+
+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. These variants are also available:
+
+        $ gcloud bigtable materialized-views describe
+
+        $ gcloud beta bigtable materialized-views describe
+

gcloud/alpha/bigtable/materialized-views/help

@@ -0,0 +1,43 @@
+NAME
+    gcloud alpha bigtable materialized-views - manage Bigtable materialized
+        views
+
+SYNOPSIS
+    gcloud alpha bigtable materialized-views COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Manage Bigtable materialized views.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     create
+        (ALPHA) Create a new Bigtable materialized view.
+
+     delete
+        (ALPHA) Delete a Bigtable materialized view.
+
+     describe
+        (ALPHA) Describe an existing Bigtable materialized view.
+
+     list
+        (ALPHA) List existing Bigtable materialized views.
+
+     update
+        (ALPHA) Update a Bigtable materialized view.
+
+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. These variants are also available:
+
+        $ gcloud bigtable materialized-views
+
+        $ gcloud beta bigtable materialized-views
+

gcloud/alpha/bigtable/materialized-views/list

@@ -0,0 +1,87 @@
+NAME
+    gcloud alpha bigtable materialized-views list - list existing Bigtable
+        materialized views
+
+SYNOPSIS
+    gcloud alpha bigtable materialized-views list --instance=INSTANCE
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) List existing Bigtable materialized views.
+
+EXAMPLES
+    To list all materialized views for an instance, run:
+
+        $ gcloud alpha bigtable materialized-views list \
+            --instance=my-instance-id
+
+REQUIRED FLAGS
+     Instance resource - The instance to list materialized views for. This
+     represents a Cloud resource. (NOTE) Some attributes are not given
+     arguments in this group but can be set in other ways.
+
+     To set the project attribute:
+      ◆ provide the argument --instance on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       --instance=INSTANCE
+          ID of the instance or fully qualified identifier for the instance.
+
+          To set the instance attribute:
+          ▸ provide the argument --instance on the command line.
+
+LIST COMMAND FLAGS
+     --filter=EXPRESSION
+        Apply a Boolean filter EXPRESSION to each resource item to be listed.
+        If the expression evaluates True, then that item is listed. For more
+        details and examples of filter expressions, run $ gcloud topic filters.
+        This flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --limit=LIMIT
+        Maximum number of resources to list. The default is unlimited. This
+        flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --page-size=PAGE_SIZE
+        Some services group resource list output into pages. This flag
+        specifies the maximum number of resources per page. The default is
+        determined by the service if it supports paging, otherwise it is
+        unlimited (no paging). Paging may be applied before or after --filter
+        and --limit depending on the service.
+
+     --sort-by=[FIELD,...]
+        Comma-separated list of resource field key names to sort by. The
+        default order is ascending. Prefix a field with ``~'' for descending
+        order on that field. This flag interacts with other flags that are
+        applied in this order: --flatten, --sort-by, --filter, --limit.
+
+     --uri
+        Print a list of resource URIs instead of the default output, and change
+        the command output to a list of URIs. If this flag is used with
+        --format, the formatting is applied on this URI list. To display URIs
+        alongside other keys instead, use the uri() transform.
+
+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. These variants are also available:
+
+        $ gcloud bigtable materialized-views list
+
+        $ gcloud beta bigtable materialized-views list
+

gcloud/alpha/bigtable/materialized-views/update

@@ -0,0 +1,77 @@
+NAME
+    gcloud alpha bigtable materialized-views update - update a Bigtable
+        materialized view
+
+SYNOPSIS
+    gcloud alpha bigtable materialized-views update
+        (MATERIALIZED_VIEW : --instance=INSTANCE)
+        --deletion-protection=DELETION_PROTECTION [--async]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Update a Bigtable materialized view.
+
+EXAMPLES
+    To update a materialized view, run:        $ gcloud alpha bigtable materialized-views update \
+            my-materialized-view-id --instance=my-instance-id \
+            --deletion-protection=true"
+
+POSITIONAL ARGUMENTS
+     Materialized view resource - The materialized view to update. 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 project attribute:
+      ◆ provide the argument materialized_view on the command line with a
+        fully specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       MATERIALIZED_VIEW
+          ID of the materialized view or fully qualified identifier for the
+          materialized view.
+
+          To set the name attribute:
+          ▸ provide the argument materialized_view on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --instance=INSTANCE
+          Bigtable instance for the materialized view.
+
+          To set the instance attribute:
+          ▸ provide the argument materialized_view on the command line with a
+            fully specified name;
+          ▸ provide the argument --instance on the command line.
+
+REQUIRED FLAGS
+     --deletion-protection=DELETION_PROTECTION
+        Whether the view is protected from deletion.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+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. These variants are also available:
+
+        $ gcloud bigtable materialized-views update
+
+        $ gcloud beta bigtable materialized-views update
+

gcloud/alpha/bigtable/tables/create

@@ -5,7 +5,9 @@ SYNOPSIS
     gcloud alpha bigtable tables create (TABLE : --instance=INSTANCE)
         --column-families=[COLUMN_FAMILIES,...]
         [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD]
-        [--deletion-protection] [--splits=[SPLITS,...]]
+        [--deletion-protection]
+        [--row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE]
+        [--row-key-schema-pre-encoded-bytes] [--splits=[SPLITS,...]]
         [--automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD
           | --enable-automated-backup] [GCLOUD_WIDE_FLAG ...]
 
@@ -124,6 +126,34 @@ OPTIONAL FLAGS
      --deletion-protection
         Once specified, the table is deletion protected.
 
+     --row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE
+        The row key schema for the table. The schema is defined in a YAML or
+        JSON file, equivalent to the StructType protobuf message.
+
+        Example YAML:
+
+            encoding:
+              delimitedBytes:
+                delimiter: '#'
+            fields:
+            - fieldName: field1
+              type:
+                bytesType:
+                  encoding:
+                    raw: {}
+            - fieldName: field2
+              type:
+                bytesType:
+                  encoding:
+                    raw: {}
+
+     --row-key-schema-pre-encoded-bytes
+        By default, Base64 encoding is applied to all binary fields in the
+        YAML/JSON file (for example, encoding.delimitedBytes.delimiter).
+
+        Use this to indicate that all binary fields are already encoded in the
+        YAML/JSON file and should not be encoded again.
+
      --splits=[SPLITS,...]
         Row keys where the table should initially be split. For example:
         car,key

gcloud/alpha/bigtable/tables/update

@@ -4,11 +4,14 @@ NAME
 
 SYNOPSIS
     gcloud alpha bigtable tables update (TABLE : --instance=INSTANCE) [--async]
-        [--deletion-protection]
+        [--deletion-protection] [--row-key-schema-pre-encoded-bytes]
         [--automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD
           | --disable-automated-backup | --enable-automated-backup]
         [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD
-          | --clear-change-stream-retention-period] [GCLOUD_WIDE_FLAG ...]
+          | --clear-change-stream-retention-period]
+        [--clear-row-key-schema
+          | --row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE]
+        [GCLOUD_WIDE_FLAG ...]
 
 DESCRIPTION
     (ALPHA) Update an existing new Cloud Bigtable table with the specified
@@ -92,6 +95,16 @@ FLAGS
      --deletion-protection
         Once specified, the table is deletion protected.
 
+     --row-key-schema-pre-encoded-bytes
+        By default, Base64 encoding is applied to all binary fields in the
+        YAML/JSON file (for example, encoding.delimitedBytes.delimiter).
+
+        Use this to indicate that all binary fields are already encoded in the
+        YAML/JSON file and should not be encoded again.
+
+        This field is only used when row-key-schema-definition-file is set. It
+        is ignored if clear-row-key-schema is set.
+
      At most one of these can be specified:
 
        --automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD
@@ -120,6 +133,35 @@ FLAGS
           This disables the change stream and eventually removes the change
           stream data.
 
+     Whether to update or clear the row key schema in the updated table. Only
+     one of these flags can be set.
+
+     At most one of these can be specified:
+
+       --clear-row-key-schema
+          Whether to clear the row key schema in the updated table.
+
+       --row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE
+          The row key schema for the table. The schema is defined in a YAML or
+          JSON file, equivalent to the StructType protobuf message.
+
+          Example YAML:
+
+              encoding:
+                delimitedBytes:
+                  delimiter: '#'
+              fields:
+              - fieldName: field1
+                type:
+                  bytesType:
+                    encoding:
+                      raw: {}
+              - fieldName: field2
+                type:
+                  bytesType:
+                    encoding:
+                      raw: {}
+
 GCLOUD WIDE FLAGS
     These flags are available to all commands: --access-token-file, --account,
     --billing-project, --configuration, --flags-file, --flatten, --format,