business_metadata

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

Overview

Name	business_metadata
Type	Resource
Id	confluent.catalog.business_metadata

Fields

Name	Datatype	Description
attributes	object	The business metadata attributes
entityName	string	The qualified name of the entity
entityType	string	The entity type
error	object	Error message of this operation
typeName	string	The business metadata name

Methods

Name	Accessible by	Required Params	Description
get_business_metadata	SELECT	qualifiedName, typeName	Gets the list of business metadata for a given entity represented by a qualified name.
create_business_metadata	INSERT		Bulk API to create multiple business metadata.
delete_business_metadata	DELETE	bmName, qualifiedName, typeName	Delete a business metadata on an entity.
update_business_metadata	EXEC		Bulk API to update multiple business metadata.

SELECT examples

Gets the list of business metadata for a given entity represented by a qualified name.

SELECT
attributes,
entityName,
entityType,
error,
typeName
FROM confluent.catalog.business_metadata
WHERE qualifiedName = '{{ qualifiedName }}'
AND typeName = '{{ typeName }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO confluent.catalog.business_metadata (

)
SELECT 

;

Manifest

- name: business_metadata
  props: []

DELETE example

Deletes the specified business_metadata resource.

/*+ delete */
DELETE FROM confluent.catalog.business_metadata
WHERE bmName = '{{ bmName }}'
AND qualifiedName = '{{ qualifiedName }}'
AND typeName = '{{ typeName }}';