Atlas Glossary Methods#

GlossaryClient for Apache Atlas#

GlossaryClient(endpoint_url, authentication, …)

GlossaryClient.get_glossary([name, guid, …])

Retrieve the specified glossary by name or guid along with the term headers (AtlasRelatedTermHeader: including displayText and termGuid).

GlossaryClient.get_glossaries([limit, …])

Retrieve all glossaries and the term headers.

GlossaryClient.get_term([guid, name, …])

Retrieve a single glossary term based on its guid.

GlossaryClient.upload_term(term[, force_update])

Upload a single term to Apache Atlas.

GlossaryClient.upload_terms(terms[, …])

Upload a multiple terms to Apache Atlas.

GlossaryClient.get_termAssignedEntities([…])

Page through the assigned entities for the given term.

GlossaryClient.assignTerm(entities[, …])

Assign a single term to many entities.

GlossaryClient.delete_assignedTerm(entities)

Remove a single term from many entities.

GlossaryClient.delete_term(termGuid)

Delete a term based on the termGuid :param str termGuid: The guid for the term.

PurviewGlossaryClient#

PurviewGlossaryClient(endpoint_url, …)

PurviewGlossaryClient.get_glossary([name, …])

Retrieve the specified glossary by name or guid along with the term headers (AtlasRelatedTermHeader: including displayText and termGuid).

PurviewGlossaryClient.get_glossaries([…])

Retrieve all glossaries and the term headers.

PurviewGlossaryClient.get_term([guid, name, …])

Retrieve a single glossary term based on its guid.

PurviewGlossaryClient.upload_term(term[, …])

Upload a single term to Azure Purview.

PurviewGlossaryClient.upload_terms(terms[, …])

Upload many terms to Azure Purview.

PurviewGlossaryClient.get_termAssignedEntities([…])

Page through the assigned entities for the given term.

PurviewGlossaryClient.assignTerm(entities[, …])

Assign a single term to many entities.

PurviewGlossaryClient.delete_assignedTerm(…)

Remove a single term from many entities.

PurviewGlossaryClient.delete_term(termGuid)

Delete a term based on the termGuid :param str termGuid: The guid for the term.

PurviewGlossaryClient.import_terms(csv_path)

Bulk import terms from an existing csv file.

PurviewGlossaryClient.import_terms_status(…)

Get the operation status of a glossary term import activity.

PurviewGlossaryClient.export_terms(guids, …)

Export specific terms as provided by guid.