1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-16 20:36:39 +00:00
gcloud-help/gcloud/beta/data-catalog/entries/update

161 lines
5.8 KiB
Text
Raw Normal View History

2022-03-01 04:29:52 +00:00
NAME
gcloud beta data-catalog entries update - update a Data Catalog entry
SYNOPSIS
gcloud beta 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,...]
2024-07-31 09:35:16 +00:00
| --schema-from-file=PATH_TO_FILE] [GCLOUD_WIDE_FLAG ...]
2022-03-01 04:29:52 +00:00
DESCRIPTION
2025-03-05 10:41:25 +00:00
(BETA) (DEPRECATED) This command is deprecated. Please use gcloud dataplex
entries instead.
Update a Data Catalog entry. The entry to update can either be specified
directly, or the --lookup-entry flag may be used to update the entry
corresponding to the lookup of the given resource.
2022-03-01 04:29:52 +00:00
EXAMPLES
To update the schema of a Cloud Pub/Sub entry inline, run:
2022-03-01 21:43:54 +00:00
$ gcloud beta data-catalog entries update entry1 --location=global \
--entry-group=@pubsub --schema="column1=type1,column2=type2"
2022-03-01 04:29:52 +00:00
To update the schema of a Cloud Pub/Sub entry from a file, run:
2022-03-01 21:43:54 +00:00
$ gcloud beta data-catalog entries update entry1 --location=global \
--entry-group=@pubsub --schema-from-file="/tmp/schema.json"
2022-03-01 04:29:52 +00:00
To lookup the entry of a Cloud Pub/Sub topic by its SQL name and update its
schema in one command, run:
$ gcloud beta data-catalog entries update \
--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
to specify the attributes of this resource. (NOTE) Some attributes are not
2023-05-04 10:43:54 +00:00
given arguments in this group but can be set in other ways.
To set the project attribute:
2022-03-01 04:29:52 +00:00
◆ provide the argument entry on the command line with a fully specified
name;
2024-07-31 09:35:16 +00:00
◆ provide the argument --project on the command line;
◆ set the property core/project.
2022-03-01 04:29:52 +00:00
ENTRY
2023-05-04 10:43:54 +00:00
ID of the entry or fully qualified identifier for the entry.
To set the entry attribute:
2022-03-01 04:29:52 +00:00
▸ provide the argument entry on the command line.
2022-08-10 08:48:58 +00:00
This positional argument must be specified if any of the other
arguments in this group are specified.
2022-03-01 04:29:52 +00:00
--entry-group=ENTRY_GROUP
Entry group of the entry.
To set the entry-group attribute:
▸ provide the argument entry on the command line with a fully
specified name;
▸ provide the argument --entry-group on the command line.
--location=LOCATION
Location of the entry.
To set the location attribute:
▸ provide the argument entry on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
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 the Google Cloud Platform resource name or the SQL name of a
Google Cloud Platform resource. This flag allows one to update the
entry corresponding to the lookup of 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
names along with their types, descriptions, modes, and nested subcolumns.
For example:
- column: first_name
description: First name
mode: REQUIRED
type: STRING
- column: last_name
description: Last name
mode: REQUIRED
type: STRING
- column: addresses
description: Addresses
mode: REPEATED
type: RECORD
subcolumns:
- column: city
description: City
mode: NULLABLE
type: STRING
- column: state
description: State
mode: NULLABLE
type: STRING
2023-05-04 10:43:54 +00:00
At most one of these can be specified:
2022-03-01 04:29:52 +00:00
2023-05-04 10:43:54 +00:00
--schema=[COLUMN_NAME=COLUMN_TYPE,...]
Inline schema for the entry. When specifying a schema via this
argument, only column names and types should be provided. Column
modes will default to NULLABLE, and column descriptions and nested
subcolumns are not supported.
2022-03-01 04:29:52 +00:00
2024-07-31 09:35:16 +00:00
--schema-from-file=PATH_TO_FILE
2023-05-04 10:43:54 +00:00
Path to a JSON or YAML file containing the schema for the entry. This
can be used to specify schemas with column descriptions, column modes
2024-07-31 09:35:16 +00:00
other than NULLABLE, and nested subcolumns. Use a full or relative
path to a local file containing the value of schema.
2022-03-01 04:29:52 +00:00
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.
API REFERENCE
This command uses the datacatalog/v1beta1 API. The full documentation for
this API can be found at: https://cloud.google.com/data-catalog/docs/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud data-catalog entries update
$ gcloud alpha data-catalog entries update