connections

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

Overview

Name	connections
Type	Resource
Id	confluent.sql.connections

Fields

Name	Datatype	Description
name	string	The user provided name of the resource, unique within this environment.
_spec	object
api_version	string	APIVersion defines the schema version of this representation of a resource.
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	Encapsulates the model provider access details
status	object	The status of the Connection

Methods

Name	Accessible by	Required Params	Description
get_sqlv1connection	SELECT	connection_name, environment_id, organization_id	Make a request to read a Connection.
list_sqlv1connections	SELECT	environment_id, organization_id	Retrieve a sorted, filtered and paginated list of all Connections.
create_sqlv1connection	INSERT	environment_id, organization_id	Make a request to create a Connection.
delete_sqlv1connection	DELETE	connection_name, environment_id, organization_id	Make a request to delete a statement.
update_sqlv1connection	EXEC	connection_name, environment_id, organization_id	Make a request to update a connection.

SELECT examples

Retrieve a sorted, filtered and paginated list of all Connections.

SELECT
name,
_spec,
api_version,
kind,
metadata,
spec,
status
FROM confluent.sql.connections
WHERE environment_id = '{{ environment_id }}'
AND organization_id = '{{ organization_id }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO confluent.sql.connections (
data__name,
data__spec,
environment_id,
organization_id
)
SELECT 
'{{ name }}',
'{{ spec }}',
'{{ environment_id }}',
'{{ organization_id }}'
;

Manifest

- name: connections
  props:
    - name: environment_id
      value: string
    - name: organization_id
      value: string
    - name: name
      value: string
    - name: spec
      value: object

DELETE example

Deletes the specified connections resource.

/*+ delete */
DELETE FROM confluent.sql.connections
WHERE connection_name = '{{ connection_name }}'
AND environment_id = '{{ environment_id }}'
AND organization_id = '{{ organization_id }}';