Elastic PostgreSQL connector reference

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.

To create a new PostgreSQL connector:

For additional operations, see Using connectors.

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"
}

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

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

For additional operations, see Using connectors.

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

Set the following configuration fields:

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

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

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

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

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.

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

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

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

See Troubleshooting.

See Security.

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

To create a new PostgreSQL connector:

For additional operations, see Using connectors.

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"
}

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

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

For additional operations, see Using connectors.

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

Set the following configuration fields:

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

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

# 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

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.15.4.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.

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

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

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

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

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.

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

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

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

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

See Troubleshooting.

See Security.