1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-16 12:22:03 +00:00
gcloud-help/gcloud/beta/data-catalog/entries/create

160 lines
5.7 KiB
Text
Raw Normal View History

2022-03-01 04:29:52 +00:00
NAME
gcloud beta data-catalog entries create - create a Data Catalog entry
SYNOPSIS
gcloud beta data-catalog entries create
(ENTRY : --entry-group=ENTRY_GROUP --location=LOCATION)
--gcs-file-patterns=[GCS_FILE_PATTERNS,...] [--description=DESCRIPTION]
[--display-name=DISPLAY_NAME]
[--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.
Create a Data Catalog entry.
2022-03-01 04:29:52 +00:00
EXAMPLES
To create an entry for a Google Cloud Storage fileset, run:
$ gcloud beta data-catalog entries create entry1 \
--location=us-central1 --entry-group=group1 \
--gcs-file-patterns="gs://bucket1/abc/*,gs://bucket1/file1" \
--display-name="analytics data"
To create an entry for a Google Cloud Storage fileset with an inline
schema, run:
$ gcloud beta data-catalog entries create entry1 \
--location=us-central1 --entry-group=group1 \
2022-03-01 21:43:54 +00:00
--gcs-file-patterns="gs://bucket1/*" \
--display-name="sales data" \
2022-03-01 04:29:52 +00:00
--schema="qtr=STRING,sales=FLOAT,year=STRING"
To create an entry for a Google Cloud Storage fileset with a schema from a
file, run:
$ gcloud beta data-catalog entries create entry1 \
--location=us-central1 --entry-group=group1 \
2022-03-01 21:43:54 +00:00
--gcs-file-patterns="gs://bucket1/*" \
--display-name="sales data" --schema-from-file=/tmp/schema.json
2022-03-01 04:29:52 +00:00
POSITIONAL ARGUMENTS
Entry resource - Entry to create. 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
This must be specified.
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.
REQUIRED FLAGS
--gcs-file-patterns=[GCS_FILE_PATTERNS,...]
Patterns to identify a set of files in Google Cloud Storage. A star (*)
may be used at the end of a pattern to match arbitrary files beginning
with that pattern.
Examples of valid file patterns:
◆ gs://bucket_name/* - Matches all files in 'bucket_name'.
◆ gs://bucket_name/file* - Matches files prefixed by 'file' in
'bucket_name'.
◆ gs://another_bucket/a.txt - Matches 'gs://another_bucket/a.txt'.
OPTIONAL FLAGS
--description=DESCRIPTION
Textual description of the entry.
--display-name=DISPLAY_NAME
Human-readable name for the entry.
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 create
$ gcloud alpha data-catalog entries create