Files
genai-toolbox/docs/en/resources/tools/postgres/postgres-list-sequences.md
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

2.4 KiB

title, type, weight, description, aliases
title type weight description aliases
postgres-list-sequences docs 1 The "postgres-list-sequences" tool lists sequences in a Postgres database.
/resources/tools/postgres-list-sequences

About

The postgres-list-sequences tool retrieves information about sequences in a Postgres database. It's compatible with any of the following sources:

postgres-list-sequences lists detailed information as JSON for all sequences. The tool takes the following input parameters:

  • sequence_name (optional): A text to filter results by sequence name. The input is used within a LIKE clause. Default: ""
  • schema_name (optional): A text to filter results by schema name. The input is used within a LIKE clause. Default: ""
  • limit (optional): The maximum number of rows to return. Default: 50.

Example

tools:
  list_indexes:
    kind: postgres-list-sequences
    source: postgres-source
    description: |
        Lists all the sequences in the database ordered by sequence name.
        Returns sequence name, schema name, sequence owner, data type of the
        sequence, starting value, minimum value, maximum value of the sequence,
        the value by which the sequence is incremented, and the last value
        generated by generated by the sequence in the current session.

The response is a json array with the following elements:

{
    "sequence_name": "sequence name",
    "schema_name": "schema name",
    "sequence_owner": "owner of the sequence",
    "data_type": "data type of the sequence",
    "start_value": "starting value of the sequence",
    "min_value": "minimum value of the sequence",
    "max_value": "maximum value of the sequence",
    "increment_by": "increment value of the sequence",
    "last_value": "last value of the sequence"
}

Reference

field type required description
kind string true Must be "postgres-list-sequences".
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.