tag_defs

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

Overview

Name	tag_defs
Type	Resource
Id	confluent.catalog.tag_defs

Fields

The following fields are returned by SELECT queries:

get_tag_def_by_name

The tag 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
entityTypes	array	The entity types
guid	string	The internal guid
options	object	The options
serviceType	string	The service type
subTypes	array	The subtypes
superTypes	array	The supertypes
typeVersion	string	The type version
updateTime	integer (int64)	The update time
updatedBy	string	The updater
version	integer (int32)	The version

get_all_tag_defs

The tag 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
entityTypes	array	The entity types
error	object	Error message of this operation
guid	string	The internal guid
options	object	The options
serviceType	string	The service type
subTypes	array	The subtypes
superTypes	array	The supertypes
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_tag_def_by_name	select	tagName		Get the tag definition with the given name.
get_all_tag_defs	select		prefix	Bulk retrieval API for retrieving tag definitions.
create_tag_defs	insert			Bulk create API for tag definitions.
update_tag_defs	replace			Bulk update API for tag definitions.
delete_tag_def	delete	tagName		Delete API for tag 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
tagName	string	The name of the tag definition
prefix	string	The prefix of a tag definition name

SELECT examples

get_tag_def_by_name

Get the tag definition with the given name.

SELECT
name,
attributeDefs,
category,
createTime,
createdBy,
description,
entityTypes,
guid,
options,
serviceType,
subTypes,
superTypes,
typeVersion,
updateTime,
updatedBy,
version
FROM confluent.catalog.tag_defs
WHERE tagName = '{{ tagName }}' -- required
;

get_all_tag_defs

Bulk retrieval API for retrieving tag definitions.

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

INSERT examples

create_tag_defs

Bulk create API for tag definitions.

INSERT INTO confluent.catalog.tag_defs (

)
SELECT 

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

Manifest

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

REPLACE examples

update_tag_defs

Bulk update API for tag definitions.

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

DELETE examples

delete_tag_def

Delete API for tag definition identified by its name.

DELETE FROM confluent.catalog.tag_defs
WHERE tagName = '{{ tagName }}' --required
;