- NAME
-
- gcloud oracle-database database-connections create - create a new DatabaseConnection
- SYNOPSIS
-
-
gcloud oracle-database database-connections createDATABASE_CONNECTION--connection-string=CONNECTION_STRING[--async] [--display-name=DISPLAY_NAME] [--labels=[LABELS,…]] [--location=LOCATION] [--odb-network=ODB_NETWORK] [--password-secret-version=PASSWORD_SECRET_VERSION] [--request-id=REQUEST_ID] [--secret=SECRET] [--username=USERNAME] [--wallet-secret-version=WALLET_SECRET_VERSION] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Create a new DatabaseConnection.
- EXAMPLES
-
To create a DatabaseConnection with id
my-connectionin the locationus-east4with display-namemy connection, connection-stringmy-db-host.example.com:1521/my-service, usernameadmin, password-secret-versionprojects/my-project/secrets/my-secret/versions/1, and odb-networkprojects/my-project/locations/us-east4/odbNetworks/my-odbnetwork, run:gcloud oracle-database database-connections create my-connection --location=us-east4 --display-name="my connection" --connection-string="my-db-host.example.com:1521/my-service" --username="admin" --password-secret-version=projects/my-project/secrets/my-secret/versions/1 --odb-network=projects/my-project/locations/us-east4/odbNetworks/my-odbnetwork - POSITIONAL ARGUMENTS
-
-
DatabaseConnection resource - Identifier. The resource name of the
DatabaseConnection. Format:
projects/{project}/locations/{location}/databaseConnections/{database_connection}
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
projectattribute:-
provide the argument
database_connectionon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
locationattribute:-
provide the argument
database_connectionon the command line with a fully specified name; -
provide the argument
--locationon the command line.
This must be specified.
DATABASE_CONNECTION-
ID of the databaseConnection or fully qualified identifier for the
databaseConnection.
To set the
database_connectionattribute:-
provide the argument
database_connectionon the command line.
-
provide the argument
-
provide the argument
-
DatabaseConnection resource - Identifier. The resource name of the
DatabaseConnection. Format:
projects/{project}/locations/{location}/databaseConnections/{database_connection}
This represents a Cloud resource. (NOTE) Some attributes are not given arguments
in this group but can be set in other ways.
- REQUIRED FLAGS
-
--connection-string=CONNECTION_STRING- Oracle Easy Connect or TNS connection string. Example: "your-db-host.example.com:1521/YOUR_SERVICE_NAME"
- OPTIONAL FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
--display-name=DISPLAY_NAME- User-friendly display name for the connection.
--labels=[LABELS,…]-
Optional: Labels as key-value pairs to organize the resource.
KEY-
Keys must start with a lowercase character and contain only hyphens
(
-), underscores (_), lowercase characters, and numbers. VALUE-
Values must contain only hyphens (
-), underscores (_), lowercase characters, and numbers.
Shorthand Example:--labels=string=string
JSON Example:--labels='{"string": "string"}'
File Example:--labels=path_to_file.(yaml|json)
--location=LOCATION- For resources [database_connection, odb-network], provides fallback value for resource location attribute. When the resource's full URI path is not provided, location will fallback to this flag value.
- Arguments for the network configuration.
-
OdbNetwork resource - For Oracle Database@Google cloud resources. Format:
projects/{project}/locations/{location}/odbNetworks/{odbNetwork} 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
projectattribute:-
provide the argument
--odb-networkon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
locationattribute:-
provide the argument
--odb-networkon the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
--odb-network=ODB_NETWORK-
ID of the odbNetwork or fully qualified identifier for the odbNetwork.
To set the
odb-networkattribute:-
provide the argument
--odb-networkon the command line.
-
provide the argument
-
SecretVersion resource - The resource name of the GCP Secret Manager secret
version containing the password for the specified username. Format:
projects/{project}/secrets/{secret_id}/versions/{version_id} The service's
Per-Product Per-Project Service Account (P4SA) must have the
'secretmanager.secretAccessor' permission on this secret. 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
projectattribute:-
provide the argument
--password-secret-versionon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
secretattribute:-
provide the argument
--password-secret-versionon the command line with a fully specified name; -
provide the argument
--secreton the command line.
-
provide the argument
--password-secret-version=PASSWORD_SECRET_VERSION-
ID of the secretVersion or fully qualified identifier for the secretVersion.
To set the
secret-versionattribute:-
provide the argument
--password-secret-versionon the command line.
-
provide the argument
--request-id=REQUEST_ID-
An optional ID to identify the request. This value is used to identify duplicate
requests. If you make a request with the same request ID and the original
request is still in progress or completed, the server ignores the second
request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
--secret=SECRET- For resources [password-secret-version, wallet-secret-version], provides fallback value for resource secret attribute. When the resource's full URI path is not provided, secret will fallback to this flag value.
--username=USERNAME- The default database username to use for connections.
- Arguments for the wallet source.
-
SecretVersion resource - Optional: The resource name of the GCP Secret Manager
secret version containing base64 encoded content of the Oracle Wallet ZIP file
required for mTLS/TLS connections. Format:
projects/{project}/secrets/{secret_id}/versions/{version_id} The service's
Per-Product Per-Project Service Account (P4SA) must have the
'secretmanager.secretAccessor' permission on this secret. 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
projectattribute:-
provide the argument
--wallet-secret-versionon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
secretattribute:-
provide the argument
--wallet-secret-versionon the command line with a fully specified name; -
provide the argument
--secreton the command line.
-
provide the argument
--wallet-secret-version=WALLET_SECRET_VERSION-
ID of the secretVersion or fully qualified identifier for the secretVersion.
To set the
secret-versionattribute:-
provide the argument
--wallet-secret-versionon the command line.
-
provide the argument
- 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 helpfor details. - API REFERENCE
-
This command uses the
oracledatabase/v1API. The full documentation for this API can be found at: https://cloud.google.com/oracle/database/docs
gcloud oracle-database database-connections create
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-10-27 UTC.