How to create data contracts

πŸ§ͺ Preview feature! This feature is only available to select users for a limited period of time. The purpose of this closed preview is to allow participating users to experiment with the feature and provide valuable feedback. If you'd like to participate in the closed preview, reach out to your customer success manager for more information.

A data contract is an agreement between a data producer and consumer that specifies requirements for generating and using high-quality, reliable data. As a powerful tool for data management, data contracts can help you standardize contractual obligations between data producers and consumers, organize your assets with embeddable contract metadata, and enforce them with data quality rules.

In Atlan, you can directly add a data contract to supported assets and provide helpful context to your downstream users.

For a data contract to help build trust in your assets, it should be:

  • Templatized and easily comprehensible β€” use Atlan's YAML contract template to create standardized contracts and push to Atlan.
  • Version-controlled β€” continuously validate and monitor your data contracts either in runtime or real-time.
  • Embeddable β€” embed the contract as metadata for a supported asset.
  • Enforceable β€” enforce your contracts with data quality rules.
  • Extensible β€” identify new specifications, generate new versions, and then compare and contrast them.

Supported asset types

You can create data contracts for the following asset types:

Create a data contract

πŸ€“ Who can do this? Any non-guest user with edit access to an asset's metadata can create, deploy, and manage data contracts. This only includes admin and member users.

To add a data contract in Atlan, you can either:

  • Use Atlan CLI to push already created contracts from your local machine to Atlan directly or through your CI/CD pipeline.
  • Use Atlan CLI to create a data contract using Atlan's contract template and then push it to Atlan directly or through your CI/CD pipeline.

Once created, you will be able to monitor and manage your data contracts in Atlan.

Install Atlan CLI

Atlan CLI is a command-line tool that you can download directly from Atlan to your local machine to create and push data contracts to Atlan.

To install Atlan CLI:

  1. From the left menu of any screen in Atlan, click Assets.
  2. (Optional) From the Filters menu on the left, click Properties and then click Has contract. Click No to filter for assets without a contract.
  3. From the Assets page, select an asset to open the asset sidebar.
  4. From the left Overview sidebar, click Add contract.
  5. In the Contract tab of the asset profile, for Install Atlan CLI, click the Install Atlan CLI button to download and install it.
  6. Once you have downloaded Atlan CLI, refer to our developer documentation to configure Atlan CLI in your CI/CD pipeline or local terminal.

Create a data contract

To create a data contract:

  1. For Create data contract, click the clipboard icon to create a new contract using Atlan CLI. Paste the command in your CI/CD platform or local terminal to get started.
  2. Refer to our developer documentation to initialize a new data contract for a selected asset in Atlan.

Push a data contract

To push a data contract to Atlan:

  1. For Push data contract, click the clipboard icon to push a contract to Atlan from your local machine using Atlan CLI or set up a CI/CD process to automate it.
  2. Refer to our developer documentation to push a data contract to a selected asset in Atlan.

View a data contract

To view a data contract:

  1. From the left menu of any screen in Atlan, click Assets.
  2. From the Assets page, select an asset to open the asset sidebar.
  3. From the left Overview sidebar, click View contract to navigate to the Contracts tab in the asset profile.
  4. In the Contract tab, you can view the contract specifications for your asset in a YAML format:
    • Next to Specifications, click the version button to view the latest version of the contract. Click Compare older versions to compare them Side by side or in an Overlay layout.
    • Click the pencil icon to edit the contract using Atlan CLI.
    • Click the clipboard icon to copy the YAML code.
    • Under Timeline, view a timeline for the evolution of your contract.
    • Under Summary, view details of who last updated your contract and when.

Related articles

Was this article helpful?
0 out of 0 found this helpful