entities

Creates, updates, deletes, gets or lists an entities resource.

Overview

Name	entities
Type	Resource
Id	confluent.catalog.entities

Fields

The following fields are returned by SELECT queries:

get_by_unique_attributes

The entity

Name	Datatype	Description
entity	object	The entity
referredEntities	object	The referred entities

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_unique_attributes	select	typeName, qualifiedName	minExtInfo, ignoreRelationships	Fetch complete definition of an entity given its type and unique attribute.
partial_entity_update	replace			Partially update an entity attribute.
search_using_attribute	exec		type, attr, attrName, attrValuePrefix, tag, sortBy, sortOrder, deleted, limit, offset	Retrieve data for the specified attribute search query.
search_using_basic	exec		query, type, attr, tag, sortBy, sortOrder, deleted, limit, offset	Retrieve data for the specified fulltext query.

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
qualifiedName	string	The qualified name of the entity
typeName	string	The type of the entity
attr	array	One of more additional attributes to return in the response
attrName	array	The attribute to search
attrValuePrefix	array	The prefix for the attribute value to search
deleted	boolean	Whether to include deleted entities
ignoreRelationships	boolean	Whether to ignore relationships
limit	integer (int32)	Limit the result set to only include the specified number of entries
minExtInfo	boolean	Whether to populate on header and schema attributes
offset	integer (int32)	Start offset of the result set (useful for pagination)
query	string	The full-text query
sortBy	string	An attribute to sort by
sortOrder	string	Sort order, either ASCENDING (default) or DESCENDING
tag	string	Limit the result to only entities tagged with the given tag
type	array	Limit the result to only entities of specified types

SELECT examples

get_by_unique_attributes

Fetch complete definition of an entity given its type and unique attribute.

SELECT
entity,
referredEntities
FROM confluent.catalog.entities
WHERE typeName = '{{ typeName }}' -- required
AND qualifiedName = '{{ qualifiedName }}' -- required
AND minExtInfo = '{{ minExtInfo }}'
AND ignoreRelationships = '{{ ignoreRelationships }}'
;

REPLACE examples

partial_entity_update

Partially update an entity attribute.

REPLACE confluent.catalog.entities
SET 
referredEntities = '{{ referredEntities }}',
entity = '{{ entity }}'
RETURNING
mutatedEntities;

Lifecycle Methods

search_using_attribute

Retrieve data for the specified attribute search query.

EXEC confluent.catalog.entities.search_using_attribute 
@type='{{ type }}', 
@attr='{{ attr }}', 
@attrName='{{ attrName }}', 
@attrValuePrefix='{{ attrValuePrefix }}', 
@tag='{{ tag }}', 
@sortBy='{{ sortBy }}', 
@sortOrder='{{ sortOrder }}', 
@deleted={{ deleted }}, 
@limit='{{ limit }}', 
@offset='{{ offset }}'
;

search_using_basic

Retrieve data for the specified fulltext query.

EXEC confluent.catalog.entities.search_using_basic 
@query='{{ query }}', 
@type='{{ type }}', 
@attr='{{ attr }}', 
@tag='{{ tag }}', 
@sortBy='{{ sortBy }}', 
@sortOrder='{{ sortOrder }}', 
@deleted={{ deleted }}, 
@limit='{{ limit }}', 
@offset='{{ offset }}'
;