glossary

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

Overview

Name	glossary
Type	Resource
Id	azure.purview_catalog.glossary

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_glossary	insert	endpoint		Create a glossary.
update_glossary_category	update	category_guid, endpoint		Update the given glossary category by its GUID.
update_glossary_term	update	term_guid, endpoint	includeTermHierarchy	Update the given glossary term by its GUID.
update_glossary	update	glossary_guid, endpoint		Update the given glossary.
delete_glossary_category	delete	category_guid, endpoint		Delete a glossary category.
delete_glossary_term	delete	term_guid, endpoint		Delete a glossary term.
delete_glossary	delete	glossary_guid, endpoint		Delete a glossary.
list_glossaries	exec	endpoint	limit, offset, sort, ignoreTermsAndCategories	Get all glossaries registered with Atlas.
list_related_categories	exec	category_guid, endpoint	limit, offset, sort	Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
list_category_terms	exec	category_guid, endpoint	limit, offset, sort	Get all terms associated with the specific category.
list_related_terms	exec	term_guid, endpoint	limit, offset, sort	Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
list_glossary_categories	exec	glossary_guid, endpoint	limit, offset, sort	Get the categories belonging to a specific glossary.
list_glossary_categories_headers	exec	glossary_guid, endpoint	limit, offset, sort	Get the category headers belonging to a specific glossary.
list_glossary_terms	exec	glossary_guid, endpoint	includeTermHierarchy, limit, offset, sort	Get terms belonging to a specific glossary.
list_glossary_term_headers	exec	glossary_guid, endpoint	limit, offset, sort	Get term headers belonging to a specific glossary.
list_terms_by_glossary_name	exec	glossary_name, endpoint	limit, offset, includeTermHierarchy	Get terms by glossary name.
get_glossary_category	exec	category_guid, endpoint		Get specific glossary category by its GUID.
get_glossary_term	exec	term_guid, endpoint	includeTermHierarchy	Get a specific glossary term by its GUID.
get_entities_assigned_with_term	exec	term_guid, endpoint	limit, offset, sort	Get all related objects assigned with the specified term.
assign_term_to_entities	exec	term_guid, endpoint		Assign the given term to the provided list of related objects.
remove_term_assignment_from_entities	exec	term_guid, endpoint		Delete the term assignment for the given list of related objects.
delete_term_assignment_from_entities	exec	term_guid, endpoint		Delete the term assignment for the given list of related objects.
get_glossary	exec	glossary_guid, endpoint		Get a specific Glossary by its GUID.
get_detailed_glossary	exec	glossary_guid, endpoint	includeTermHierarchy	Get a specific glossary with detailed information.
get_import_csv_operation_status	exec	operation_guid, endpoint		Get the status of import csv operation.
create_glossary_categories	exec	endpoint		Create glossary category in bulk.
create_glossary_category	exec	endpoint		Create a glossary category.
partial_update_glossary_category	exec	category_guid, endpoint		Update the glossary category partially.
create_glossary_term	exec	endpoint	includeTermHierarchy	Create a glossary term.
partial_update_glossary_term	exec	term_guid, endpoint	includeTermHierarchy	Update the glossary term partially.
create_glossary_terms	exec	endpoint	includeTermHierarchy	Create glossary terms in bulk.
partial_update_glossary	exec	glossary_guid, endpoint	includeTermHierarchy	Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.
export_glossary_terms_as_csv	exec	glossary_guid, endpoint	includeTermHierarchy	Export Glossary Terms as csv file.

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
category_guid	string	The globally unique identifier of the category.
endpoint	string	The service endpoint host (no scheme). (default: )
glossary_guid	string	The globally unique identifier for glossary.
glossary_name	string	The name of the glossary.
operation_guid	string	The globally unique identifier for async operation/job.
term_guid	string	The globally unique identifier for glossary term.
ignoreTermsAndCategories	boolean	Whether ignore terms and categories. Default value is False.
includeTermHierarchy	boolean	Whether include term hierarchy. Default value is False.
limit	integer	The page size - by default there is no paging. Default value is None.
offset	integer	The offset for pagination purpose. Default value is None.
sort	string	The sort order, ASC (default) or DESC. Default value is "ASC".

INSERT examples

create_glossary

Create a glossary.

INSERT INTO azure.purview_catalog.glossary (
endpoint
)
SELECT 
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: glossary
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the glossary resource.

UPDATE examples

update_glossary_category

Update the given glossary category by its GUID.

UPDATE azure.purview_catalog.glossary
SET 
-- No updatable properties
WHERE 
category_guid = '{{ category_guid }}' --required
AND endpoint = '{{ endpoint }}' --required;

update_glossary_term

Update the given glossary term by its GUID.

UPDATE azure.purview_catalog.glossary
SET 
-- No updatable properties
WHERE 
term_guid = '{{ term_guid }}' --required
AND endpoint = '{{ endpoint }}' --required
AND includeTermHierarchy = {{ includeTermHierarchy}};

update_glossary

Update the given glossary.

UPDATE azure.purview_catalog.glossary
SET 
-- No updatable properties
WHERE 
glossary_guid = '{{ glossary_guid }}' --required
AND endpoint = '{{ endpoint }}' --required;

