dataplex-search-entries

About

A dataplex-search-entries tool returns all entries in Knowledge Catalog (formerly known as Dataplex) (e.g. tables, views, models) that matches given user query.

dataplex-search-entries takes a required query parameter based on which entries are filtered and returned to the user. It also optionally accepts following parameters:

• scope - A scope limits the search space to a particular project or organization. It must be in the format: organizations/<org_id> or projects/<project_id> or projects/<project_number>.
• pageSize - Number of results in the search page. Defaults to 5.
• orderBy - Specifies the ordering of results. Supported values are: relevance (default), last_modified_timestamp, last_modified_timestamp asc.

Compatible Sources

{{< compatible-sources >}}

Requirements

IAM Permissions

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.

Example

kind: tool
name: search_entries
type: dataplex-search-entries
source: my-dataplex-source
description: Use this tool to get all the entries based on the provided query.

Reference