dataplex-search-entries Tool
2 minute read
About
A dataplex-search-entries tool returns all entries in Dataplex Catalog (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:
pageSize- Number of results in the search page. Defaults to5.orderBy- Specifies the ordering of results. Supported values are: relevance (default), last_modified_timestamp, last_modified_timestamp asc.
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| Dataplex Source |
Requirements
IAM Permissions
Dataplex uses Identity and Access Management (IAM) to control user and group access to Dataplex resources. Toolbox will use your Application Default Credentials (ADC) to authorize and authenticate when interacting with Dataplex.
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 Dataplex Universal Catalog IAM permissions and Dataplex Universal Catalog IAM roles for more information on applying IAM permissions and roles to an identity.
Example
kind: tools
name: dataplex-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
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “dataplex-search-entries”. |
| 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. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.