« Elastic Outlook connector reference Redis connector reference »

› ›

Elastic PostgreSQL connector reference

The Elastic PostgreSQL connector is a connector for PostgreSQL. This connector is written in Python using the Elastic connector framework.

This connector uses the generic database connector source code (branch 8.15, compatible with Elastic 8.15). View the specific source code for this connector (branch 8.15, compatible with Elastic 8.15).

Native connector (Elastic Cloud)

edit

View native connector reference

Availability and prerequisites

edit

This connector is available as a native connector in Elastic versions 8.8.0 and later. To use this connector natively in Elastic Cloud, satisfy all native connector requirements.

Create a PostgreSQL connector

edit

Use the UI

edit

To create a new PostgreSQL connector:

Navigate to the Search → Connectors page in the Kibana UI.
Follow the instructions to create a new native PostgreSQL connector.

For additional operations, see Using connectors.

Use the API

edit

You can use the Elasticsearch Create connector API to create a new native PostgreSQL connector.

For example:

PUT _connector/<my-postgresql-connector>
{
  "index_name": "<my-elasticsearch-index>",
  "name": "Content synced from PostgreSQL",
  "service_type": "postgresql",
  "is_native": "true"
}

You’ll also need to create an API key for the connector to use.

The user needs the cluster privileges manage_api_key, manage_connector and write_connector_secrets to generate API keys programmatically.

To create an API key for the connector:

Run the following command, replacing values where indicated. Note the id and encoded return values from the response:

POST /_security/api_key
{
  "name": "<connector_name>-connector-api-key",
  "role_descriptors": {
    "<connector_name>-connector-role": {
      "cluster": [
        "monitor",
        "manage_connector"
      ],
      "indices": [
        {
          "names": [
            "<index_name>",
            ".search-acl-filter-<index_name>",
            ".elastic-connectors*"
          ],
          "privileges": [
            "all"
          ],
          "allow_restricted_indices": false
        }
      ]
    }
  }
}

Use the encoded value to store a connector secret, and note the id return value from this response:
```
POST _connector/_secret
{
  "value": <encoded_api_key>
}
```

Use the API key id and the connector secret id to update the connector:

PUT /_connector/<connector_id>/_api_key_id
{
  "api_key_id": "<API key id>",
  "api_key_secret_id": "<secret id>"
}

Refer to the Elasticsearch API documentation for details of all available Connector APIs.

Usage

edit

To use this connector as a native connector, use the Connector workflow. See Native connectors (managed service).

Users must set track_commit_timestamp to on. To do this, run ALTER SYSTEM SET track_commit_timestamp = on; in PostgreSQL server.

For additional operations, see Using connectors.

For an end-to-end example of the connector client workflow, see Tutorial.

Compatibility

edit

PostgreSQL versions 11 to 15 are compatible with the Elastic connector.

Configuration

edit

Set the following configuration fields:

Host

The server host address where the PostgreSQL instance is hosted. Examples:

192.158.1.38
demo.instance.demo-region.demo.service.com

Port

The port where the PostgreSQL instance is hosted. Examples:

5432 (default)

Username

The username of the PostgreSQL account.

Password

The password of the PostgreSQL account.

Database

Name of the PostgreSQL database. Examples:

employee_database
customer_database

Schema

The schema of the PostgreSQL database.

Comma-separated List of Tables

A list of tables separated by commas. The PostgreSQL connector will fetch data from all tables present in the configured database, if the value is * . Default value is *. Examples:

table_1, table_2
*

This field can be bypassed when using advanced sync rules.

Enable SSL

Toggle to enable SSL verification. Disabled by default.

SSL Certificate

Content of SSL certificate. If SSL is disabled, the ssl_ca value will be ignored.

Expand to see an example certificate

Documents and syncs

edit

Tables must be owned by a PostgreSQL user.
Tables with no primary key defined are skipped.
To fetch the last updated time in PostgreSQL, track_commit_timestamp must be set to on. Otherwise, all data will be indexed in every sync.

Files bigger than 10 MB won’t be extracted.
Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Sync rules

edit

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rules

edit

A full sync is required for advanced sync rules to take effect.

