IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elastic Oracle connector reference Elastic S3 connector reference »
Elastic Docs › ›Elastic connectors

Elastic PostgreSQL connector reference

edit

Elastic PostgreSQL connector reference

edit

The Elastic PostgreSQL connector is a connector for PostgreSQL.

Availability and prerequisites

edit

This connector is available as a connector client from the Python connectors framework. To use this connector, satisfy all connector client requirements.

This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Usage

edit

To use this connector as a connector client, use the build a connector workflow. See Connector clients and frameworks.

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 Usage.

For an end-to-end example of the build a connector workflow, see PostgreSQL connector client tutorial.

Compatibility

edit

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

Configuration

edit

When using the build a connector workflow, intially these fields will use the default configuration set in the connector source code. Note that this data source uses the generic_database.py connector source code.

Refer to postgresql.py for additional code, specific to this data source. 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 is hosted. Examples:

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

The port where the PostgreSQL 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
tables

Comma-separated list of tables. 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
  • *
fetch_size
The number of rows to fetch on each request to the PostgreSQL. Default value is 50.
retry_count
The number of retry attempts after failed request to the PostgreSQL. Default value is 3.
ssl_disabled
Whether SSL verification will be disabled. Default value is True.
ssl_ca

Content of SSL certificate. If SSL is disabled, keep the ssl_ca field empty.

Expand to see an example certificate 
-----BEGIN CERTIFICATE-----
MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT
AlVTMQwwCgYDVQQKEwNJQk0xFjAUBgNVBAsTDURlZmF1bHROb2RlMDExFjAUBgNV
BAsTDURlZmF1bHRDZWxsMDExGTAXBgNVBAsTEFJvb3QgQ2VydGlmaWNhdGUxEjAQ
BgNVBAMTCWxvY2FsaG9zdDAeFw0yMTEyMTQyMjA3MTZaFw0yMjEyMTQyMjA3MTZa
MF8xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xFjAUBgNVBAsTDURlZmF1bHRO
b2RlMDExFjAUBgNVBAsTDURlZmF1bHRDZWxsMDExEjAQBgNVBAMTCWxvY2FsaG9z
dDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMv5HCsJZIpI5zCy+jXV
z6lmzNc9UcVSEEHn86h6zT6pxuY90TYeAhlZ9hZ+SCKn4OQ4GoDRZhLPTkYDt+wW
CV3NTIy9uCGUSJ6xjCKoxClJmgSQdg5m4HzwfY4ofoEZ5iZQ0Zmt62jGRWc0zuxj
hegnM+eO2reBJYu6Ypa9RPJdYJsmn1RNnC74IDY8Y95qn+WZj//UALCpYfX41hko
i7TWD9GKQO8SBmAxhjCDifOxVBokoxYrNdzESl0LXvnzEadeZTd9BfUtTaBHhx6t
njqqCPrbTY+3jAbZFd4RiERPnhLVKMytw5ot506BhPrUtpr2lusbN5svNXjuLeea
MMUCAwEAAaOBoDCBnTATBgNVHSMEDDAKgAhOatpLwvJFqjAdBgNVHSUEFjAUBggr
BgEFBQcDAQYIKwYBBQUHAwIwVAYDVR0RBE0wS4E+UHJvZmlsZVVVSUQ6QXBwU3J2
MDEtQkFTRS05MDkzMzJjMC1iNmFiLTQ2OTMtYWI5NC01Mjc1ZDI1MmFmNDiCCWxv
Y2FsaG9zdDARBgNVHQ4ECgQITzqhA5sO8O4wDQYJKoZIhvcNAQELBQADggEBAKR0
gY/BM69S6BDyWp5dxcpmZ9FS783FBbdUXjVtTkQno+oYURDrhCdsfTLYtqUlP4J4
CHoskP+MwJjRIoKhPVQMv14Q4VC2J9coYXnePhFjE+6MaZbTjq9WaekGrpKkMaQA
iQt5b67jo7y63CZKIo9yBvs7sxODQzDn3wZwyux2vPegXSaTHR/rop/s/mPk3YTS
hQprs/IVtPoWU4/TsDN3gIlrAYGbcs29CAt5q9MfzkMmKsuDkTZD0ry42VjxjAmk
xw23l/k8RoD1wRWaDVbgpjwSzt+kl+vJE/ip2w3h69eEZ9wbo6scRO5lCO2JM4Pr
7RhLQyWn2u00L7/9Omw=
-----END CERTIFICATE-----

Documents and syncs

edit
  • Tables must be owned by a PostgreSQL user.
  • Database superuser privileges are required to index all database tables.
  • 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.

Sync rules

edit
  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that deployment.
  • Filtering rules are not available in the present version. Currently filtering is controlled via ingest pipelines.

Connector client operations

edit

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.

Framework and source

edit

This connector is included in the Python connectors framework.

This connector uses the generic database connector source code (branch 8.7, compatible with Elastic 8.7).

View additional code specific to this data source (branch 8.7, compatible with Elastic 8.7).

« Elastic Oracle connector reference Elastic S3 connector reference »