1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-17 22:36:52 +00:00

gcloud: Thu Jan 19 00:56:33 UTC 2023

This commit is contained in:
Automated 2023-01-19 00:56:33 +00:00
parent 348d9760ee
commit 1248f773ec
1462 changed files with 51835 additions and 5402 deletions

View file

@ -78,7 +78,7 @@ FLAGS
--resource-format=RESOURCE_FORMAT
Format of the configuration to export. Available configuration formats
are Kubernetes Resource Model (krm) or Terraform HCL (terraform).
are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform).
Command defaults to "krm". RESOURCE_FORMAT must be one of: krm,
terraform.

View file

@ -5,7 +5,8 @@ NAME
SYNOPSIS
gcloud alpha sql export bak INSTANCE URI
--database=DATABASE,[DATABASE,...], -d DATABASE,[DATABASE,...]
[--async] [GCLOUD_WIDE_FLAG ...]
[--async] [--stripe_count=STRIPE_COUNT] [--[no-]striped]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Export data from a Cloud SQL instance to a Google Cloud Storage
@ -38,6 +39,13 @@ OPTIONAL FLAGS
Return immediately, without waiting for the operation in progress to
complete.
--stripe_count=STRIPE_COUNT
Specifies the number of stripes to use for SQL Server exports.
--[no-]striped
Whether SQL Server export should be striped. Use --striped to enable
and --no-striped to disable.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

View file

@ -4,7 +4,7 @@ NAME
SYNOPSIS
gcloud alpha sql import bak INSTANCE URI --database=DATABASE, -d DATABASE
[--async]
[--async] [--[no-]striped]
[--cert-path=CERT_PATH --pvk-path=PVK_PATH (--prompt-for-pvk-password
| --pvk-password=PVK_PASSWORD)] [GCLOUD_WIDE_FLAG ...]
@ -50,6 +50,10 @@ OPTIONAL FLAGS
Return immediately, without waiting for the operation in progress to
complete.
--[no-]striped
Whether SQL Server import should be striped. Use --striped to enable
and --no-striped to disable.
Encryption info to support importing an encrypted .bak file
--cert-path=CERT_PATH

View file

@ -4,8 +4,10 @@ NAME
SYNOPSIS
gcloud alpha sql instances clone SOURCE DESTINATION
[--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME] [--async]
[--point-in-time=POINT_IN_TIME | --bin-log-file-name=BIN_LOG_FILE_NAME
--bin-log-position=BIN_LOG_POSITION] [GCLOUD_WIDE_FLAG ...]
[--bin-log-file-name=BIN_LOG_FILE_NAME
--bin-log-position=BIN_LOG_POSITION | [--point-in-time=POINT_IN_TIME
: --restore-database-name=RESTORE_DATABASE_NAME]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha sql instances clone creates a clone of a Cloud SQL
@ -22,6 +24,10 @@ DESCRIPTION
the instance to clone. If not specified, the current state of the instance
is cloned.
For SQL Server: The point in time, if specified, defines a past state of
the instance to clone. If not specified, the current state of the instance
is cloned.
EXAMPLES
To clone an instance from its current state (most recent binary log
coordinates):
@ -44,6 +50,11 @@ EXAMPLES
$ gcloud alpha sql instances clone instance-foo instance-bar \
--point-in-time '2012-11-15T16:19:00.094Z'
To clone a SQL Server source instance at a specific point in time:
$ gcloud alpha sql instances clone instance-foo instance-bar \
--point-in-time '2012-11-15T16:19:00.094Z'
To specify the allocated IP range for the private IP target Instance
(reserved for future use):
@ -61,8 +72,8 @@ FLAGS
--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME
The name of the IP range allocated for the destination instance with
private network connectivity. For example:
'google-managed-services-default'. If set, the the destination instance
IP is created in the allocated range represented by this name. Reserved
'google-managed-services-default'. If set, the destination instance IP
is created in the allocated range represented by this name. Reserved
for future use.
--async
@ -71,17 +82,6 @@ FLAGS
At most one of these can be specified:
--point-in-time=POINT_IN_TIME
Represents the state of an instance at any given point in time inside
a transaction log file. For MySQL, the binary log file is used for
transaction logs. For PostgreSQL, the write-ahead log file is used
for transaction logs. To create a transaction log, enable
point-in-time recovery on the source instance. Instance should have
transaction logs accumulated upto the point in time they want to
restore upto. Uses RFC 3339 format in UTC timezone. If specified,
defines a past state of the instance to clone. For example,
'2012-11-15T16:19:00.094Z'.
Binary log coordinates for point-in-time recovery.
--bin-log-file-name=BIN_LOG_FILE_NAME
@ -104,6 +104,26 @@ FLAGS
This flag argument must be specified if any of the other arguments
in this group are specified.
--point-in-time=POINT_IN_TIME
Represents the state of an instance at any given point in time inside
a transaction log file. For MySQL, the binary log file is used for
transaction logs. For PostgreSQL, the write-ahead log file is used
for transaction logs. For SQL Server, the log backup file is used for
such purpose. To create a transaction log, enable point-in-time
recovery on the source instance. Instance should have transaction
logs accumulated up to the point in time they want to restore up to.
Uses RFC 3339 format in UTC timezone. If specified, defines a past
state of the instance to clone. For example,
'2012-11-15T16:19:00.094Z'.
This flag argument must be specified if any of the other arguments in
this group are specified.
--restore-database-name=RESTORE_DATABASE_NAME
The name of the database to be restored for a point-in-time restore.
If set, the destination instance will only restore the specified
database.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

View file

@ -63,7 +63,7 @@ FLAGS
--resource-format=RESOURCE_FORMAT
Format of the configuration to export. Available configuration formats
are Kubernetes Resource Model (krm) or Terraform HCL (terraform).
are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform).
Command defaults to "krm". RESOURCE_FORMAT must be one of: krm,
terraform.

