---
title: "PostgreSQL"
date: 0001-01-01
summary: "PostgreSQL Connector #  Register PostgreSQL Connector #  curl -XPOST "http://localhost:9000/connector/" -d '{ "name": "PostgreSQL Connector", "description": "Fetch data from PostgreSQL database.", "category": "database", "icon": "/assets/icons/connector/postgresql/icon.png", "tags": [ "sql", "storage", "web" ], "url": "http://coco.rs/connectors/postgresql", "assets": { "icons": { "default": "/assets/icons/connector/postgresql/icon.png" } }, "processor": { "enabled": true, "name": "postgresql" } }' Use the PostgreSQL Connector #  The PostgreSQL Connector allows you to index data from your database by executing a custom SQL query."
---

# PostgreSQL Connector

## Register PostgreSQL Connector

```shell
curl -XPOST "http://localhost:9000/connector/" -d '{
  "name": "PostgreSQL Connector",
  "description": "Fetch data from PostgreSQL database.",
  "category": "database",
  "icon": "/assets/icons/connector/postgresql/icon.png",
  "tags": [
    "sql",
    "storage",
    "web"
  ],
  "url": "http://coco.rs/connectors/postgresql",
  "assets": {
    "icons": {
      "default": "/assets/icons/connector/postgresql/icon.png"
    }
  },
  "processor": {
    "enabled": true,
    "name": "postgresql"
  }
}'
```


## Use the PostgreSQL Connector

The PostgreSQL Connector allows you to index data from your database by executing a custom SQL query.

### Configure PostgreSQL Datasource

To configure your PostgreSQL connection, you'll need to provide the connection details and the query to fetch the data.

`Connection URI`: The full PostgreSQL connection string, including user, password, host, port, and database name.

`SQL Query`: The SQL query that will be executed to fetch the data for indexing. You can use `JOIN`s and select specific columns.

`Last Modified Field`: (Optional) For incremental sync, specify a timestamp or datetime column (e.g., `updated_at`). The connector will only fetch rows where this field's value is newer than the last sync time.

`Enable Pagination`: (Optional) A boolean (`true` or `false`) to enable paginated fetching. This is highly recommended for large tables to avoid high memory usage.

`Page Size`: (Optional) The number of records to fetch per page when pagination is enabled. Defaults to `500`.

`Field Mapping`: (Optional) An advanced feature to map columns from your SQL query to specific document fields like `id`, `title`, `content`, and custom metadata.

### Datasource Configuration

Each datasource has its own sync configuration and PostgreSQL settings:

```shell
curl -H 'Content-Type: application/json' -XPOST "http://localhost:9000/datasource/" -d '{
    "name": "My PostgreSQL Documents",
    "type": "connector",
    "enabled": true,
    "connector": {
        "id": "postgresql",
        "config": {
            "connection_uri": "postgres://username:password@localhost:5432/coco?sslmode=disable&timezone=Asia/Shanghai",
            "sql": "SELECT * from DOC",
            "pagination": true,
            "page_size": 500,
            "last_modified_field": "updated",
            "field_mapping": {
                "enabled": true,
                "mapping": {
                    "hashed": true,
                    "id": "id",
                    "title": "title",
                    "url": "url",
                    "metadata": [
                        {
                            "name": "version",
                            "value": "v"
                        }
                    ]
                }
            }
        }
    },
    "sync": {
        "enabled": true,
        "interval": "30s"
    }
}'
```

## Supported Config Parameters for PostgreSQL Connector

Below are the configuration parameters supported by the PostgreSQL Connector:

### Datasource Config Parameters

| **Field**              | **Type**   | **Description**                                                                                         |
|------------------------|------------|---------------------------------------------------------------------------------------------------------|
| `connection_uri`       | `string`   | The full PostgreSQL connection URI (e.g., postgresql://user:pass@host:port/db?sslmode=disable) (required). |
| `sql`                  | `string`   | The SQL query to execute for fetching data (required).                                                 |
| `last_modified_field`  | `string`   | Optional. The name of a timestamp/datetime column used for incremental synchronization.                 |
| `pagination`           | `boolean`  | Optional. Set to true to enable pagination for large queries. Defaults to false.                        |
| `page_size`            | `integer`  | Optional. The number of records to fetch per page when pagination is enabled. Defaults to 500.          |
| `field_mapping`        | `object`   | Optional. Provides advanced control to map query columns to standard document fields.                   |
| `sync.enabled`         | `boolean`  | Enable/disable syncing for this datasource.                                                             |
| `sync.interval`        | `string`   | Sync interval for this datasource (e.g., "30s", "5m", "1h").                                            |