wehub-resource-sync
e04ed9c211
CF: Deploy Dev Docs / deploy (push) Has been cancelled
Sync Labels / build (push) Has been cancelled
tests / unit tests (macos-latest) (push) Has been cancelled
tests / unit tests (windows-latest) (push) Has been cancelled
tests / unit tests (ubuntu-latest) (push) Has been cancelled
53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
---
|
|
title: "postgres-database-overview"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
The "postgres-database-overview" fetches the current state of the PostgreSQL server.
|
|
---
|
|
|
|
## About
|
|
|
|
The `postgres-database-overview` fetches the current state of the PostgreSQL
|
|
server.
|
|
|
|
`postgres-database-overview` fetches the current state of the PostgreSQL server
|
|
This tool does not take any input parameters.
|
|
|
|
## Compatible Sources
|
|
|
|
{{< compatible-sources others="integrations/alloydb, integrations/cloud-sql-pg">}}
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: tool
|
|
name: database_overview
|
|
type: postgres-database-overview
|
|
source: cloudsql-pg-source
|
|
description: |
|
|
fetches the current state of the PostgreSQL server. It returns the postgres version, whether it's a replica, uptime duration, maximum connection limit, number of current connections, number of active connections and the percentage of connections in use.
|
|
```
|
|
|
|
The response is a JSON object with the following elements:
|
|
|
|
```json
|
|
{
|
|
"pg_version": "PostgreSQL server version string",
|
|
"is_replica": "boolean indicating if the instance is in recovery mode",
|
|
"uptime": "interval string representing the total server uptime",
|
|
"max_connections": "integer maximum number of allowed connections",
|
|
"current_connections": "integer number of current connections",
|
|
"active_connections": "integer number of currently active connections",
|
|
"pct_connections_used": "float percentage of max_connections currently in use"
|
|
}
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-------------|:--------:|:------------:|------------------------------------------------------|
|
|
| type | string | true | Must be "postgres-database-overview". |
|
|
| 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. |
|