genai-toolbox/docs/en/resources/tools/postgres/postgres-list-locks.md at 1f9cd1b134dc60ea57a94cd72b93fabeffbefbe7

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

Files

Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369 )

This PR introduces a significant update to the Toolbox configuration
file format, which is one of the primary **breaking changes** required
for the implementation of the Advanced Control Plane.

# Summary of Changes
The configuration schema has been updated to enforce resource isolation
and facilitate atomic, incremental updates.
* Resource Isolation: Resource definitions are now separated into
individual blocks, using a distinct structure for each resource type
(Source, Tool, Toolset, etc.). This improves readability, management,
and auditing of configuration files.
* Field Name Modification: Internal field names have been modified to
align with declarative methodologies. Specifically, the configuration
now separates kind (general resource type, e.g., Source) from type
(specific implementation, e.g., Postgres).

# User Impact
Existing tools.yaml configuration files are now in an outdated format.
Users must eventually update their files to the new YAML format.

# Mitigation & Compatibility
Backward compatibility is maintained during this transition to ensure no
immediate user action is required for existing files.
* Immediate Backward Compatibility: The source code includes a
pre-processing layer that automatically detects outdated configuration
files (v1 format) and converts them to the new v2 format under the hood.
* [COMING SOON] Migration Support: The new toolbox migrate subcommand
will be introduced to allow users to automatically convert their old
configuration files to the latest format.

# Example
Example for config file v2:
```
kind: sources
name: my-pg-instance
type: cloud-sql-postgres
project: my-project
region: my-region
instance: my-instance
database: my_db
user: my_user
password: my_pass
---
kind: authServices
name: my-google-auth
type: google
clientId: testing-id
---
kind: tools
name: example_tool
type: postgres-sql
source: my-pg-instance
description: some description
statement: SELECT * FROM SQL_STATEMENT;
parameters:
- name: country
  type: string
  description: some description
---
kind: tools
name: example_tool_2
type: postgres-sql
source: my-pg-instance
description: returning the number one
statement: SELECT 1;
---
kind: toolsets
name: example_toolset
tools:
- example_tool
```

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Averi Kitsch <akitsch@google.com>

2026-01-27 16:58:43 -08:00

2.7 KiB

Raw Blame History

title, type, weight, description, aliases

title

type

weight

description

aliases

postgres-list-locks

docs

The "postgres-list-locks" tool lists active locks in the database, including the associated process, lock type, relation, mode, and the query holding or waiting on the lock.

/resources/tools/postgres-list-locks

About

The postgres-list-locks tool displays information about active locks by joining pg_stat_activity with pg_locks. This is useful to find transactions holding or waiting for locks and to troubleshoot contention.

Compatible sources:

This tool identifies all locks held by active processes showing the process ID, user, query text, and an aggregated list of all transactions and specific locks (relation, mode, grant status) associated with each process.

Query

The tool aggregates locks per backend (process) and returns the concatenated transaction ids and lock entries. The SQL used by the tool looks like:

SELECT
    locked.pid,
    locked.usename,
    locked.query,
    string_agg(locked.transactionid::text,':') as trxid,
    string_agg(locked.lockinfo,'||') as locks
FROM
    (SELECT
      a.pid,
      a.usename,
      a.query,
      l.transactionid,
      (l.granted::text||','||coalesce(l.relation::regclass,0)::text||','||l.mode::text)::text as lockinfo
    FROM
      pg_stat_activity a
      JOIN pg_locks l ON l.pid = a.pid  AND a.pid != pg_backend_pid()) as locked
GROUP BY 
    locked.pid, locked.usename, locked.query;

Example

kind: tools
name: list_locks
type: postgres-list-locks
source: postgres-source
description: "Lists active locks with associated process and query information."

Example response element (aggregated per process):

{
  "pid": 23456,
  "usename": "dbuser",
  "query": "INSERT INTO orders (...) VALUES (...);",
  "trxid": "12345:0",
  "locks": "true,public.orders,RowExclusiveLock||false,0,ShareUpdateExclusiveLock"
}

Reference

field	type	required	description
pid	integer	true	Process id (backend pid).
usename	string	true	Database user.
query	string	true	SQL text associated with the session.
trxid	string	true	Aggregated transaction ids for the process, joined by ':' (string). Each element is the transactionid as text.
locks	string	true	Aggregated lock info entries for the process, joined by '

2.7 KiB Raw Blame History

About

Query

Example

Reference

2.7 KiB

Raw Blame History