business_metadata

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

Overview

Name	business_metadata
Type	Resource
Id	confluent.catalog.business_metadata

Fields

The following fields are returned by SELECT queries:

get_business_metadata

The business metadata

Name	Datatype	Description
attributes	string	The business metadata attributes (opaque JSON object)
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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_business_metadata	select	typeName, qualifiedName		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.
update_business_metadata	replace			Bulk API to update multiple business metadata.
delete_business_metadata	delete	typeName, qualifiedName, bmName		Delete a business metadata on an entity.

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
bmName	string	The name of the business metadata
qualifiedName	string	The qualified name of the entity
typeName	string	The type of the entity

SELECT examples

get_business_metadata

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 typeName = '{{ typeName }}' -- required
AND qualifiedName = '{{ qualifiedName }}' -- required
;

INSERT examples

create_business_metadata

Bulk API to create multiple business metadata.

INSERT INTO confluent.catalog.business_metadata (

)
SELECT 

RETURNING
attributes,
entityName,
entityType,
error,
typeName
;

Manifest

# Description fields are for documentation purposes
- name: business_metadata
props:

REPLACE examples

update_business_metadata

Bulk API to update multiple business metadata.

REPLACE confluent.catalog.business_metadata
SET 
-- No updatable properties
RETURNING
attributes,
entityName,
entityType,
error,
typeName;

DELETE examples

delete_business_metadata

Delete a business metadata on an entity.

DELETE FROM confluent.catalog.business_metadata
WHERE typeName = '{{ typeName }}' --required
AND qualifiedName = '{{ qualifiedName }}' --required
AND bmName = '{{ bmName }}' --required
;