AtlasClient for Apache Atlas

AtlasClient(endpoint_url[, authentication])

Provides communication between your application and the Apache Atlas server with your entities and type definitions.

The AtlasClient is meant for Apache Atlas users to interact with Apache Atlas. It implements nearly all of the Apache Atlas API endpoints. Some of the APIs are separated into other clients. For the AtlasClient, there is a GlossaryClient that provides access to the Glossary API endpoints.

AtlasClient.get_entity([guid, …])	Retrieve one or many guids from your Atlas backed Data Catalog.
AtlasClient.get_single_entity([guid, …])	Retrieve one entity based on guid from your Atlas backed Data Catalog.
AtlasClient.get_entity_header([guid])	Retrieve one or many entity headers from your Atlas backed Data Catalog.
AtlasClient.upload_entities(batch[, batch_size])	Upload entities to your Atlas backed Data Catalog.
AtlasClient.partial_update_entity([guid, …])	Partially update an entity without having to construct the entire object and its subsequent required attributes.
AtlasClient.delete_entity([guid, …])	Delete one or many entities from your Apache Atlas server.
AtlasClient.get_relationship(guid)	Retrieve the relationship attribute for the given guid.
AtlasClient.upload_relationship(relationship)	Upload a AtlasRelationship json. Should take the form of the following::.
AtlasClient.delete_relationship(guid)	Delete a relationship based on the guid.
AtlasClient.get_all_typedefs()	Retrieve all of the type defs available on the Apache Atlas server.
AtlasClient.get_typedef([type_category, …])	Retrieve a single type def based on its guid, name, or type category and (guid or name).
AtlasClient.upload_typedefs([typedefs, …])	Provides a way to upload a single or multiple type definitions.
AtlasClient.delete_type(name)	Delete a type based on the given name.
AtlasClient.delete_typedefs(**kwargs)	Delete one or many types.
AtlasClient._get_typedefs_header()	Get the array of AtlasTypeDefHeader that contains category, guid, name, and serviceType.
AtlasClient.get_entity_classification(guid, …)	Retrieve a specific entity from the given entity’s guid.
AtlasClient.get_entity_classifications(guid)	Retrieve all classifications from the given entity’s guid.
AtlasClient.classify_bulk_entities(…)	Given a single classification, you want to apply it to many entities and you know their guid.
AtlasClient.classify_entity(guid, …[, …])	Given a single entity, you want to apply many classifications.
AtlasClient._classify_entity_adds(guid, …)	Update a given entity guid with the provided classifications.
AtlasClient._classify_entity_updates(guid, …)	Update a given entity guid with the provided classifications.
AtlasClient.declassify_entity(guid, …)	Given an entity guid and a classification name, remove the classification from the given entity.
AtlasClient.update_businessMetadata(guid, …)	Update the business metadata.
AtlasClient.delete_businessMetadata(guid, …)	Delete one or many business attributes based on the guid.
AtlasClient.get_entity_lineage(guid[, …])	Gets lineage info about the specified entity by guid.
AtlasClient.get_glossary([name, guid, detailed])	AtlasClient.get_glossary is being deprecated.
AtlasClient.get_glossary_term([guid, name, …])	AtlasClient.get_glossary_term is being deprecated.
AtlasClient.upload_terms(batch[, force_update])	AtlasClient.upload_terms is being deprecated.
AtlasClient.get_termAssignedEntities([…])	AtlasClient.get_termAssignedEntities is being deprecated.
AtlasClient.assignTerm(entities[, termGuid, …])	AtlasClient.assignTerm is being deprecated.
AtlasClient.delete_assignedTerm(entities[, …])	AtlasClient.delete_assignedTerm is being deprecated.
AtlasClient.update_entity_labels(labels[, …])	Update the given labels for one entity.
AtlasClient.delete_entity_labels(labels[, …])	Delete the given labels for one entity.