catalog_integrations

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

Overview

Name	catalog_integrations
Type	Resource
Id	confluent.tableflow.catalog_integrations

Fields

The following fields are returned by SELECT queries:

get_tableflow_v1_catalog_integration

Catalog Integration.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (tableflow/v1)
kind	string	Kind defines the object this REST resource represents. (CatalogIntegration)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Catalog Integration
status	object	The status of the Catalog Integration

list_tableflow_v1_catalog_integrations

Catalog Integration.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (tableflow/v1)
kind	string	Kind defines the object this REST resource represents. (CatalogIntegration)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Catalog Integration
status	object	The status of the Catalog Integration

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_tableflow_v1_catalog_integration	select	environment, spec.kafka_cluster, id		Make a request to read a catalog integration.
list_tableflow_v1_catalog_integrations	select	environment, spec.kafka_cluster	page_size, page_token	Retrieve a sorted, filtered, paginated list of all catalog integrations.
create_tableflow_v1_catalog_integration	insert	spec		Make a request to create a catalog integration.
update_tableflow_v1_catalog_integration	update	id		Make a request to update a catalog integration.
delete_tableflow_v1_catalog_integration	delete	environment, spec.kafka_cluster, id		Make a request to delete a catalog integration.

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
environment	string	Scope the operation to the given environment. (example: env-00000)
id	string	The unique identifier for the catalog integration.
spec.kafka_cluster	string	Scope the operation to the given spec.kafka_cluster. (example: lkc-00000)
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_tableflow_v1_catalog_integration

Make a request to read a catalog integration.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.tableflow.catalog_integrations
WHERE environment = '{{ environment }}' -- required
AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' -- required
AND id = '{{ id }}' -- required
;

list_tableflow_v1_catalog_integrations

Retrieve a sorted, filtered, paginated list of all catalog integrations.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.tableflow.catalog_integrations
WHERE environment = '{{ environment }}' -- required
AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_tableflow_v1_catalog_integration

Make a request to create a catalog integration.

INSERT INTO confluent.tableflow.catalog_integrations (
spec
)
SELECT 
'{{ spec }}' /* required */
RETURNING
id,
api_version,
kind,
metadata,
spec,
status
;

Manifest

# Description fields are for documentation purposes
- name: catalog_integrations
props:
  - name: spec
    description: |
      The desired state of the Catalog Integration
    value:
      display_name: "{{ display_name }}"
      suspended: {{ suspended }}
      config:
        kind: "{{ kind }}"
        provider_integration_id: "{{ provider_integration_id }}"
        endpoint: "{{ endpoint }}"
        client_id: "{{ client_id }}"
        client_secret: "{{ client_secret }}"
        warehouse: "{{ warehouse }}"
        allowed_scope: "{{ allowed_scope }}"
        workspace_endpoint: "{{ workspace_endpoint }}"
        catalog_name: "{{ catalog_name }}"
      environment:
        id: "{{ id }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"
      kafka_cluster:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"

UPDATE examples

update_tableflow_v1_catalog_integration

Make a request to update a catalog integration.

UPDATE confluent.tableflow.catalog_integrations
SET 
spec = '{{ spec }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
api_version,
kind,
metadata,
spec,
status;

DELETE examples

delete_tableflow_v1_catalog_integration

Make a request to delete a catalog integration.

DELETE FROM confluent.tableflow.catalog_integrations
WHERE environment = '{{ environment }}' --required
AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' --required
AND id = '{{ id }}' --required
;