1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-09 10:56:49 +00:00
gcloud-help/gcloud/sql/connect
2026-02-11 11:28:25 +00:00

77 lines
2.1 KiB
Text

NAME
gcloud sql connect - connects to a Cloud SQL instance
SYNOPSIS
gcloud sql connect INSTANCE [--database=DATABASE, -d DATABASE]
[--debug-logs] [--port=PORT; default=9470] [--run-connection-test]
[--skip-ssl] [--auto-iam-authn | --user=USER, -u USER]
[--auto-ip | --private-ip | --psc] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Connects to a Cloud SQL instance.
EXAMPLES
To connect to a Cloud SQL instance, run:
$ gcloud sql connect my-instance --user=root
POSITIONAL ARGUMENTS
INSTANCE
Cloud SQL instance ID.
FLAGS
--database=DATABASE, -d DATABASE
The PostgreSQL or SQL Server database to connect to.
--debug-logs
Enable verbose debug logs for Cloud SQL Proxy.
--port=PORT; default=9470
Port number that gcloud will use to connect to the Cloud SQL Proxy
through localhost.
--run-connection-test
Run connection test for Cloud SQL Proxy.
--skip-ssl
Skip SSL certificate verification for MySQL instances.
User selection settings for Cloud SQL Proxy connection.
At most one of these can be specified:
--auto-iam-authn
Enables IAM database authentication for connections to MySQL and
Postgres instances.
--user=USER, -u USER
Cloud SQL instance user to connect as.
IP address selection settings for Cloud SQL Proxy connection.
At most one of these can be specified:
--auto-ip
Connect to the Cloud SQL instance with auto IP detection.
--private-ip
Connect to the Cloud SQL instance using private IP.
--psc
Connect to the Cloud SQL instance using Private Service Connect.
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
These variants are also available:
$ gcloud alpha sql connect
$ gcloud beta sql connect