connectors

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

Overview

Name	connectors
Type	Resource
Id	firebase.dataconnect.connectors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The relative resource name of the connector, in the format: projects/{project}/locations/{location}/services/{service}/connectors/{connector}
annotations	object	Optional. Stores small amounts of arbitrary data.
clientCache	object	Optional. The client cache settings of the connector. (id: ClientCache)
createTime	string (google-datetime)	Output only. [Output only] Create time stamp.
displayName	string	Optional. Mutable human-readable name. 63 character limit.
etag	string	Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. AIP-154
labels	object	Optional. Labels as key value pairs.
reconciling	boolean	Output only. A field that if true, indicates that the system is working to compile and deploy the connector.
source	object	Required. The source files that comprise the connector. (id: Source)
uid	string	Output only. System-assigned, unique identifier.
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp.

list

Name	Datatype	Description
name	string	Identifier. The relative resource name of the connector, in the format: projects/{project}/locations/{location}/services/{service}/connectors/{connector}
annotations	object	Optional. Stores small amounts of arbitrary data.
clientCache	object	Optional. The client cache settings of the connector. (id: ClientCache)
createTime	string (google-datetime)	Output only. [Output only] Create time stamp.
displayName	string	Optional. Mutable human-readable name. 63 character limit.
etag	string	Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. AIP-154
labels	object	Optional. Labels as key value pairs.
reconciling	boolean	Output only. A field that if true, indicates that the system is working to compile and deploy the connector.
source	object	Required. The source files that comprise the connector. (id: Source)
uid	string	Output only. System-assigned, unique identifier.
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, servicesId, connectorsId		Gets details of a single Connector.
list	select	projectsId, locationsId, servicesId	filter, pageToken, orderBy, pageSize	Lists Connectors in a given project and location.
create	insert	projectsId, locationsId, servicesId	connectorId, validateOnly, requestId	Creates a new Connector in a given project and location. The operations are validated against and must be compatible with the active schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error.
patch	update	projectsId, locationsId, servicesId, connectorsId	requestId, validateOnly, updateMask, allowMissing	Updates the parameters of a single Connector, and creates a new ConnectorRevision with the updated Connector. The operations are validated against and must be compatible with the live schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error.
delete	delete	projectsId, locationsId, servicesId, connectorsId	force, etag, validateOnly, requestId, allowMissing	Deletes a single Connector.
execute_query	exec	projectsId, locationsId, servicesId, connectorsId		Execute a predefined query in a Connector.
impersonate_query	exec	projectsId, locationsId, servicesId, connectorsId		Impersonate a query defined on a Firebase SQL Connect connector. It grants the admin SDK access to queries defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.
execute_mutation	exec	projectsId, locationsId, servicesId, connectorsId		Execute a predefined mutation in a Connector.
impersonate_mutation	exec	projectsId, locationsId, servicesId, connectorsId		Impersonate a mutation defined on a Firebase SQL Connect connector. It grants the admin SDK access to mutations defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connectorsId	string
locationsId	string
projectsId	string
servicesId	string
allowMissing	boolean
connectorId	string
etag	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Gets details of a single Connector.

SELECT
name,
annotations,
clientCache,
createTime,
displayName,
etag,
labels,
reconciling,
source,
uid,
updateTime
FROM firebase.dataconnect.connectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND servicesId = '{{ servicesId }}' -- required
AND connectorsId = '{{ connectorsId }}' -- required
;

list

Lists Connectors in a given project and location.

SELECT
name,
annotations,
clientCache,
createTime,
displayName,
etag,
labels,
reconciling,
source,
uid,
updateTime
FROM firebase.dataconnect.connectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND servicesId = '{{ servicesId }}' -- required
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

create

Creates a new Connector in a given project and location. The operations are validated against and must be compatible with the active schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error.

