genai-toolbox/docs/en/resources/tools/postgres/postgres-list-views.md at da48d6b355605eec43dfedbb47bf8a7ff4868520

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-05 12:45:11 -05:00

Files

Srividya Reddy 489117d747 feat(tools/postgres)!: Add additional filter params for existing postgres tools (#2033 )

## Description

Add additional filter parameters for existing PostgreSQL tools:

1.  `list_views`:
- Add a new optional `"schema_name"` filter parameter to return results
based on a specific schema name pattern.
- Add an additional column `"definition"` to return the view definition.
2.  `list_schemas`:
- Add a new optional `"owner"` filter parameter to return results based
on a specific owner name pattern.
- Add a new optional `"limit"` parameter to return a specific number of
rows.
3.  `list_indexes`:
- Add a new optional `"only_unused"` filter parameter to return only
unused indexes.

> Should include a concise description of the changes (bug or feature),
it's
> impact, along with a summary of the solution

list_views
<img width="1531" height="763" alt="Screenshot 2025-11-25 at 1 36 39 PM"
src="https://github.com/user-attachments/assets/bd6805b3-43d2-46c7-adc8-62d3a4521d36"
/>

list_schemas
<img width="1519" height="755" alt="Screenshot 2025-11-25 at 1 35 54 PM"
src="https://github.com/user-attachments/assets/62d3e987-b64e-442b-ba1a-84def1df7a58"
/>


list_indexes
<img width="1523" height="774" alt="Screenshot 2025-11-25 at 1 35 32 PM"
src="https://github.com/user-attachments/assets/c6f73b3f-f8a2-4b76-9218-64d7011a2241"
/>


## PR Checklist

> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
  before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #<1738>

Co-authored-by: Averi Kitsch <akitsch@google.com>

2025-12-09 20:16:45 +00:00

1.6 KiB

Raw Blame History

title, type, weight, description, aliases

title

type

weight

description

aliases

postgres-list-views

docs

The "postgres-list-views" tool lists views in a Postgres database, with a default limit of 50 rows.

/resources/tools/postgres-list-views

About

The postgres-list-views tool retrieves a list of top N (default 50) views from a Postgres database, excluding those in system schemas (pg_catalog, information_schema). It's compatible with any of the following sources:

postgres-list-views lists detailed view information (schemaname, viewname, ownername, definition) as JSON for views in a database. The tool takes the following input parameters:

view_name (optional): A string pattern to filter view names. Default: ""
schema_name (optional): A string pattern to filter schema names. Default: ""
limit (optional): The maximum number of rows to return. Default: 50.

Example

tools:
  list_views:
    kind: postgres-list-views
    source: cloudsql-pg-source

Reference

field	type	required	description
kind	string	true	Must be "postgres-list-views".
source	string	true	Name of the source the SQL should execute on.
description	string	false	Description of the tool that is passed to the agent.

1.6 KiB Raw Blame History

About

Example

Reference

1.6 KiB

Raw Blame History