connections

Creates, updates, deletes, gets or lists a connections resource.

Overview

Name	connections
Type	Resource
Id	google.bigqueryconnection.connections

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
description	string	User provided description.
aws	object	Connection properties specific to Amazon Web Services (AWS).
azure	object	Container for connection properties specific to Azure.
cloudResource	object	Container for connection properties for delegation of access to GCP resources.
cloudSpanner	object	Connection properties specific to Cloud Spanner.
cloudSql	object	Connection properties specific to the Cloud SQL.
configuration	object	Represents concrete parameter values for Connector Configuration.
creationTime	string	Output only. The creation timestamp of the connection.
friendlyName	string	User provided display name for the connection.
hasCredential	boolean	Output only. True, if credential is configured for this connection.
kmsKeyName	string	Optional. The Cloud KMS key that is used for credentials encryption. If omitted, internal Google owned encryption keys are used. Example: projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]
lastModifiedTime	string	Output only. The last update timestamp of the connection.
salesforceDataCloud	object	Connection properties specific to Salesforce DataCloud. This is intended for use only by Salesforce partner projects.
spark	object	Container for connection properties to execute stored procedures for Apache Spark.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	connectionsId, locationsId, projectsId	Returns specified connection.
list	SELECT	locationsId, projectsId	Returns a list of connections in the given project.
create	INSERT	locationsId, projectsId	Creates a new connection.
delete	DELETE	connectionsId, locationsId, projectsId	Deletes connection and associated credential.
patch	UPDATE	connectionsId, locationsId, projectsId	Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

SELECT examples

Returns a list of connections in the given project.

SELECT
name,
description,
aws,
azure,
cloudResource,
cloudSpanner,
cloudSql,
configuration,
creationTime,
friendlyName,
hasCredential,
kmsKeyName,
lastModifiedTime,
salesforceDataCloud,
spark
FROM google.bigqueryconnection.connections
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new connections resource.

All Properties

/*+ create */
INSERT INTO google.bigqueryconnection.connections (
locationsId,
projectsId,
friendlyName,
description,
cloudSql,
aws,
azure,
cloudSpanner,
cloudResource,
spark,
salesforceDataCloud,
configuration,
kmsKeyName
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ friendlyName }}',
'{{ description }}',
'{{ cloudSql }}',
'{{ aws }}',
'{{ azure }}',
'{{ cloudSpanner }}',
'{{ cloudResource }}',
'{{ spark }}',
'{{ salesforceDataCloud }}',
'{{ configuration }}',
'{{ kmsKeyName }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: friendlyName
      value: string
    - name: description
      value: string
    - name: cloudSql
      value:
        - name: instanceId
          value: string
        - name: database
          value: string
        - name: type
          value: string
        - name: credential
          value:
            - name: username
              value: string
            - name: password
              value: string
        - name: serviceAccountId
          value: string
    - name: aws
      value:
        - name: accessRole
          value:
            - name: iamRoleId
              value: string
            - name: identity
              value: string
    - name: azure
      value:
        - name: application
          value: string
        - name: clientId
          value: string
        - name: objectId
          value: string
        - name: customerTenantId
          value: string
        - name: redirectUri
          value: string
        - name: federatedApplicationClientId
          value: string
        - name: identity
          value: string
    - name: cloudSpanner
      value:
        - name: database
          value: string
        - name: useParallelism
          value: boolean
        - name: maxParallelism
          value: integer
        - name: useServerlessAnalytics
          value: boolean
        - name: useDataBoost
          value: boolean
        - name: databaseRole
          value: string
    - name: cloudResource
      value:
        - name: serviceAccountId
          value: string
    - name: spark
      value:
        - name: serviceAccountId
          value: string
        - name: metastoreServiceConfig
          value:
            - name: metastoreService
              value: string
        - name: sparkHistoryServerConfig
          value:
            - name: dataprocCluster
              value: string
    - name: salesforceDataCloud
      value:
        - name: instanceUri
          value: string
        - name: identity
          value: string
        - name: tenantId
          value: string
    - name: configuration
      value:
        - name: connectorId
          value: string
        - name: endpoint
          value:
            - name: hostPort
              value: string
        - name: authentication
          value:
            - name: usernamePassword
              value:
                - name: username
                  value: string
                - name: password
                  value:
                    - name: plaintext
                      value: string
                    - name: secretType
                      value: string
            - name: serviceAccount
              value: string
        - name: network
          value:
            - name: privateServiceConnect
              value:
                - name: networkAttachment
                  value: string
        - name: asset
          value:
            - name: database
              value: string
            - name: googleCloudResource
              value: string
    - name: creationTime
      value: string
    - name: lastModifiedTime
      value: string
    - name: hasCredential
      value: boolean
    - name: kmsKeyName
      value: string

UPDATE example

Updates a connections resource.

/*+ update */
UPDATE google.bigqueryconnection.connections
SET 
friendlyName = '{{ friendlyName }}',
description = '{{ description }}',
cloudSql = '{{ cloudSql }}',
aws = '{{ aws }}',
azure = '{{ azure }}',
cloudSpanner = '{{ cloudSpanner }}',
cloudResource = '{{ cloudResource }}',
spark = '{{ spark }}',
salesforceDataCloud = '{{ salesforceDataCloud }}',
configuration = '{{ configuration }}',
kmsKeyName = '{{ kmsKeyName }}'
WHERE 
connectionsId = '{{ connectionsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified connections resource.

/*+ delete */
DELETE FROM google.bigqueryconnection.connections
WHERE connectionsId = '{{ connectionsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';