PostgreSQL Source
PostgreSQL is a powerful, open source object-relational database.
3 minute read
About
PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.
Available Tools
PostgreSQL Source Tools
| Tool Name | Description |
|---|---|
| postgres-database-overview | The "postgres-database-overview" fetches the current state of the PostgreSQL server. |
| postgres-execute-sql | A "postgres-execute-sql" tool executes a SQL statement against a Postgres database. |
| postgres-get-column-cardinality | The "postgres-get-column-cardinality" tool estimates the number of unique values in one or all columns of a Postgres database table. |
| postgres-list-active-queries | The "postgres-list-active-queries" tool lists currently active queries in a Postgres database. |
| postgres-list-available-extensions | The "postgres-list-available-extensions" tool retrieves all PostgreSQL extensions available for installation on a Postgres database. |
| postgres-list-database-stats | The "postgres-list-database-stats" tool lists lists key performance and activity statistics of PostgreSQL databases. |
| postgres-list-indexes | The "postgres-list-indexes" tool lists indexes in a Postgres database. |
| postgres-list-installed-extensions | The "postgres-list-installed-extensions" tool retrieves all PostgreSQL extensions installed on a Postgres database. |
| postgres-list-locks | 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. |
| postgres-list-pg-settings | The "postgres-list-pg-settings" tool lists PostgreSQL run-time configuration settings. |
| postgres-list-publication-tables | The "postgres-list-publication-tables" tool lists publication tables in a Postgres database. |
| postgres-list-query-stats | The "postgres-list-query-stats" tool lists query statistics from a Postgres database. |
| postgres-list-roles | The "postgres-list-roles" tool lists user-created roles in a Postgres database. |
| postgres-list-schemas | The "postgres-list-schemas" tool lists user-defined schemas in a database. |
| postgres-list-sequences | The "postgres-list-sequences" tool lists sequences in a Postgres database. |
| postgres-list-stored-procedure | The "postgres-list-stored-procedure" tool retrieves metadata for stored procedures in PostgreSQL, including procedure definitions, owners, languages, and descriptions. |
| postgres-list-table-stats | The "postgres-list-table-stats" tool reports table statistics including size, scan metrics, and bloat indicators for PostgreSQL tables. |
| postgres-list-tables | The "postgres-list-tables" tool lists schema information for all or specified tables in a Postgres database. |
| postgres-list-tablespaces | The "postgres-list-tablespaces" tool lists tablespaces in a Postgres database. |
| postgres-list-triggers | The "postgres-list-triggers" tool lists triggers in a Postgres database. |
| postgres-list-views | The "postgres-list-views" tool lists views in a Postgres database, with a default limit of 50 rows. |
| postgres-long-running-transactions | The postgres-long-running-transactions tool Identifies and lists database transactions that exceed a specified time limit. For each of the long running transactions, the output contains the process id, database name, user name, application name, client address, state, connection age, transaction age, query age, last activity age, wait event type, wait event, and query string. |
| postgres-replication-stats | The "postgres-replication-stats" tool reports replication-related metrics for WAL streaming replicas, including lag sizes presented in human-readable form. |
| postgres-sql | A "postgres-sql" tool executes a pre-defined SQL statement against a Postgres database. |
Pre-built Configurations
- PostgreSQL using MCP Connect your IDE to PostgreSQL using Toolbox.
Requirements
Database User
This source only uses standard authentication. You will need to create a PostgreSQL user to login to the database with.
Example
kind: source
name: my-pg-source
type: postgres
host: 127.0.0.1
port: 5432
database: my_db
user: ${USER_NAME}
password: ${PASSWORD}
Tip
Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “postgres”. |
| host | string | true | IP address to connect to (e.g. “127.0.0.1”) |
| port | string | true | Port to connect to (e.g. “5432”) |
| database | string | true | Name of the Postgres database to connect to (e.g. “my_db”). |
| user | string | true | Name of the Postgres user to connect as (e.g. “my-pg-user”). |
| password | string | true | Password of the Postgres user (e.g. “my-password”). |
| queryParams | map[string]string | false | Raw query to be added to the db connection string. |
| queryExecMode | string | false | pgx query execution mode. Valid values: cache_statement (default), cache_describe, describe_exec, exec, simple_protocol. Useful with connection poolers that don’t support prepared statement caching. |
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.