1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-12 07:58:28 +00:00

gcloud: Wed May 7 10:56:18 UTC 2025

This commit is contained in:
Automated 2025-05-07 10:56:18 +00:00
parent b03a332ad8
commit dfebca5b6c
222 changed files with 6775 additions and 1046 deletions

View file

@ -11,7 +11,10 @@ SYNOPSIS
--oracle-hostname=ORACLE_HOSTNAME --oracle-port=ORACLE_PORT
--oracle-username=ORACLE_USERNAME (--oracle-password=ORACLE_PASSWORD
| --oracle-prompt-for-password
| --oracle-secret-manager-stored-password=ORACLE_SECRET_MANAGER_STORED_PASSWORD) | [--mysql-hostname=MYSQL_HOSTNAME --mysql-port=MYSQL_PORT --mysql-username=MYSQL_USERNAME (--mysql-password=MYSQL_PASSWORD | --mysql-prompt-for-password | --mysql-secret-manager-stored-password=MYSQL_SECRET_MANAGER_STORED_PASSWORD) : --ca-certificate=CA_CERTIFICATE --client-certificate=CLIENT_CERTIFICATE --client-key=CLIENT_KEY] | [--postgresql-database=POSTGRESQL_DATABASE --postgresql-hostname=POSTGRESQL_HOSTNAME --postgresql-port=POSTGRESQL_PORT --postgresql-username=POSTGRESQL_USERNAME (--postgresql-password=POSTGRESQL_PASSWORD | --postgresql-prompt-for-password | --postgresql-secret-manager-stored-password=POSTGRESQL_SECRET_MANAGER_STORED_PASSWORD) : [--postgresql-ca-certificate=POSTGRESQL_CA_CERTIFICATE : --postgresql-client-certificate=POSTGRESQL_CLIENT_CERTIFICATE --postgresql-client-key=POSTGRESQL_CLIENT_KEY]] | --salesforce-domain=SALESFORCE_DOMAIN (--salesforce-oauth2-client-id=SALESFORCE_OAUTH2_CLIENT_ID (--salesforce-oauth2-client-secret=SALESFORCE_OAUTH2_CLIENT_SECRET | --salesforce-prompt-for-oauth2-client-secret | --salesforce-secret-manager-stored-oauth2-client-secret=SALESFORCE_SECRET_MANAGER_STORED_OAUTH2_CLIENT_SECRET) | --salesforce-username=SALESFORCE_USERNAME (--salesforce-password=SALESFORCE_PASSWORD | --salesforce-prompt-for-password | --salesforce-secret-manager-stored-password=SALESFORCE_SECRET_MANAGER_STORED_PASSWORD) (--salesforce-prompt-for-security-token | --salesforce-secret-manager-stored-security-token=SALESFORCE_SECRET_MANAGER_STORED_SECURITY_TOKEN | --salesforce-security-token=SALESFORCE_SECURITY_TOKEN)) | --sqlserver-database=SQLSERVER_DATABASE --sqlserver-hostname=SQLSERVER_HOSTNAME --sqlserver-port=SQLSERVER_PORT --sqlserver-username=SQLSERVER_USERNAME (--sqlserver-password=SQLSERVER_PASSWORD | --sqlserver-prompt-for-password | --sqlserver-secret-manager-stored-password=SQLSERVER_SECRET_MANAGER_STORED_PASSWORD)]
| --oracle-secret-manager-stored-password=ORACLE_SECRET_MANAGER_STORED_PASSWORD) | [--mongodb-host-addresses=IPv4_ADDRESS_OR_HOSTNAME:PORT,
[...] --mongodb-username=MONGODB_USERNAME
(--mongodb-password=MONGODB_PASSWORD | --mongodb-prompt-for-password
| --mongodb-secret-manager-stored-password=MONGODB_SECRET_MANAGER_STORED_PASSWORD) (--mongodb-srv-connection-format | --mongodb-standard-connection-format) : --mongodb-replica-set=MONGODB_REPLICA_SET] | [--mysql-hostname=MYSQL_HOSTNAME --mysql-port=MYSQL_PORT --mysql-username=MYSQL_USERNAME (--mysql-password=MYSQL_PASSWORD | --mysql-prompt-for-password | --mysql-secret-manager-stored-password=MYSQL_SECRET_MANAGER_STORED_PASSWORD) : --ca-certificate=CA_CERTIFICATE --client-certificate=CLIENT_CERTIFICATE --client-key=CLIENT_KEY] | [--postgresql-database=POSTGRESQL_DATABASE --postgresql-hostname=POSTGRESQL_HOSTNAME --postgresql-port=POSTGRESQL_PORT --postgresql-username=POSTGRESQL_USERNAME (--postgresql-password=POSTGRESQL_PASSWORD | --postgresql-prompt-for-password | --postgresql-secret-manager-stored-password=POSTGRESQL_SECRET_MANAGER_STORED_PASSWORD) : [--postgresql-ca-certificate=POSTGRESQL_CA_CERTIFICATE : --postgresql-client-certificate=POSTGRESQL_CLIENT_CERTIFICATE --postgresql-client-key=POSTGRESQL_CLIENT_KEY]] | --salesforce-domain=SALESFORCE_DOMAIN (--salesforce-oauth2-client-id=SALESFORCE_OAUTH2_CLIENT_ID (--salesforce-oauth2-client-secret=SALESFORCE_OAUTH2_CLIENT_SECRET | --salesforce-prompt-for-oauth2-client-secret | --salesforce-secret-manager-stored-oauth2-client-secret=SALESFORCE_SECRET_MANAGER_STORED_OAUTH2_CLIENT_SECRET) | --salesforce-username=SALESFORCE_USERNAME (--salesforce-password=SALESFORCE_PASSWORD | --salesforce-prompt-for-password | --salesforce-secret-manager-stored-password=SALESFORCE_SECRET_MANAGER_STORED_PASSWORD) (--salesforce-prompt-for-security-token | --salesforce-secret-manager-stored-security-token=SALESFORCE_SECRET_MANAGER_STORED_SECURITY_TOKEN | --salesforce-security-token=SALESFORCE_SECURITY_TOKEN)) | --sqlserver-database=SQLSERVER_DATABASE --sqlserver-hostname=SQLSERVER_HOSTNAME --sqlserver-port=SQLSERVER_PORT --sqlserver-username=SQLSERVER_USERNAME (--sqlserver-password=SQLSERVER_PASSWORD | --sqlserver-prompt-for-password | --sqlserver-secret-manager-stored-password=SQLSERVER_SECRET_MANAGER_STORED_PASSWORD)]
[--private-connection=PRIVATE_CONNECTION | --static-ip-connectivity
| [--forward-ssh-hostname=FORWARD_SSH_HOSTNAME
--forward-ssh-username=FORWARD_SSH_USERNAME
@ -93,6 +96,14 @@ EXAMPLES
$ gcloud datastream connection-profiles create CONNECTION_PROFILE \
--location=us-central1 --type=bigquery --display-name=my-profile
To create a connection profile for MongoDB:
$ gcloud datastream connection-profiles create CONNECTION_PROFILE \
--location=us-central1 --type=mongodb \
--mongodb-password=fakepassword --mongodb-username=fakeuser \
--display-name=my-profile \
--mongodb-host-addresses=35.188.150.50:27017
POSITIONAL ARGUMENTS
Connection profile resource - The connection profile to create. The
arguments in this group can be used to specify the attributes of this
@ -194,6 +205,43 @@ OPTIONAL FLAGS
Path to secret manager, storing the password for the user used to
connect to the database.
--mongodb-host-addresses=IPv4_ADDRESS_OR_HOSTNAME:PORT,[...]
IP or hostname and port of the MongoDB source database.
This flag argument must be specified if any of the other arguments in
this group are specified.
--mongodb-username=MONGODB_USERNAME
Username Datastream will use to connect to the database.
This flag argument must be specified if any of the other arguments in
this group are specified.
--mongodb-replica-set=MONGODB_REPLICA_SET
Replica set of the MongoDB source database.
Exactly one of these must be specified:
--mongodb-password=MONGODB_PASSWORD
Password for the user that Datastream will be using to connect to
the database. This field is not returned on request, and the value
is encrypted when stored in Datastream.
--mongodb-prompt-for-password
Prompt for the password used to connect to the database.
--mongodb-secret-manager-stored-password=MONGODB_SECRET_MANAGER_STORED_PASSWORD
Path to secret manager, storing the password for the user used to
connect to the database.
Exactly one of these must be specified:
--mongodb-srv-connection-format
SRV Connection format for the MongoDB source database.
--mongodb-standard-connection-format
Standard connection format for the MongoDB source database.
--mysql-hostname=MYSQL_HOSTNAME
IP or hostname of the MySQL source database.

View file

@ -12,7 +12,11 @@ SYNOPSIS
--oracle-hostname=ORACLE_HOSTNAME --oracle-port=ORACLE_PORT
--oracle-username=ORACLE_USERNAME --oracle-password=ORACLE_PASSWORD
| --oracle-prompt-for-password
| --oracle-secret-manager-stored-password=ORACLE_SECRET_MANAGER_STORED_PASSWORD | --mysql-hostname=MYSQL_HOSTNAME --mysql-port=MYSQL_PORT --mysql-username=MYSQL_USERNAME --ca-certificate=CA_CERTIFICATE --client-certificate=CLIENT_CERTIFICATE --client-key=CLIENT_KEY --mysql-password=MYSQL_PASSWORD | --mysql-prompt-for-password | --mysql-secret-manager-stored-password=MYSQL_SECRET_MANAGER_STORED_PASSWORD | --postgresql-database=POSTGRESQL_DATABASE --postgresql-hostname=POSTGRESQL_HOSTNAME --postgresql-port=POSTGRESQL_PORT --postgresql-username=POSTGRESQL_USERNAME --postgresql-ca-certificate=POSTGRESQL_CA_CERTIFICATE --postgresql-client-certificate=POSTGRESQL_CLIENT_CERTIFICATE --postgresql-client-key=POSTGRESQL_CLIENT_KEY --postgresql-password=POSTGRESQL_PASSWORD | --postgresql-prompt-for-password | --postgresql-secret-manager-stored-password=POSTGRESQL_SECRET_MANAGER_STORED_PASSWORD | --salesforce-domain=SALESFORCE_DOMAIN --salesforce-oauth2-client-id=SALESFORCE_OAUTH2_CLIENT_ID --salesforce-oauth2-client-secret=SALESFORCE_OAUTH2_CLIENT_SECRET | --salesforce-prompt-for-oauth2-client-secret | --salesforce-secret-manager-stored-oauth2-client-secret=SALESFORCE_SECRET_MANAGER_STORED_OAUTH2_CLIENT_SECRET | --salesforce-username=SALESFORCE_USERNAME --salesforce-password=SALESFORCE_PASSWORD | --salesforce-prompt-for-password | --salesforce-secret-manager-stored-password=SALESFORCE_SECRET_MANAGER_STORED_PASSWORD --salesforce-prompt-for-security-token | --salesforce-secret-manager-stored-security-token=SALESFORCE_SECRET_MANAGER_STORED_SECURITY_TOKEN | --salesforce-security-token=SALESFORCE_SECURITY_TOKEN | --sqlserver-database=SQLSERVER_DATABASE --sqlserver-hostname=SQLSERVER_HOSTNAME --sqlserver-port=SQLSERVER_PORT --sqlserver-username=SQLSERVER_USERNAME --sqlserver-password=SQLSERVER_PASSWORD | --sqlserver-prompt-for-password | --sqlserver-secret-manager-stored-password=SQLSERVER_SECRET_MANAGER_STORED_PASSWORD]
| --oracle-secret-manager-stored-password=ORACLE_SECRET_MANAGER_STORED_PASSWORD | --mongodb-host-addresses=IPv4_ADDRESS_OR_HOSTNAME:PORT,
[...] --mongodb-replica-set=MONGODB_REPLICA_SET
--mongodb-username=MONGODB_USERNAME
--mongodb-password=MONGODB_PASSWORD | --mongodb-prompt-for-password
| --mongodb-secret-manager-stored-password=MONGODB_SECRET_MANAGER_STORED_PASSWORD --mongodb-srv-connection-format | --mongodb-standard-connection-format | --mysql-hostname=MYSQL_HOSTNAME --mysql-port=MYSQL_PORT --mysql-username=MYSQL_USERNAME --ca-certificate=CA_CERTIFICATE --client-certificate=CLIENT_CERTIFICATE --client-key=CLIENT_KEY --mysql-password=MYSQL_PASSWORD | --mysql-prompt-for-password | --mysql-secret-manager-stored-password=MYSQL_SECRET_MANAGER_STORED_PASSWORD | --postgresql-database=POSTGRESQL_DATABASE --postgresql-hostname=POSTGRESQL_HOSTNAME --postgresql-port=POSTGRESQL_PORT --postgresql-username=POSTGRESQL_USERNAME --postgresql-ca-certificate=POSTGRESQL_CA_CERTIFICATE --postgresql-client-certificate=POSTGRESQL_CLIENT_CERTIFICATE --postgresql-client-key=POSTGRESQL_CLIENT_KEY --postgresql-password=POSTGRESQL_PASSWORD | --postgresql-prompt-for-password | --postgresql-secret-manager-stored-password=POSTGRESQL_SECRET_MANAGER_STORED_PASSWORD | --salesforce-domain=SALESFORCE_DOMAIN --salesforce-oauth2-client-id=SALESFORCE_OAUTH2_CLIENT_ID --salesforce-oauth2-client-secret=SALESFORCE_OAUTH2_CLIENT_SECRET | --salesforce-prompt-for-oauth2-client-secret | --salesforce-secret-manager-stored-oauth2-client-secret=SALESFORCE_SECRET_MANAGER_STORED_OAUTH2_CLIENT_SECRET | --salesforce-username=SALESFORCE_USERNAME --salesforce-password=SALESFORCE_PASSWORD | --salesforce-prompt-for-password | --salesforce-secret-manager-stored-password=SALESFORCE_SECRET_MANAGER_STORED_PASSWORD --salesforce-prompt-for-security-token | --salesforce-secret-manager-stored-security-token=SALESFORCE_SECRET_MANAGER_STORED_SECURITY_TOKEN | --salesforce-security-token=SALESFORCE_SECURITY_TOKEN | --sqlserver-database=SQLSERVER_DATABASE --sqlserver-hostname=SQLSERVER_HOSTNAME --sqlserver-port=SQLSERVER_PORT --sqlserver-username=SQLSERVER_USERNAME --sqlserver-password=SQLSERVER_PASSWORD | --sqlserver-prompt-for-password | --sqlserver-secret-manager-stored-password=SQLSERVER_SECRET_MANAGER_STORED_PASSWORD]
[--clear-labels | --remove-labels=[KEY,...]]
[--private-connection=PRIVATE_CONNECTION | --static-ip-connectivity
| --forward-ssh-hostname=FORWARD_SSH_HOSTNAME
@ -82,6 +86,15 @@ EXAMPLES
$ gcloud datastream connection-profiles update CONNECTION_PROFILE \
--location=us-central1 --type=bigquery --display-name=my-profile
To update a connection profile for MongoDB:
$ gcloud datastream connection-profiles update CONNECTION_PROFILE \
--location=us-central1 --type=mongodb \
--mongodb-password=fakepassword --mongodb-username=fakeuser \
--display-name=my-profile \
--mongodb-host-addresses=35.188.150.50:27017 \
--static-ip-connectivity
POSITIONAL ARGUMENTS
Connection profile resource - The connection profile to update. The
arguments in this group can be used to specify the attributes of this
@ -169,6 +182,37 @@ OPTIONAL FLAGS
Path to secret manager, storing the password for the user used to
connect to the database.
--mongodb-host-addresses=IPv4_ADDRESS_OR_HOSTNAME:PORT,[...]
IP or hostname and port of the MongoDB source database.
--mongodb-replica-set=MONGODB_REPLICA_SET
Replica set of the MongoDB source database.
--mongodb-username=MONGODB_USERNAME
Username Datastream will use to connect to the database.
At most one of these can be specified:
--mongodb-password=MONGODB_PASSWORD
Password for the user that Datastream will be using to connect to
the database. This field is not returned on request, and the value
is encrypted when stored in Datastream.
--mongodb-prompt-for-password
Prompt for the password used to connect to the database.
--mongodb-secret-manager-stored-password=MONGODB_SECRET_MANAGER_STORED_PASSWORD
Path to secret manager, storing the password for the user used to
connect to the database.
At most one of these can be specified:
--mongodb-srv-connection-format
SRV Connection format for the MongoDB source database.
--mongodb-standard-connection-format
Standard connection format for the MongoDB source database.
--mysql-hostname=MYSQL_HOSTNAME
IP or hostname of the MySQL source database.

View file

@ -5,7 +5,8 @@ SYNOPSIS
gcloud datastream streams create (STREAM : --location=LOCATION)
--display-name=DISPLAY_NAME
(--backfill-none
| --backfill-all --mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS
| --backfill-all --mongodb-excluded-objects=MONGODB_EXCLUDED_OBJECTS
| --mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS
| --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS
| --postgresql-excluded-objects=POSTGRESQL_EXCLUDED_OBJECTS
| --salesforce-excluded-objects=SALESFORCE_EXCLUDED_OBJECTS
@ -13,7 +14,8 @@ SYNOPSIS
(--destination=DESTINATION
(--bigquery-destination-config=BIGQUERY_DESTINATION_CONFIG
| --gcs-destination-config=GCS_DESTINATION_CONFIG))
(--source=SOURCE (--mysql-source-config=MYSQL_SOURCE_CONFIG
(--source=SOURCE (--mongodb-source-config=MONGODB_SOURCE_CONFIG
| --mysql-source-config=MYSQL_SOURCE_CONFIG
| --oracle-source-config=ORACLE_SOURCE_CONFIG
| --postgresql-source-config=POSTGRESQL_SOURCE_CONFIG
| --salesforce-source-config=SALESFORCE_SOURCE_CONFIG
@ -64,6 +66,16 @@ EXAMPLES
--bigquery-destination-config=destination_config.json \
--backfill-none
To create a stream with a MongoDB source and a Cloud Storage destination
and that excludes some objects from being backfilled:
$ gcloud datastream streams create STREAM --location=us-central1 \
--display-name=my-stream --source=source \
--mongodb-source-config=source_config.json \
--destination=destination \
--gcs-destination-config=destination_config.json \
--backfill-all --mongodb-excluded-objects=excluded_objects.json
POSITIONAL ARGUMENTS
Stream resource - The stream to create. The arguments in this group can be
used to specify the attributes of this resource. (NOTE) Some attributes
@ -112,6 +124,30 @@ REQUIRED FLAGS
At most one of these can be specified:
--mongodb-excluded-objects=MONGODB_EXCLUDED_OBJECTS
Path to a YAML (or JSON) file containing the MongoDB data sources
to avoid backfilling.
The JSON file is formatted as follows, with camelCase field naming:
{
"databases": [
{
"database":"sample_database",
"collections": [
{
"collection": "sample_collection",
"fields": [
{
"field": "sample_field",
}
]
}
]
}
]
}
--mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS
Path to a YAML (or JSON) file containing the MySQL data sources to
avoid backfilling.
@ -351,6 +387,34 @@ REQUIRED FLAGS
Exactly one of these must be specified:
--mongodb-source-config=MONGODB_SOURCE_CONFIG
Path to a YAML (or JSON) file containing the configuration for
MongoDB Source Config.
The JSON file is formatted as follows, with snake_case field
naming:
{
"includeObjects": {},
"excludeObjects": {
"databases": [
{
"database": "sampleDb",
"collections": [
{
"collection": "sampleCollection",
"fields": [
{
"field": "SAMPLE_FIELD",
}
]
}
]
}
]
}
}
--mysql-source-config=MYSQL_SOURCE_CONFIG
Path to a YAML (or JSON) file containing the configuration for
MySQL Source Config.

View file

@ -6,7 +6,8 @@ SYNOPSIS
[--display-name=DISPLAY_NAME] [--state=STATE]
[--update-labels=[KEY=VALUE,...]] [--update-mask=UPDATE_MASK]
[--backfill-none
| --backfill-all --mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS
| --backfill-all --mongodb-excluded-objects=MONGODB_EXCLUDED_OBJECTS
| --mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS
| --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS
| --postgresql-excluded-objects=POSTGRESQL_EXCLUDED_OBJECTS
| --salesforce-excluded-objects=SALESFORCE_EXCLUDED_OBJECTS
@ -16,7 +17,8 @@ SYNOPSIS
--bigquery-destination-config=BIGQUERY_DESTINATION_CONFIG
| --gcs-destination-config=GCS_DESTINATION_CONFIG]
[--force | --validate-only]
[--source=SOURCE --mysql-source-config=MYSQL_SOURCE_CONFIG
[--source=SOURCE --mongodb-source-config=MONGODB_SOURCE_CONFIG
| --mysql-source-config=MYSQL_SOURCE_CONFIG
| --oracle-source-config=ORACLE_SOURCE_CONFIG
| --postgresql-source-config=POSTGRESQL_SOURCE_CONFIG
| --salesforce-source-config=SALESFORCE_SOURCE_CONFIG
@ -114,6 +116,30 @@ FLAGS
At most one of these can be specified:
--mongodb-excluded-objects=MONGODB_EXCLUDED_OBJECTS
Path to a YAML (or JSON) file containing the MongoDB data sources
to avoid backfilling.
The JSON file is formatted as follows, with camelCase field naming:
{
"databases": [
{
"database":"sample_database",
"collections": [
{
"collection": "sample_collection",
"fields": [
{
"field": "sample_field",
}
]
}
]
}
]
}
--mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS
Path to a YAML (or JSON) file containing the MySQL data sources to
avoid backfilling.
@ -374,6 +400,33 @@ FLAGS
At most one of these can be specified:
--mongodb-source-config=MONGODB_SOURCE_CONFIG
Path to a YAML (or JSON) file containing the configuration for
MongoDB Source Config.
The JSON file is formatted as follows, with snake_case field naming:
{
"includeObjects": {},
"excludeObjects": {
"databases": [
{
"database": "sampleDb",
"collections": [
{
"collection": "sampleCollection",
"fields": [
{
"field": "SAMPLE_FIELD",
}
]
}
]
}
]
}
}
--mysql-source-config=MYSQL_SOURCE_CONFIG
Path to a YAML (or JSON) file containing the configuration for MySQL
Source Config.