gcloud alpha data-catalog entries update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha data-catalog entries update - update a Data Catalog entry
- SYNOPSIS
gcloud alpha data-catalog entries update[ENTRY:--entry-group=ENTRY_GROUP--location=LOCATION][--description=DESCRIPTION][--display-name=DISPLAY_NAME][--lookup-entry=RESOURCE][--add-file-patterns=[PATTERN,…]--clear-file-patterns|--remove-file-patterns=[PATTERN,…]][--schema=[COLUMN_NAME=COLUMN_TYPE,…] |--schema-from-file=PATH_TO_FILE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)(DEPRECATED)This command is deprecated.Please usegclouddataplex entriesinstead.Update a Data Catalog entry. The entry to update can either be specifieddirectly, or the
--lookup-entryflag may be used to update theentry corresponding to the lookup of the given resource.- EXAMPLES
- To update the schema of a Cloud Pub/Sub entry inline, run:
gcloudalphadata-catalogentriesupdateentry1--location=global--entry-group=@pubsub--schema="column1=type1,column2=type2"To update the schema of a Cloud Pub/Sub entry from a file, run:
gcloudalphadata-catalogentriesupdateentry1--location=global--entry-group=@pubsub--schema-from-file="/tmp/schema.json"To lookup the entry of a Cloud Pub/Sub topic by its SQL name and update itsschema in one command, run:
gcloudalphadata-catalogentriesupdate--lookup-entry='pubsub.topic.`my-project1`.topic1'--schema="column1=type1,column2=type2" - POSITIONAL ARGUMENTS
- Entry resource - Entry to update. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
entryon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
- provide the argument
ENTRY- ID of the entry or fully qualified identifier for the entry.
To set the
entryattribute:- provide the argument
entryon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--entry-group=ENTRY_GROUP- Entry group of the entry.To set the
entry-groupattribute:- provide the argument
entryon the command line with a fullyspecified name; - provide the argument
--entry-groupon the command line.
- provide the argument
--location=LOCATION- Location of the entry.To set the
locationattribute:- provide the argument
entryon the command line with a fullyspecified name; - provide the argument
--locationon the command line.
- provide the argument
- Entry resource - Entry to update. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
- FLAGS
--description=DESCRIPTION- Textual description of the entry.
--display-name=DISPLAY_NAME- Human-readable name for the entry.
--lookup-entry=RESOURCE- The name of the target resource whose entry to update. This can be either theGoogle Cloud Platform resource name or the SQL name of a Google Cloud Platformresource. This flag allows one to update the entry corresponding to the lookupof the given resource, without needing to specify the entry directly.
--add-file-patterns=[PATTERN,…]- A list of file patterns to add to the current list.
- At most one of these can be specified:
--clear-file-patterns- If specified, clear the current list of file patterns.
--remove-file-patterns=[PATTERN,…]- A list of file patterns to remove from the current list.
- New column schema for the entry. A schema consists of a list of column namesalong with their types, descriptions, modes, and nested subcolumns. For example:
At most one of these can be specified:-column:first_namedescription:Firstnamemode:REQUIREDtype:STRING-column:last_namedescription:Lastnamemode:REQUIREDtype:STRING-column:addressesdescription:Addressesmode:REPEATEDtype:RECORDsubcolumns:-column:citydescription:Citymode:NULLABLEtype:STRING-column:statedescription:Statemode:NULLABLEtype:STRING
--schema=[COLUMN_NAME=COLUMN_TYPE,…]- Inline schema for the entry. When specifying a schema via this argument, onlycolumn names and types should be provided. Column modes will default toNULLABLE, and column descriptions and nested subcolumns are not supported.
--schema-from-file=PATH_TO_FILE- Path to a JSON or YAML file containing the schema for the entry. This can beused to specify schemas with column descriptions, column modes other thanNULLABLE, and nested subcolumns. Use a full or relative path to a local filecontaining the value of schema.
- 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. - API REFERENCE
- This command uses the
datacatalog/v1beta1API. The fulldocumentation for this API can be found at:https://cloud.google.com/data-catalog/docs/ - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gclouddata-catalogentriesupdategcloudbetadata-catalogentriesupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-21 UTC.