DELETE examples

delete_glossary_category

Delete a glossary category.

DELETE FROM azure.purview_catalog.glossary
WHERE category_guid = '{{ category_guid }}' --required
AND endpoint = '{{ endpoint }}' --required
;

delete_glossary_term

Delete a glossary term.

DELETE FROM azure.purview_catalog.glossary
WHERE term_guid = '{{ term_guid }}' --required
AND endpoint = '{{ endpoint }}' --required
;

delete_glossary

Delete a glossary.

DELETE FROM azure.purview_catalog.glossary
WHERE glossary_guid = '{{ glossary_guid }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

list_glossaries

Get all glossaries registered with Atlas.

EXEC azure.purview_catalog.glossary.list_glossaries 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}', 
@ignoreTermsAndCategories={{ ignoreTermsAndCategories }}
;

list_related_categories

Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

EXEC azure.purview_catalog.glossary.list_related_categories 
@category_guid='{{ category_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

list_category_terms

Get all terms associated with the specific category.

EXEC azure.purview_catalog.glossary.list_category_terms 
@category_guid='{{ category_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

list_related_terms

Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

EXEC azure.purview_catalog.glossary.list_related_terms 
@term_guid='{{ term_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

list_glossary_categories

Get the categories belonging to a specific glossary.

EXEC azure.purview_catalog.glossary.list_glossary_categories 
@glossary_guid='{{ glossary_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

list_glossary_categories_headers

Get the category headers belonging to a specific glossary.

EXEC azure.purview_catalog.glossary.list_glossary_categories_headers 
@glossary_guid='{{ glossary_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

list_glossary_terms

Get terms belonging to a specific glossary.

EXEC azure.purview_catalog.glossary.list_glossary_terms 
@glossary_guid='{{ glossary_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }}, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

list_glossary_term_headers

Get term headers belonging to a specific glossary.

EXEC azure.purview_catalog.glossary.list_glossary_term_headers 
@glossary_guid='{{ glossary_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

list_terms_by_glossary_name

Get terms by glossary name.

EXEC azure.purview_catalog.glossary.list_terms_by_glossary_name 
@glossary_name='{{ glossary_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@includeTermHierarchy={{ includeTermHierarchy }}
;

get_glossary_category

Get specific glossary category by its GUID.

EXEC azure.purview_catalog.glossary.get_glossary_category 
@category_guid='{{ category_guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_glossary_term

Get a specific glossary term by its GUID.

EXEC azure.purview_catalog.glossary.get_glossary_term 
@term_guid='{{ term_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }}
;

get_entities_assigned_with_term

Get all related objects assigned with the specified term.

EXEC azure.purview_catalog.glossary.get_entities_assigned_with_term 
@term_guid='{{ term_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

assign_term_to_entities

Assign the given term to the provided list of related objects.

EXEC azure.purview_catalog.glossary.assign_term_to_entities 
@term_guid='{{ term_guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

remove_term_assignment_from_entities

Delete the term assignment for the given list of related objects.

EXEC azure.purview_catalog.glossary.remove_term_assignment_from_entities 
@term_guid='{{ term_guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

delete_term_assignment_from_entities

Delete the term assignment for the given list of related objects.

EXEC azure.purview_catalog.glossary.delete_term_assignment_from_entities 
@term_guid='{{ term_guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_glossary

Get a specific Glossary by its GUID.

EXEC azure.purview_catalog.glossary.get_glossary 
@glossary_guid='{{ glossary_guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_detailed_glossary

Get a specific glossary with detailed information.

EXEC azure.purview_catalog.glossary.get_detailed_glossary 
@glossary_guid='{{ glossary_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }}
;

get_import_csv_operation_status

Get the status of import csv operation.

EXEC azure.purview_catalog.glossary.get_import_csv_operation_status 
@operation_guid='{{ operation_guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_glossary_categories

Create glossary category in bulk.

EXEC azure.purview_catalog.glossary.create_glossary_categories 
@endpoint='{{ endpoint }}' --required
;

create_glossary_category

Create a glossary category.

EXEC azure.purview_catalog.glossary.create_glossary_category 
@endpoint='{{ endpoint }}' --required
;

partial_update_glossary_category

Update the glossary category partially.

EXEC azure.purview_catalog.glossary.partial_update_glossary_category 
@category_guid='{{ category_guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_glossary_term

Create a glossary term.

EXEC azure.purview_catalog.glossary.create_glossary_term 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }}
;

partial_update_glossary_term

Update the glossary term partially.

EXEC azure.purview_catalog.glossary.partial_update_glossary_term 
@term_guid='{{ term_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }}
;

create_glossary_terms

Create glossary terms in bulk.

EXEC azure.purview_catalog.glossary.create_glossary_terms 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }}
;

partial_update_glossary

Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.

EXEC azure.purview_catalog.glossary.partial_update_glossary 
@glossary_guid='{{ glossary_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }}
;

export_glossary_terms_as_csv

Export Glossary Terms as csv file.

EXEC azure.purview_catalog.glossary.export_glossary_terms_as_csv 
@glossary_guid='{{ glossary_guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }}
;