Advanced sync rules are defined through a source-specific DSL JSON snippet.

Example data

edit

Here is some example data that will be used in the following examples.

employee tableedit

emp_id	name	age
3	John	28
10	Jane	35
14	Alex	22

customer tableedit

c_id	name	age
2	Elm	24
6	Pine	30
9	Oak	34

Advanced sync rules examples

edit

Multiple table queriesedit

[
  {
    "tables": [
      "employee"
    ],
    "query": "SELECT * FROM employee"
  },
  {
    "tables": [
      "customer"
    ],
    "query": "SELECT * FROM customer"
  }
]

Multiple table queries with id_columnsedit

In 8.15.0, we added a new optional id_columns field in our advanced sync rules for the PostgreSQL connector. Use the id_columns field to ingest tables which do not have a primary key. Include the names of unique fields so that the connector can use them to generate unique IDs for documents.

[
  {
    "tables": [
      "employee"
    ],
    "query": "SELECT * FROM employee",
    "id_columns": ["emp_id"]
  },
  {
    "tables": [
      "customer"
    ],
    "query": "SELECT * FROM customer",
    "id_columns": ["c_id"]
  }
]

This example uses the id_columns field to specify the unique fields emp_id and c_id for the employee and customer tables, respectively.

Filtering data with WHERE clauseedit

[
  {
    "tables": ["employee"],
    "query": "SELECT * FROM employee WHERE emp_id > 5"
  }
]

JOIN operationsedit

[
  {
    "tables": ["employee", "customer"],
    "query": "SELECT * FROM employee INNER JOIN customer ON employee.emp_id = customer.c_id"
  }
]

When using advanced rules, a query can bypass the configuration field tables. This will happen if the query specifies a table that doesn’t appear in the configuration. This can also happen if the configuration specifies * to fetch all tables while the advanced sync rule requests for only a subset of tables.

Known issues

edit

There are no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.

View connector client reference

Availability and prerequisites

edit

This connector is available as a self-managed connector client. To use this connector, satisfy all connector client requirements.

Create a PostgreSQL connector

edit

Use the UI

edit

To create a new PostgreSQL connector:

Navigate to the Search → Connectors page in the Kibana UI.
Follow the instructions to create a new PostgreSQL connector client.

For additional operations, see Using connectors.

Use the API

edit

You can use the Elasticsearch Create connector API to create a new self-managed PostgreSQL connector client.

For example:

PUT _connector/my-postgresql-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from PostgreSQL",
  "service_type": "postgresql"
}

You’ll also need to create an API key for the connector to use.

The user needs the cluster privileges manage_api_key, manage_connector and write_connector_secrets to generate API keys programmatically.

To create an API key for the connector:

Run the following command, replacing values where indicated. Note the encoded return values from the response:

POST /_security/api_key
{
  "name": "<connector_name>-connector-api-key",
  "role_descriptors": {
    "<connector_name>-connector-role": {
      "cluster": [
        "monitor",
        "manage_connector"
      ],
      "indices": [
        {
          "names": [
            "<index_name>",
            ".search-acl-filter-<index_name>",
            ".elastic-connectors*"
          ],
          "privileges": [
            "all"
          ],
          "allow_restricted_indices": false
        }
      ]
    }
  }
}

Update your config.yml file with the API key encoded value.

Refer to the Elasticsearch API documentation for details of all available Connector APIs.

Usage

edit

To use this connector as a connector client, see Connector clients (self-managed)

Users must set track_commit_timestamp to on. To do this, run ALTER SYSTEM SET track_commit_timestamp = on; in PostgreSQL server.

For additional operations, see Using connectors.

For an end-to-end example of the connector client workflow, see Tutorial.

Compatibility

edit

PostgreSQL versions 11 to 15 are compatible with Elastic connector frameworks.

Configuration

edit

When using the connector client workflow, initially these fields will use the default configuration set in the connector source code.

These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, users will be able to update these values in Kibana.

Set the following configuration fields:

host

The server host address where the PostgreSQL instance is hosted. Examples:

192.158.1.38
demo.instance.demo-region.demo.service.com

port

