datahub/docs/api/tutorials/applications.md

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Applications (Experimental - Beta Feature)

Why Would You Use Applications?

Applications are groupings of assets based on a particular purpose, similar to domains and data products. For more information on what an Application is, and how it differs from other concepts, refer to About DataHub Applications.

Goal Of This Guide

This guide will show you how to

• Create an application.
• Read the application attached to a dataset.
• Add a dataset to an application
• Remove the application from a dataset.

Prerequisites

For this tutorial, you need to deploy DataHub Quickstart and ingest sample data. For detailed steps, please refer to Datahub Quickstart Guide.

Create Application

mutation createApplication {
  createApplication(
    input: {
      properties: {
        name: "My New Application"
        description: "An optional description"
      }
    }
  )
}

If you see the following response, the operation was successful:

{
  "data": {
    "createApplication": "<application_urn>"
  },
  "extensions": {}
}

{{ inline /metadata-ingestion/examples/library/create_application.py show_path_as_comment }}

Expected Outcomes of Creating Applications

You can now see the applications under Applications sidebar section.

Read Applications

query {
  dataset(urn: "urn:li:dataset:(urn:li:dataPlatform:hive,fct_users_created,PROD)") {
    application {
      application {
        urn
        properties {
          name
          description
        }
      }
    }
  }
}

If you see the following response, the operation was successful:

{
  "data": {
    "dataset": {
      "application": {
        "application": {
          "urn": "urn:li:application:71b3bf7b-2e3f-4686-bfe1-93172c8c4e10",
          "properties": {
            "name": "Cancellation Processing"
          }
        }
      }
    }
  },
  "extensions": {}
}

Add Application

mutation batchSetApplication {
  batchSetApplication(
    input: {
      resourceUrns: [
        "urn:li:dataset:(urn:li:dataPlatform:bigquery,banking.public.customer,PROD)"
      ]
      applicationUrn: "urn:li:application:new-customer-signup"
    }
  )
}

If you see the following response, the operation was successful:

{
  "data": {
    "batchSetApplication": true
  },
  "extensions": {}
}

{{ inline /metadata-ingestion/examples/library/add_application.py show_path_as_comment }}

Expected Outcomes of Adding Application

You can now see the application has been added to the dataset.

Remove Applications

mutation batchSetApplication {
  batchSetApplication(
    input: {
      resourceUrns: [
        "urn:li:dataset:(urn:li:dataPlatform:bigquery,banking.public.customer,PROD)"
      ],
      applicationUrn: null
    }
  )
}

Expected Response:

{
  "data": {
    "batchSetApplication": true
  },
  "extensions": {}
}

{{ inline /metadata-ingestion/examples/library/remove_application.py show_path_as_comment }}