Manage data products¶
Create a new data product¶
To create a new data product:
Create a data product | |
---|---|
1 2 3 4 5 6 7 8 9 |
|
- When defining a data product, you must define the assets within it. These are defined through a search, so that the assets included can be automatically managed. In this example, we are selecting all verified tables that have a tag of
Marketing
. - You must provide a human-readable name for your data product.
- You must also provide the domain in which the data product should exist.
- And finally the search that was defined earlier, to define which assets to include in the data product.
- You then need to build the object.
- And then you can
save()
the object you've built to create the new data product in Atlan.
Create a data product | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
|
- When defining a data product, you must define the assets within it. These are defined through a search, so that the assets included can be automatically managed. In this example, we are selecting all verified tables that have a tag of
Marketing
. - You must provide a human-readable name for your data product.
- You must provide the index search request that was defined earlier, to define which assets to include in the data product.
- You must also provide the domain in which the data product should exist.
- And then you can
save()
the object you've built to create the new data product in Atlan.
Create a data product | |
---|---|
1 2 3 4 5 6 7 8 9 |
|
- When defining a data product, you must define the assets within it. These are defined through a search, so that the assets included can be automatically managed. In this example, we are selecting all verified tables that have a tag of
Marketing
. - You must provide a human-readable name for your data product.
- You must also provide the domain in which the data product should exist.
- And finally the search that was defined earlier, to define which assets to include in the data product.
- You then need to build the object.
- And then you can
save()
the object you've built to create the new data product in Atlan.
POST /api/meta/entity/bulk | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|
- The
typeName
must be exactlyDataProduct
. - Provide a human-readable name for your data product.
- Ensure the
qualifiedName
follows the pattern:<parentDomainQualifiedName>/product/<lowerCamelCaseName>
. - Provide a
parentDomainQualifiedName
for the data domain under which you want to create this product. - Provide a
superDomainQualifiedName
for the data domain under which you want to create this product. If creating a product under sub-domains, this should be the qualified name of the root-level domain. -
Provide the DSL that defines the assets to include in the data product as an embedded JSON string.
Use SDK to create data products
The above data products assets DSL requires a filter as a nested object construct within an outer bool, rather than a list or array. It's recommended to create data products via SDK as it handles this complexity automatically.
-
Specify the default playbook filter to define which assets are shown in the data product UI.
- Specify the
qualifiedName
of the data domain under which you want to create this product.
Retrieve a data product¶
To retrieve a data product, use its qualified name:
Retrieve a data product by its qualifiedName | |
---|---|
1 |
|
- If no exception is thrown, the returned object will be a non-null data domain.
Retrieve an data product by its qualifiedName | |
---|---|
1 2 3 4 5 6 7 8 9 |
|
- If no exception is thrown, the returned object will be non-null and of the type requested.
Retrieve a data product by its qualifiedName | |
---|---|
1 |
|
- If no exception is thrown, the returned object will be a non-null data domain.
GET /api/meta/entity/uniqueAttribute/type/DataProduct/attr:qualifiedName=default/product/marketingInfluence&ignoreRelationships=false&minExtInfo=false | |
---|---|
1 |
|
- In the case of retrieving an asset, all necessary information is included in the URL of the request. There is no payload for the body of the request.
Update a data product¶
To update a data product:
Update a data product | |
---|---|
1 2 3 4 5 |
|
- Use the
updater()
method to update a data product, providing thequalifiedName
and name of the data product. - You can chain onto the updater any other enrichment, for example changing the product's description.
- You then need to build the object.
- You can then
save()
the object you've built to update the data product in Atlan.
Update a data product | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 |
|
- Use the
create_for_modification()
method to update a data product. - You must provide the
qualifiedName
of the data product. - You must provide the
name
of the data product. - You can then add on any other updates, such as changing the user description of the data product.
- To update the data product in Atlan, call the
save()
method with the object you've built.
Update a data product | |
---|---|
1 2 3 4 5 |
|
- Use the
updater()
method to update a data product, providing thequalifiedName
and name of the data product. - You can chain onto the updater any other enrichment, for example changing the product's description.
- You then need to build the object.
- You can then
save()
the object you've built to update the data product in Atlan.
POST /api/meta/entity/bulk | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 |
|
- The
typeName
must be exactlyDataProduct
. - Human-readable name for your data product.
- You must provide the the
qualifiedName
of the data product to update. - You can add on any other updates, such as changing the user description of the data product.
Delete a data product¶
Soft-delete (archive)¶
To soft-delete, or archive, a data product:
Delete a data product | |
---|---|
1 |
|
- To archive a data product in Atlan, call the
DataProduct.delete()
method with the GUID of the data product.
Delete a data product | |
---|---|
1 2 3 4 5 |
|
- To archive a data product in Atlan, call the
asset.delete_by_guid()
method with the GUID of the data product.
Delete a data product | |
---|---|
1 |
|
- To archive a data product in Atlan, call the
DataProduct.delete()
method with the GUID of the data product.
DELETE /api/meta/entity/bulk?guid=218c8144-dc39-43a5-b0c0-9eeb4d11e74a&deleteType=SOFT | |
---|---|
1 |
|
- All the details for deleting the data product are specified in the URL directly. Note that you must provide the GUID of the data product to delete it.
Hard-delete (purge)¶
To permanently delete (purge) a data product:
Delete a data product | |
---|---|
1 |
|
- To permanently delete a data product in Atlan, call the
DataProduct.purge()
method with the GUID of the data product.
Delete a product | |
---|---|
1 2 3 4 5 |
|
- To permanently delete a data product in Atlan, call the
asset.purge_by_guid()
method with the GUID of the data product.
Delete a data product | |
---|---|
1 |
|
- To permanently delete a data product in Atlan, call the
DataProduct.purge()
method with the GUID of the data product.
DELETE /api/meta/entity/bulk?guid=218c8144-dc39-43a5-b0c0-9eeb4d11e74a&deleteType=PURGE | |
---|---|
1 |
|
- All the details for deleting the data product are specified in the URL directly. Note that you must provide the GUID of the data product to delete it.