dataplex-list-data-products

A “dataplex-list-data-products” tool allows to list data products.

2 minute read

About

A dataplex-list-data-products tool lists all Data Products in Knowledge Catalog (formerly known as Dataplex) across all locations (globally).

View the Data Products usage guide for more information.

This tool can be used with the following database sources:

Source Name
Knowledge Catalog (formerly known as Dataplex) Source

Knowledge Catalog uses Identity and Access Management (IAM) to control user and group access to Knowledge Catalog resources. Toolbox will use your Application Default Credentials (ADC) to authorize and authenticate when interacting with Knowledge Catalog.

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the correct IAM permissions for the tasks you intend to perform. See Knowledge Catalog IAM permissions and Knowledge Catalog IAM roles for more information on applying IAM permissions and roles to an identity.

The dataplex-list-data-products tool has the following optional parameters:

field	type	required	description
filter	string	false	Filter string to list data products. Based on the AIP-160 proposal. Use ‘=’ for exact, and ‘:’ for contains matching. String literals must be enclosed within “”. Matching accross all fields at once is not yet supported. E.g. “display_name:"my-product"”
pageSize	integer	false	Number of returned data products in the page. Defaults to `10`.
orderBy	string	false	Specifies the ordering of results.

kind: tool
name: list_data_products
type: dataplex-list-data-products
source: my-dataplex-source
description: Use this tool to list Data Products.

field	type	required	description
type	string	true	Must be “dataplex-list-data-products”.
source	string	true	Name of the source the tool should execute on.
description	string	true	Description of the tool that is passed to the LLM.

Was this page helpful?

Sorry to hear that. Please tell us how we can improve.