Enable Connection Pooler for a Read Replica

client.projects.services.replicaSets.enablePooler(, , ?): ReplicaSetEnablePoolerResponse { message }

POST/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/enablePooler

Activates the connection pooler for a specific read replica set.

ParametersExpand Collapse

replicaSetID: string

params: ReplicaSetEnablePoolerParams { project_id, service_id }

project_id: string

The unique identifier of the project.

service_id: string

The unique identifier of the service.

ReturnsExpand Collapse

ReplicaSetEnablePoolerResponse { message }

message?: string

Enable Connection Pooler for a Read Replica

import TigerCloud from 'tiger-cloud';

const client = new TigerCloud({
  apiKey: process.env['TIGER_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.projects.services.replicaSets.enablePooler('alb8jicdpr', {
  project_id: 'rp1pz7uyae',
  service_id: 'd1k5vk7hf2',
});

console.log(response.message);

{
  "message": "Action completed successfully."
}

Returns Examples

{
  "message": "Action completed successfully."
}