Create a ClickHouse peer - PeerDB Docs: Setup your ETL in minutes with SQL.

POST api/v1/peers/create

PeerDB is now natively integrated with ClickHouse Cloud!We recently announced the Postgres CDC connector in ClickPipes, now available in Public Preview. This connector is fully powered by PeerDB.As a ClickHouse Cloud customer, you get a seamless, native experience for moving data from your Postgres databases to ClickHouse Cloud. Simply navigate to the Data Sources tab and add a Postgres source to start ingesting data.

You can create a Clickhouse peer using this endpoint. Here is the request and response format for creating a Clickhouse peer.

Note that the Clickhouse peer uses an intermediary S3 stage under the hood for performance. The S3 fields related to this are optional, because:

For PeerDB Cloud, the S3 bucket is managed by PeerDB
For PeerDB OSS, a minio bucket is provided as part of the stack.

Request Fields

object

required

Configuration of the peer to be created.

Show peer

string

required

The name of the peer to be created.

required

The type of peer to be created. The value for Clickhouse is 8.

object

required

Configuration for the Clickhouse peer

Show clickhouse_config

string

required

Host of the Clickhouse server.

number

required

Port on which the Clickhouse server is running. Ex: 9440Make sure this is the native TCP port.

string

required

The user to connect to the Clickhouse server.

string

required

The password associated with the Clickhouse user.

string

required

The database to connect to.

boolean

Whether the Clickhouse server is running without TLS. Default is false.

string

Certificate to connect to the Clickhouse server.

string

Private key to connect to the Clickhouse server.

string

Root CA to connect to the Clickhouse server.

string

The S3 path to use for the stage. It is of the form s3://bucket-name/path.

string

The access key ID for the S3 bucket.

string

The secret access key for the S3 bucket.

string

The secret access key for the S3 bucket.

string

The region of the S3 bucket.

string

The endpoint of the S3 bucket.

boolean

Whether you wish to update a peer with this name if it already exists. Default is false.

Response Fields

CREATED|FAILED

Whether the creation/update was successful. If yes, the value will be CREATED. Else it will be FAILED.

string

Error message if any

curl --request POST \
  --url http://localhost:3000/api/v1/peers/create \
  --header 'Authorization: Basic OmJsXPNrU3dhbjEyMw==' \
  --header 'Content-Type: application/json' \
  --data '{
	"peer": {
		"name": "ch_peer_via_api",
		"type": 8,
		"clickhouse_config": {
			"host": "localhost",
			"port": 9900,
			"user": "default",
			"password": "clickhouse",
			"database": "clickhouse",
			"disable_tls": false
		}
	},
	"allow_update":false
}'

curl --request POST \
  --url http://localhost:3000/api/v1/peers/create \
  --header 'Authorization: Basic OmJsXPNrU3dhbjEyMw==' \
  --header 'Content-Type: application/json' \
  --data '{
	"peer": {
		"name": "ch_peer_via_api",
		"type": 8,
		"clickhouse_config": {
			"host": "localhost",
			"port": 9900,
			"user": "default",
			"password": "clickhouse",
			"database": "clickhouse",
			"disable_tls": false,
			"certificate":"",
			"private_key":"***",
			"root_ca":""
		}
	},
	"allow_update":false
}'

{
	"status": "CREATED",
	"message": ""
}

{
	"status": "FAILED",
	"message": "CLICKHOUSE peer ch_peer_via_api was invalidated: failed to open connection to Clickhouse peer: failed to ping to Clickhouse peer: dial tcp [::1]:9900: connect: connection refused"
}

​Request Fields

​Response Fields

Request Fields

Response Fields