INSERT INTO firebase.dataconnect.connectors (
data__clientCache,
data__source,
data__annotations,
data__displayName,
data__name,
data__labels,
projectsId,
locationsId,
servicesId,
connectorId,
validateOnly,
requestId
)
SELECT 
'{{ clientCache }}',
'{{ source }}',
'{{ annotations }}',
'{{ displayName }}',
'{{ name }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ servicesId }}',
'{{ connectorId }}',
'{{ validateOnly }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: connectors
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the connectors resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the connectors resource.
  - name: servicesId
    value: "{{ servicesId }}"
    description: Required parameter for the connectors resource.
  - name: clientCache
    description: |
      Optional. The client cache settings of the connector.
    value:
      strictValidationEnabled: {{ strictValidationEnabled }}
      entityIdIncluded: {{ entityIdIncluded }}
  - name: source
    description: |
      Required. The source files that comprise the connector.
    value:
      files:
        - path: "{{ path }}"
          content: "{{ content }}"
  - name: annotations
    value: "{{ annotations }}"
    description: |
      Optional. Stores small amounts of arbitrary data.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Optional. Mutable human-readable name. 63 character limit.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels as key value pairs.
  - name: connectorId
    value: "{{ connectorId }}"
  - name: validateOnly
    value: {{ validateOnly }}
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single Connector, and creates a new ConnectorRevision with the updated Connector. The operations are validated against and must be compatible with the live schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error.

UPDATE firebase.dataconnect.connectors
SET 
data__clientCache = '{{ clientCache }}',
data__source = '{{ source }}',
data__annotations = '{{ annotations }}',
data__displayName = '{{ displayName }}',
data__name = '{{ name }}',
data__labels = '{{ labels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND servicesId = '{{ servicesId }}' --required
AND connectorsId = '{{ connectorsId }}' --required
AND requestId = '{{ requestId}}'
AND validateOnly = {{ validateOnly}}
AND updateMask = '{{ updateMask}}'
AND allowMissing = {{ allowMissing}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Connector.

DELETE FROM firebase.dataconnect.connectors
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND servicesId = '{{ servicesId }}' --required
AND connectorsId = '{{ connectorsId }}' --required
AND force = '{{ force }}'
AND etag = '{{ etag }}'
AND validateOnly = '{{ validateOnly }}'
AND requestId = '{{ requestId }}'
AND allowMissing = '{{ allowMissing }}'
;

Lifecycle Methods

execute_query

Execute a predefined query in a Connector.

EXEC firebase.dataconnect.connectors.execute_query 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@servicesId='{{ servicesId }}' --required, 
@connectorsId='{{ connectorsId }}' --required 
@@json=
'{
"variables": "{{ variables }}", 
"operationName": "{{ operationName }}"
}'
;

impersonate_query

Impersonate a query defined on a Firebase SQL Connect connector. It grants the admin SDK access to queries defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.

EXEC firebase.dataconnect.connectors.impersonate_query 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@servicesId='{{ servicesId }}' --required, 
@connectorsId='{{ connectorsId }}' --required 
@@json=
'{
"variables": "{{ variables }}", 
"extensions": "{{ extensions }}", 
"operationName": "{{ operationName }}"
}'
;

execute_mutation

Execute a predefined mutation in a Connector.

EXEC firebase.dataconnect.connectors.execute_mutation 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@servicesId='{{ servicesId }}' --required, 
@connectorsId='{{ connectorsId }}' --required 
@@json=
'{
"variables": "{{ variables }}", 
"operationName": "{{ operationName }}"
}'
;

impersonate_mutation

Impersonate a mutation defined on a Firebase SQL Connect connector. It grants the admin SDK access to mutations defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.

EXEC firebase.dataconnect.connectors.impersonate_mutation 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@servicesId='{{ servicesId }}' --required, 
@connectorsId='{{ connectorsId }}' --required 
@@json=
'{
"variables": "{{ variables }}", 
"extensions": "{{ extensions }}", 
"operationName": "{{ operationName }}"
}'
;