• Docs
  • Plugins
  • Destinations
  • PostgreSQL
  • Overview

CloudQuery PostgreSQL Destination Plugin

This destination plugin lets you sync data from a CloudQuery source to a PostgreSQL compatible database.

Supported database versions:

  • PostgreSQL > v10
  • CockroachDB > v20.2

Configuration

Example

This example configures a Postgresql destination, located at localhost:5432. The (top level) spec section is described in the Destination Spec Reference.

kind: destination
spec:
  name: "postgresql"
  registry: github
  path: "postgresql"
  version: "v1.7.14"

  spec:
    connection_string: "postgresql://postgres:pass@localhost:5432/postgres?sslmode=disable"

PostgreSQL Spec

This is the (nested) spec used by the PostgreSQL destination Plugin.

  • connection_string (string, required)

    Connection string to connect to the database. This can be a URL or a DSN, as per pgxpool

    • "postgres://jack:secret@localhost:5432/mydb?sslmode=prefer" connect with tcp and prefer TLS
    • "postgres://jack:secret@localhost:5432/mydb?sslmode=disable&application_name=pgxtest&search_path=myschema&connect_timeout=5" be explicit with all options
    • "postgres://localhost:5432/mydb?sslmode=disable" connect with os username cloudquery is being run as
    • "postgres:///mydb?host=/tmp" connect over unix socket
    • "dbname=mydb" unix domain socket, just specifying the db name - useful if you want to use peer authentication
    • "user=jack password=jack\\'ssooper\\\\secret host=localhost port=5432 dbname=mydb sslmode=disable" DSN with escaped backslash and single quote
  • pgx_log_level (string, optional. Default: "error")

    Available: "error", "warn", "info", "debug", "trace" define if and in which level to log pgx call.

  • batch_size (int, optional. Default: 1000)

    Number of rows to insert in a single batch.

Last updated on November 28, 2022