business_metadata_defs

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

Overview

Name	business_metadata_defs
Type	Resource
Id	confluent.catalog.business_metadata_defs

Fields

The following fields are returned by SELECT queries:

get_business_metadata_def_by_name

The business metadata definition

Name	Datatype	Description
name	string	The name
attributeDefs	array	The attribute definitions
category	string	The category (PRIMITIVE, OBJECT_ID_TYPE, ENUM, STRUCT, CLASSIFICATION, ENTITY, ARRAY, MAP, RELATIONSHIP, BUSINESS_METADATA)
createTime	integer (int64)	The create time
createdBy	string	The creator
description	string	The description
guid	string	The internal guid
options	object	The options
serviceType	string	The service type
typeVersion	string	The type version
updateTime	integer (int64)	The update time
updatedBy	string	The updater
version	integer (int32)	The version

get_all_business_metadata_defs

The business metadata definitions

Name	Datatype	Description
name	string	The name
attributeDefs	array	The attribute definitions
category	string	The category (PRIMITIVE, OBJECT_ID_TYPE, ENUM, STRUCT, CLASSIFICATION, ENTITY, ARRAY, MAP, RELATIONSHIP, BUSINESS_METADATA)
createTime	integer (int64)	The create time
createdBy	string	The creator
description	string	The description
error	object	Error message of this operation
guid	string	The internal guid
options	object	The options
serviceType	string	The service type
typeVersion	string	The type version
updateTime	integer (int64)	The update time
updatedBy	string	The updater
version	integer (int32)	The version

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_business_metadata_def_by_name	select	bmName		Get the business metadata definition with the given name.
get_all_business_metadata_defs	select		prefix	Bulk retrieval API for retrieving business metadata definitions.
create_business_metadata_defs	insert			Bulk create API for business metadata definitions.
update_business_metadata_defs	replace			Bulk update API for business metadata definitions.
delete_business_metadata_def	delete	bmName		Delete API for business metadata definition identified by its name.

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 definition
prefix	string	The prefix of a business metadata definition name

SELECT examples

get_business_metadata_def_by_name

Get the business metadata definition with the given name.

SELECT
name,
attributeDefs,
category,
createTime,
createdBy,
description,
guid,
options,
serviceType,
typeVersion,
updateTime,
updatedBy,
version
FROM confluent.catalog.business_metadata_defs
WHERE bmName = '{{ bmName }}' -- required
;

get_all_business_metadata_defs

Bulk retrieval API for retrieving business metadata definitions.

SELECT
name,
attributeDefs,
category,
createTime,
createdBy,
description,
error,
guid,
options,
serviceType,
typeVersion,
updateTime,
updatedBy,
version
FROM confluent.catalog.business_metadata_defs
WHERE prefix = '{{ prefix }}'
;

INSERT examples

create_business_metadata_defs

Bulk create API for business metadata definitions.

INSERT INTO confluent.catalog.business_metadata_defs (

)
SELECT 

RETURNING
name,
attributeDefs,
category,
createTime,
createdBy,
description,
error,
guid,
options,
serviceType,
typeVersion,
updateTime,
updatedBy,
version
;

Manifest

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

REPLACE examples

update_business_metadata_defs

Bulk update API for business metadata definitions.

REPLACE confluent.catalog.business_metadata_defs
SET 
-- No updatable properties
RETURNING
name,
attributeDefs,
category,
createTime,
createdBy,
description,
error,
guid,
options,
serviceType,
typeVersion,
updateTime,
updatedBy,
version;

DELETE examples

delete_business_metadata_def

Delete API for business metadata definition identified by its name.

DELETE FROM confluent.catalog.business_metadata_defs
WHERE bmName = '{{ bmName }}' --required
;