pyapacheatlas.core.collections.PurviewCollectionsClient.upload_entities#

PurviewCollectionsClient.upload_entities(batch: List[pyapacheatlas.core.entity.AtlasEntity], collection: str, batch_size: Optional[int] = None, api_version: str = '2022-03-01-preview')#

Creates or updates a batch of atlas entities in a purview collection.

See also https://docs.microsoft.com/en-us/rest/api/purview/catalogdataplane/collection/create-or-update-bulk

Parameters

  • batch (Union(dict, AtlasEntity, list(dict), list(AtlasEntity) )) – The batch of entities you want to upload. Supports a single dict, AtlasEntity, list of dicts, list of atlas entities.

  • collection (str) – Collection ID of the containing purview collection. Typically a 6-letter pseudo-random string such as “xcgw8s” which can be obtained e.g. by visual inspection in the purview web UI (https://web.purview.azure.com/).

  • batch_size (int) – The number of entities you want to send in bulk.

  • api_version (str) – The Purview API version to use.

Returns

An entity mutation response.

Return type

dict