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
70 lines
2.7 KiB
Markdown
70 lines
2.7 KiB
Markdown
---
|
|
title: "PostgreSQL Source"
|
|
linkTitle: "Source"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
PostgreSQL is a powerful, open source object-relational database.
|
|
no_list: true
|
|
---
|
|
|
|
## About
|
|
|
|
[PostgreSQL][pg-docs] 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.
|
|
|
|
[pg-docs]: https://www.postgresql.org/
|
|
|
|
|
|
|
|
## Available Tools
|
|
|
|
{{< list-tools >}}
|
|
|
|
### Pre-built Configurations
|
|
|
|
- [PostgreSQL using MCP](../../documentation/connect-to/ides/postgres_mcp.md)
|
|
Connect your IDE to PostgreSQL using Toolbox.
|
|
|
|
## Requirements
|
|
|
|
### Database User
|
|
|
|
This source only uses standard authentication. You will need to [create a
|
|
PostgreSQL user][pg-users] to login to the database with.
|
|
|
|
[pg-users]: https://www.postgresql.org/docs/current/sql-createuser.html
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: source
|
|
name: my-pg-source
|
|
type: postgres
|
|
host: 127.0.0.1
|
|
port: 5432
|
|
database: my_db
|
|
user: ${USER_NAME}
|
|
password: ${PASSWORD}
|
|
```
|
|
|
|
{{< notice tip >}}
|
|
Use environment variable replacement with the format ${ENV_NAME}
|
|
instead of hardcoding your secrets into the configuration file.
|
|
{{< /notice >}}
|
|
|
|
## 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. |
|
|
| sqlCommenter | boolean | false | Overrides the global `--sql-commenter` flag for this source. When set, it takes priority; when omitted, the global flag applies. |
|