PyApacheAtlas Excel Configuration

PyApacheAtlas supports using Excel to do bulk uploads, creating type and classification definitions, updating lineage, and more. There are some default settings that help you get started quickly but you can also customize the excel spreadsheet somewhat.

Default Configuration and What Can Be Customized

Default Configuration and What Can Be Customized

Parameters for Excel Sheet Customization and Their Defaults
- bulkEntity_sheet: BulkEntities
- updateLineage_sheet: UpdateLineage
- columnMapping_sheet: ColumnMapping
- entityDef_sheet: EntityDefs
- classificationDef_sheet: ClassificationDefs
- table_sheet: TablesLineage
- column_sheet: FineGrainColumnLineage
Parameters for Excel Header Customization and Their Defaults
- source_prefix: Source
- target_prefix: Target
- process_prefix: Process
- column_transformation_name: transformation
  - This is used only for the FineGrainColumnLineage tab.
Parameters for Excel cell transformations
- value_separator: defaults to ; (semi-colon)
  - Breaks up experts column into an array on the BulkEntities tab.
  - Breaks up owners column into an array on the BulkEntities tab.
  - Breaks up [Relationship] meanings into an array on the BulkEntities tab.
  - Breaks up any column prefixed with [root] into an array on the BulkEntities tab.
    - e.g. [root] labels or [root] classifications
  - Breaks up entityTypes into an array in ClassificationDefs tab.
  - Breaks up superTypes into an array in ClassificationDefs tab.
  - Breaks up subTypes into an array in ClassificationDefs tab.

You can customize your Excel Template (manually) and then inform the ExcelReader by feeding the ExcelConfiguration the parameters and updated values.

Here's an example where you might...

Have a pipe delimiter for classifications / meanings.
Have a sheet called Sheet1 where you added the bulk entities to be uploaded.
You speak German so you updated the prefixes to be in German.

from pyapacheatlas.readers import ExcelConfiguration, ExcelReader

ec = ExcelConfiguration(
    value_separator = "|",
    bulkEntity_sheet = "Sheet1",
    source_prefix = "Quelle",
    target_prefix = "Ziel",
    process_prefix = "Prozess"

)

reader = ExcelReader(ec)

entities = reader.parse_bulk_entities("./some/file/path.xlsx")

# Assuming you've authenticated to your Purview or Atlas service
client.upload_entities(entities)

Learn more about the parse_* family of methods on the ExcelReader on the PyApacheAtlas Excel Support page.