mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-18 06:47:12 +00:00
gcloud: Thu Apr 20 10:38:56 UTC 2023
This commit is contained in:
parent
b155beb241
commit
b33a8a3e6e
169 changed files with 3258 additions and 576 deletions
54
gcloud/beta/firestore/databases/describe
Normal file
54
gcloud/beta/firestore/databases/describe
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
NAME
|
||||
gcloud beta firestore databases describe - describe a Google Cloud
|
||||
Firestore database
|
||||
|
||||
SYNOPSIS
|
||||
gcloud beta firestore databases describe [--database=DATABASE]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(BETA) Describe a Google Cloud Firestore database.
|
||||
|
||||
EXAMPLES
|
||||
The following command describes a Google Cloud Firestore database.
|
||||
|
||||
$ gcloud beta firestore databases describe
|
||||
|
||||
FLAGS
|
||||
Database resource - The Google Cloud Firestore database to describe. 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 --database on the command line with a fully
|
||||
specified name;
|
||||
◆ the default value of argument [--database] is (default) with a fully
|
||||
specified name;
|
||||
◆ set the property core/project;
|
||||
◆ provide the argument --project on the command line.
|
||||
|
||||
--database=DATABASE
|
||||
ID of the database or fully qualified identifier for the database. To
|
||||
set the database attribute:
|
||||
▸ provide the argument --database on the command line;
|
||||
▸ the default value of argument [--database] is (default).
|
||||
|
||||
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 firestore/v1 API. The full documentation for this API
|
||||
can be found at: https://cloud.google.com/firestore
|
||||
|
||||
NOTES
|
||||
This command is currently in beta and might change without notice. These
|
||||
variants are also available:
|
||||
|
||||
$ gcloud firestore databases describe
|
||||
|
||||
$ gcloud alpha firestore databases describe
|
||||
|
||||
|
|
@ -19,6 +19,15 @@ COMMANDS
|
|||
create
|
||||
(BETA) Create a Google Cloud Firestore database via Firestore API.
|
||||
|
||||
describe
|
||||
(BETA) Describe a Google Cloud Firestore database.
|
||||
|
||||
list
|
||||
(BETA) Lists all Firestore databases under the project.
|
||||
|
||||
update
|
||||
(BETA) Update the database configuration of a Cloud Firestore database.
|
||||
|
||||
NOTES
|
||||
This command is currently in beta and might change without notice. These
|
||||
variants are also available:
|
||||
|
|
|
|||
62
gcloud/beta/firestore/databases/list
Normal file
62
gcloud/beta/firestore/databases/list
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
NAME
|
||||
gcloud beta firestore databases list - lists all Firestore databases under
|
||||
the project
|
||||
|
||||
SYNOPSIS
|
||||
gcloud beta firestore databases list [--filter=EXPRESSION] [--limit=LIMIT]
|
||||
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
EXAMPLES
|
||||
To list all Firestore databases.
|
||||
|
||||
$ gcloud beta firestore databases list
|
||||
|
||||
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 beta and might change without notice. These
|
||||
variants are also available:
|
||||
|
||||
$ gcloud firestore databases list
|
||||
|
||||
$ gcloud alpha firestore databases list
|
||||
|
||||
62
gcloud/beta/firestore/databases/update
Normal file
62
gcloud/beta/firestore/databases/update
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
NAME
|
||||
gcloud beta firestore databases update - update the database configuration
|
||||
of a Cloud Firestore database
|
||||
|
||||
SYNOPSIS
|
||||
gcloud beta firestore databases update [--async] [--database=DATABASE]
|
||||
[--type=TYPE] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(BETA) Update the database configuration of a Cloud Firestore database.
|
||||
|
||||
EXAMPLES
|
||||
The following command updates the database type of a Cloud Firestore
|
||||
database.
|
||||
|
||||
$ gcloud beta firestore databases update --type=firestore-native
|
||||
|
||||
FLAGS
|
||||
--async
|
||||
Return immediately, without waiting for the operation in progress to
|
||||
complete.
|
||||
|
||||
Database resource - Cloud Firestore database to update. 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 --database on the command line with a fully
|
||||
specified name;
|
||||
◆ the default value of argument [--database] is (default) with a fully
|
||||
specified name;
|
||||
◆ set the property core/project;
|
||||
◆ provide the argument --project on the command line.
|
||||
|
||||
--database=DATABASE
|
||||
ID of the database or fully qualified identifier for the database. To
|
||||
set the database attribute:
|
||||
▸ provide the argument --database on the command line;
|
||||
▸ the default value of argument [--database] is (default).
|
||||
|
||||
--type=TYPE
|
||||
The database type. TYPE must be one of: datastore-mode,
|
||||
firestore-native.
|
||||
|
||||
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 firestore/v1 API. The full documentation for this API
|
||||
can be found at: https://cloud.google.com/firestore
|
||||
|
||||
NOTES
|
||||
This command is currently in beta and might change without notice. These
|
||||
variants are also available:
|
||||
|
||||
$ gcloud firestore databases update
|
||||
|
||||
$ gcloud alpha firestore databases update
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue