pyapacheatlas.core.client.AtlasClient#
- class pyapacheatlas.core.client.AtlasClient(endpoint_url, authentication=None, **kwargs)#
Provides communication between your application and the Apache Atlas server with your entities and type definitions.
- Parameters
endpoint_url (str) – The http url for communicating with your Apache Atlas server. It will most likely end in /api/atlas/v2.
authentication (
AtlasAuthBase) – The method of authentication.
- Kwargs:
- param requests_*
Kwargs to pass to the underlying requests package method call. For example passing requests_verify = False will supply verify=False to any API call.
- __init__(endpoint_url, authentication=None, **kwargs)#
Methods
__init__(endpoint_url[, authentication])assignTerm(entities[, termGuid, termName, …])AtlasClient.assignTerm is being deprecated.
classify_bulk_entities(entityGuids, …)Given a single classification, you want to apply it to many entities and you know their guid.
classify_entity(guid, classifications[, …])Given a single entity, you want to apply many classifications.
declassify_entity(guid, classificationName)Given an entity guid and a classification name, remove the classification from the given entity.
delete_assignedTerm(entities[, termGuid, …])AtlasClient.delete_assignedTerm is being deprecated.
delete_businessMetadata(guid, businessMetadata)Delete one or many business attributes based on the guid.
delete_entity([guid, qualifiedName, typeName])Delete one or many entities from your Apache Atlas server.
delete_entity_labels(labels[, guid, …])Delete the given labels for one entity.
delete_relationship(guid)Delete a relationship based on the guid.
delete_type(name)Delete a type based on the given name.
delete_typedefs(**kwargs)Delete one or many types.
generate_request_headers([include, exclude])Retrieve all of the type defs available on the Apache Atlas server.
get_entity([guid, qualifiedName, typeName, …])Retrieve one or many guids from your Atlas backed Data Catalog.
get_entity_classification(guid, …)Retrieve a specific entity from the given entity’s guid.
Retrieve all classifications from the given entity’s guid.
get_entity_header([guid])Retrieve one or many entity headers from your Atlas backed Data Catalog.
get_entity_lineage(guid[, depth, width, …])Gets lineage info about the specified entity by guid.
get_glossary([name, guid, detailed])AtlasClient.get_glossary is being deprecated.
get_glossary_term([guid, name, …])AtlasClient.get_glossary_term is being deprecated.
get_relationship(guid)Retrieve the relationship attribute for the given guid.
get_single_entity([guid, …])Retrieve one entity based on guid from your Atlas backed Data Catalog.
get_termAssignedEntities([termGuid, …])AtlasClient.get_termAssignedEntities is being deprecated.
get_typedef([type_category, guid, name])Retrieve a single type def based on its guid, name, or type category and (guid or name).
partial_update_entity([guid, typeName, …])Partially update an entity without having to construct the entire object and its subsequent required attributes.
search_entities(query[, limit, …])Search entities based on a query and automaticall handles limits and offsets to page through results.
update_businessMetadata(guid, businessMetadata)Update the business metadata.
update_entity_labels(labels[, guid, …])Update the given labels for one entity.
upload_entities(batch[, batch_size])Upload entities to your Atlas backed Data Catalog.
upload_relationship(relationship)Upload a AtlasRelationship json. Should take the form of the following::.
upload_terms(batch[, force_update])AtlasClient.upload_terms is being deprecated.
upload_typedefs([typedefs, force_update])Provides a way to upload a single or multiple type definitions.