Data Dictionary

• Models
  • DataDictionaryItem
  • DataDictionaryAsyncTaskDetails
  • DataDictionaryTaskDetails
  • DataDictionaryTaskError
• Methods
  • upload_data_dictionary(object_type, object_id, payload)

Models

DataDictionaryItem

Payload helper used with upload_data_dictionary to describe the multipart form data required by the API.

Key attributes:

Name	Required	Type	Description
overwrite_values	TRUE	bool	When true, values in Alation are overwritten by the upload.
allow_reset	FALSE	bool	Reset existing values when the file contains blank entries. Only used when overwrite_values is true.
file	TRUE	Path | bytes | file-like	The CSV/TSV file contents to upload.
file_name	FALSE	str	Overrides the filename sent in the multipart request.
content_type	FALSE	str	MIME type of the uploaded file. Defaults to text/csv.

DataDictionaryAsyncTaskDetails

Represents the asynchronous task created when a data dictionary upload is accepted. Use task.links for follow-up requests.

DataDictionaryTaskDetails

Describes the status of an upload task, including progress information and the final result once the task completes.

DataDictionaryTaskError

Represents a single error emitted during processing. Inspect the nested details attribute for the affected record range.

Methods

upload_data_dictionary(object_type, object_id, payload)

Upload a data dictionary file for a supported catalog object. Returns JobDetails describing the asynchronous task.

payload = allie.DataDictionaryItem(
    overwrite_values=True,
    allow_reset=False,
    file="/path/to/dictionary.csv",
)

alation.data_dictionary.upload_data_dictionary("data", 5, payload)