View file

@ -20,8 +20,8 @@ SYNOPSIS
[--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE]
[--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE]
[--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME]
[--enable-bin-log] [--enable-password-policy]
[--enable-point-in-time-recovery]
[--enable-bin-log] [--enable-google-private-path]
[--enable-password-policy] [--enable-point-in-time-recovery]
[--failover-replica-name=FAILOVER_REPLICA_NAME]
[--[no-]insights-config-query-insights-enabled]
[--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE]
@ -46,6 +46,7 @@ SYNOPSIS
[--storage-auto-increase-limit=STORAGE_AUTO_INCREASE_LIMIT]
[--storage-size=STORAGE_SIZE] [--storage-type=STORAGE_TYPE]
[--tier=TIER, -t TIER] [--time-zone=TIME_ZONE]
[--timeout=TIMEOUT; default=3600]
[--disk-encryption-key=DISK_ENCRYPTION_KEY
: --disk-encryption-key-keyring=DISK_ENCRYPTION_KEY_KEYRING
--disk-encryption-key-location=DISK_ENCRYPTION_KEY_LOCATION
@ -116,8 +117,7 @@ FLAGS
--[no-]assign-ip
Assign a public IP address to the instance. This is a public,
externally available IPv4 address that you can use to connect to your
instance when properly authorized. Use --assign-ip to enable a public
IP and --no-assign-ip to disable it. Use --assign-ip to enable and
instance when properly authorized. Use --assign-ip to enable and
--no-assign-ip to disable.
--async
@ -202,9 +202,8 @@ FLAGS
--[no-]deletion-protection
Enable deletion protection on a Cloud SQL instance. Use
--deletion-protection to enable deletion protection on an instance and
--no-deletion-protection to disable it. Use --deletion-protection to
enable and --no-deletion-protection to disable.
--deletion-protection to enable and --no-deletion-protection to
disable.
--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE
Date when the deny maintenance period ends, that is 2021-01-10.
@ -220,6 +219,13 @@ FLAGS
fraction of a second. Must have automatic backups enabled to use. Make
sure storage can support at least 7 days of logs.
--enable-google-private-path
Enable a private path for Google Cloud services. This flag specifies
whether the instance is accessible to internal Google Cloud services
such as BigQuery. This is only applicable to MySQL and PostgreSQL
instances that don't use public IP. Currently, SQL Server isn't
supported.
--enable-password-policy
Enable the password policy, which enforces user password management
with the policies configured for the instance. This flag is only
@ -398,6 +404,12 @@ FLAGS
--time-zone=TIME_ZONE
Set a non-default time zone. Only available for SQL Server instances.
--timeout=TIMEOUT; default=3600
Time to synchronously wait for the operation to complete, after which
the operation continues asynchronously. Ignored if --async flag is
specified. By default, set to 3600s. To wait indefinitely, set to
unlimited.
Key resource - The Cloud KMS (Key Management Service) cryptokey that will
be used to protect the instance. The 'Compute Engine Service Agent'
service account must hold permission 'Cloud KMS CryptoKey

View file

@ -17,8 +17,8 @@ SYNOPSIS
[--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE]
[--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME] [--diff]
[--[no-]enable-bin-log] [--[no-]enable-database-replication]
[--enable-password-policy] [--enable-point-in-time-recovery]
[--follow-gae-app=FOLLOW_GAE_APP]
[--enable-google-private-path] [--enable-password-policy]
[--enable-point-in-time-recovery] [--follow-gae-app=FOLLOW_GAE_APP]
[--[no-]insights-config-query-insights-enabled]
[--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE]
[--insights-config-query-string-length=INSIGHTS_CONFIG_QUERY_STRING_LENGTH]
@ -81,8 +81,7 @@ FLAGS
--[no-]assign-ip
Assign a public IP address to the instance. This is a public,
externally available IPv4 address that you can use to connect to your
instance when properly authorized. Use --assign-ip to enable a public
IP and --no-assign-ip to disable it. Use --assign-ip to enable and
instance when properly authorized. Use --assign-ip to enable and
--no-assign-ip to disable.
--async
@ -143,9 +142,8 @@ FLAGS
--[no-]deletion-protection
Enable deletion protection on a Cloud SQL instance. Use
--deletion-protection to enable deletion protection on an instance and
--no-deletion-protection to disable it. Use --deletion-protection to
enable and --no-deletion-protection to disable.
--deletion-protection to enable and --no-deletion-protection to
disable.
--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE
Date when the deny maintenance period ends, that is 2021-01-10.
@ -171,6 +169,13 @@ FLAGS
--enable-database-replication to enable and
--no-enable-database-replication to disable.
--enable-google-private-path
Enable a private path for Google Cloud services. This flag specifies
whether the instance is accessible to internal Google Cloud services
such as BigQuery. This is only applicable to MySQL and PostgreSQL
instances that don't use public IP. Currently, SQL Server isn't
supported.
--enable-password-policy
Enable the password policy, which enforces user password management
with the policies configured for the instance. This flag is only

View file

@ -0,0 +1,50 @@
NAME
gcloud alpha sql users describe - retrieves information about a Cloud SQL
user in a given instance
SYNOPSIS
gcloud alpha sql users describe USERNAME --instance=INSTANCE, -i INSTANCE
[--host=HOST] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Retrieves information about a Cloud SQL user in a given instance.
EXAMPLES
To fetch a user with name 'my-user' and optional host '%' in instance
'my-instance', run:
$ gcloud alpha sql users describe my-user --host=% \
--instance=my-instance
POSITIONAL ARGUMENTS
USERNAME
Cloud SQL username.
REQUIRED FLAGS
--instance=INSTANCE, -i INSTANCE
Cloud SQL instance ID.
OPTIONAL FLAGS
--host=HOST
Cloud SQL user's host name expressed as a specific IP address or
address range. % denotes an unrestricted host name. Applicable flag for
MySQL instances; ignored for all other engines. Note, if you connect to
your instance using IP addresses, you must add your client IP address
as an Authorized Address, even if your host name is unrestricted. For
help on how to do so, read:
https://cloud.google.com/sql/docs/mysql/configure-ip
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.

View file

@ -22,6 +22,10 @@ COMMANDS
delete
(ALPHA) Deletes a Cloud SQL user in a given instance.
describe
(ALPHA) Retrieves information about a Cloud SQL user in a given
instance.
list
(ALPHA) Lists Cloud SQL users in a given instance.