The port where the PostgreSQL instance is hosted. Examples:

5432
9090

username

The username of the PostgreSQL account.

password

The password of the PostgreSQL account.

database

Name of the PostgreSQL database. Examples:

employee_database
customer_database

schema

The schema of the PostgreSQL database.

tables

A list of tables separated by commas. The PostgreSQL connector will fetch data from all tables present in the configured database, if the value is * . Default value is *. Examples:

table_1, table_2
*

This field can be bypassed when using advanced sync rules.

ssl_enabled

Whether SSL verification will be enabled. Default value is True.

ssl_ca

Content of SSL certificate (if SSL is enabled). If SSL is disabled, the ssl_ca value will be ignored.

Expand to see an example certificate

Deployment using Docker

edit

You can deploy the PostgreSQL connector as a self-managed connector client using Docker. Follow these instructions.

Step 1: Download sample configuration file

Download the sample configuration file. You can either download it manually or run the following command:

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml

Remember to update the --output argument value if your directory name is different, or you want to use a different config file name.

Step 2: Update the configuration file for your self-managed connector

Update the configuration file with the following settings to match your environment:

elasticsearch.host
elasticsearch.api_key
connectors

If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:

# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>

connectors:
  -
    connector_id: <CONNECTOR_ID_FROM_KIBANA>
    service_type: postgresql
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA> # Optional. If not provided, the connector will use the elasticsearch.api_key instead

Using the elasticsearch.api_key is the recommended authentication method. However, you can also use elasticsearch.username and elasticsearch.password to authenticate with your Elasticsearch instance.

Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.

Step 3: Run the Docker image

Run the Docker image with the Connector Service using the following command:

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.15.2.0 \
/app/bin/elastic-ingest \
-c /config/config.yml

Refer to DOCKER.md in the elastic/connectors repo for more details.

Find all available Docker images in the official registry.

We also have a quickstart self-managed option using Docker Compose, so you can spin up all required services at once: Elasticsearch, Kibana, and the connectors service. Refer to this README in the elastic/connectors repo for more information.

Documents and syncs

edit

Tables must be owned by a PostgreSQL user.
Tables with no primary key defined are skipped.
To fetch the last updated time in PostgreSQL, track_commit_timestamp must be set to on. Otherwise, all data will be indexed in every sync.

Files bigger than 10 MB won’t be extracted.
Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Sync rules

edit

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rules

edit

A full sync is required for advanced sync rules to take effect.

Advanced sync rules are defined through a source-specific DSL JSON snippet.

Example data

edit

Here is some example data that will be used in the following examples.

employee tableedit

emp_id	name	age
3	John	28
10	Jane	35
14	Alex	22

customer tableedit

c_id	name	age
2	Elm	24
6	Pine	30
9	Oak	34

Advanced sync rules examples

edit

Multiple table queriesedit

[
  {
    "tables": [
      "employee"
    ],
    "query": "SELECT * FROM employee"
  },
  {
    "tables": [
      "customer"
    ],
    "query": "SELECT * FROM customer"
  }
]

Multiple table queries with id_columnsedit

[
  {
    "tables": [
      "employee"
    ],
    "query": "SELECT * FROM employee",
    "id_columns": ["emp_id"]
  },
  {
    "tables": [
      "customer"
    ],
    "query": "SELECT * FROM customer",
    "id_columns": ["c_id"]
  }
]

This example uses the id_columns field to specify the unique fields emp_id and c_id for the employee and customer tables, respectively.

Filtering data with WHERE clauseedit

[
  {
    "tables": ["employee"],
    "query": "SELECT * FROM employee WHERE emp_id > 5"
  }
]

JOIN operationsedit

[
  {
    "tables": ["employee", "customer"],
    "query": "SELECT * FROM employee INNER JOIN customer ON employee.emp_id = customer.c_id"
  }
]

End-to-end testing

edit

The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.

To perform E2E testing for the PostgreSQL connector, run the following command:

$ make ftest NAME=postgresql

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=postgresql DATA_SIZE=small

Known issues

edit

There are no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

« Elastic Outlook connector reference Redis connector reference »

Elastic PostgreSQL connector reference