Reference > PyDo > Library Reference > databases > get_connection_pool()

Was this page helpful?

Give Feedback

pydo.databases.get_connection_pool()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. The response will be a JSON object with a pool key.

Parameters

Name	Type	Required	Description	Default Value
`database_cluster_uuid`	string	True	A unique identifier for a database cluster.
`pool_name`	string	True	The name used to identify the connection pool.

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

get_resp = client.databases.get_connection_pool(database_cluster_uuid="a7aba8a", pool_name="backend-pool")

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

200
401
404
429
500
default

A JSON object with a key of pool.

Click to expand an example response.

{
  "pool": {
    "user": "doadmin",
    "name": "backend-pool",
    "size": 10,
    "db": "defaultdb",
    "mode": "transaction",
    "connection": {
      "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25061/backend-pool?sslmode=require",
      "database": "backend-pool",
      "host": "backend-do-user-19081923-0.db.ondigitalocean.com",
      "port": 25061,
      "user": "doadmin",
      "password": "wv78n3zpz42xezdk",
      "ssl": true
    }
  }
}

Unauthorized

Click to expand an example response.

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

The resource was not found.

Click to expand an example response.

{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

API Rate limit exceeded

Click to expand an example response.

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response.

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response.

{
  "id": "example_error",
  "message": "some error message"
}