v5.0.1

🎉 New Features

• Added support for the MatchPhase query.

🐞 Bug Fixes

• Fixed handling of aggregations in AuditSearchResults.
• Added Asset.TYPE_NAME condition in FluentSearch for append terms, replace terms, and remove terms methods to ensure an exact asset match. Previously, only Asset.GUID/QUALIFIED_NAME was used, which could return multiple assets if different asset types had the same qualified name.

🥗 QOL Improvements

• Bumped ruff to the latest version (0.9.9).
• Removed redundant asset relationship fields.
• Updated the "Installing for Development" section in README.md.

Full Changelog: 5.0.0...5.0.1

v5.0.0

🎉 New Features

• Added a new method DataProduct.get_assets() that retrieves a list of all assets linked to the provided data product.
• Made DSL.query and DSL.post_filter more flexible to accept both raw dictionaries and Python objects, i.e: Optional[Union[Dict[str, Any], Query]]. This change allows users to construct DSL objects directly with raw DSL dictionaries, e.g: DSL(**raw_dsl).
• Added creator_with_prefix() methods to GCSObject and ADLSObject.
• Added a model utility method (construct_object_key()) to construct a consistent objectKey for object store assets, which is currently used by creator_with_prefix().

🐞 Bug Fixes

• Fixed the creator_with_prefix() method to use an empty prefix "" (representing the root path) for object store assets.
• Fixed SearchLogResults edge cases — when entityGuidsAll is empty [] or "undefined" in the request DSL.

🥗 QOL Improvements

• Generated the latest typedef models.
• Upgraded SDK dependencies (main, dev, and tooling) to the latest versions.
• Replaced the existing linter and formatter stack (black, flake8, isort, autoflake8) with ruff, significantly reducing development and QA check times while consolidating all configurations into a single file.

⛑️ Breaking Changes

• bucket_name and adls_container_name are now mandatory for GCSObject.creator() and ADLSObject.creator(), respectively.
• Changed the default behavior for tag propagation to False by default. This means:
  • remove_propagations_on_entity_delete is now True by default.
  • propagate, restrict_propagation_through_lineage, and restrict_propagation_through_hierarchy are now False by default.

Full Changelog: 4.2.5...5.0.0

v4.2.5

🎉 New Features

• Added the SDK version number to AtlanClient debug logging.
• Added handling of the errorCause property to AtlanError.
• Added creator() methods for Quicksight assets.
• Added support for new connector types:
  • KX
  • CRATEDB

🥗 QOL Improvements

• Updated GitHub Actions to the latest version.
• Fixed broken integration tests for adding, replacing, and removing glossary terms.
• Added a new job to the pyatlan-publish.yml workflow to publish the SDK image to Docker Hub.
• Introduced dependabot.yml to manage dependencies and actions, and removed unused secret variables.

Full Changelog: 4.2.4...4.2.5

v4.2.4

🐞 Bug Fixes

• Added safeguards for search pagination methods.

Full Changelog: 4.2.3...4.2.4

v4.2.3

🥗 QOL Improvements

• Refactored the Asset._convert_to_real_type_() method for improved clarity and robustness.
  In certain cases, asset types may be undefined or invalid — likely due to an unhandled backend edge case. To handle this gracefully, the method now ignores deserialization of Asset API responses in such scenarios instead of raising AttributeError or TypeError exceptions.

Full Changelog: 4.2.2...4.2.3

v4.2.2

🎉 New Features

• Added support for AnaplanSystemDimension.creator().
• Added support for new connector types:
  • RDS
  • SHARE_POINT
  • SHARED_DRIVE

🥗 QOL Improvements

• Generated the latest typedef models.
• Upgraded pre-commit black to 24.4.2
• Enhanced Credential.creator() validation to prevent creating fake credentials when test=False.

Full Changelog: 4.2.1...4.2.2

v4.2.1

🎉 New Features

• Added an optional boolean parameter (test=True) to CredentialClient.creator() method.

Full Changelog: 4.2.0...4.2.1

v4.2.0

🎉 New Features

• Added support for ApplicationField.creator().
• Added support for CredentialClient.creator() and CredentialClient.purge_by_guid().
• Added support for optional parameters (host and port) in Connection.creator().

⛑️ Breaking Changes

• Changed the default setting for tracking IndexSearch logs (save_search_log=False). Previously, it was set to True, which was causing frequent Out of Memory (OOM) issues in Metastore pods.

🥗 QOL Improvements

• Generated the latest typedef models.
• Refactored OpenLineageClient.create_connection() to use the new CredentialClient.creator().

Full Changelog: 4.1.0...4.2.0

v4.1.0

🎉 New Features

• Added support for the following workflow packages:

  Connectors

  • OracleCrawler

  Utilities

  • LineageBuilder
  • LineageGenerator
  • APITokenConnectionAdmin

• Extended the WorkflowClient.run() method to accept raw workflow JSON strings.

🐞 Bug Fixes

• Updated the maximum API token Time-to-Expire (TTE) to 5 years. Previously, the value was set to 13 years (409,968,000 seconds), which was reverted to 5 years due to an integer overflow issue in Keycloak. For more details, see Keycloak Issue #19671.

🥗 QOL Improvements

• Added support for Python 3.10, 3.11, 3.12 and 3.13.
• Increased the default read timeout for AtlanClient to 900 seconds (15 minutes).

Full Changelog: 4.0.2...4.1.0

v4.0.2

🎉 New Features

• Added the ability to the custom package logger to log unhandled exceptions.
• Added support for creating OpenLineage connections (OpenLineageClient.create_connection()).

🐞 Bug Fixes

• Fixed handling of deleted AtlanTagNames in Purpose asset deserialization. Previously, a ValueError was raised.

🥗 QOL Improvements

• Added an "Installing for development" section to the README.md.
• Removed pyatlan-codeql.yaml in favor of using the organization-level CodeQL workflow to avoid configuration conflicts and failures.

Full Changelog: 4.0.1...4.0.2