From f913c67b5f9b90918a6d9793cb3b9195fbf29465 Mon Sep 17 00:00:00 2001 From: API Engineering Date: Tue, 23 Jan 2024 16:36:10 +0000 Subject: [PATCH] [bot] Updated client based on openapi-6e029d2/clientgen --- DO_OPENAPI_COMMIT_SHA.txt | 2 +- src/pydo/aio/operations/_operations.py | 422 ++++++++++++++++++++++++- src/pydo/operations/_operations.py | 422 ++++++++++++++++++++++++- 3 files changed, 833 insertions(+), 13 deletions(-) diff --git a/DO_OPENAPI_COMMIT_SHA.txt b/DO_OPENAPI_COMMIT_SHA.txt index 37c04ed..bd61a17 100644 --- a/DO_OPENAPI_COMMIT_SHA.txt +++ b/DO_OPENAPI_COMMIT_SHA.txt @@ -1 +1 @@ -a0a7ddf +6e029d2 diff --git a/src/pydo/aio/operations/_operations.py b/src/pydo/aio/operations/_operations.py index 42e95e9..a45ebeb 100644 --- a/src/pydo/aio/operations/_operations.py +++ b/src/pydo/aio/operations/_operations.py @@ -72816,10 +72816,15 @@ async def list_clusters( ``/v2/databases``. To limit the results to database clusters with a specific tag, include the ``tag_name`` query parameter set to the name of the tag. For example, ``/v2/databases?tag_name=$TAG_NAME``. + The result will be a JSON object with a ``databases`` key. This will be set to an array of database objects, each of which will contain the standard database attributes. + The embedded ``connection`` and ``private_connection`` objects will contain the information - needed to access the database cluster: + needed to access the database cluster. For multi-node clusters, the ``standby_connection`` and + ``standby_private_connection`` objects will contain the information needed to connect to the + cluster's standby node(s). + The embedded ``maintenance_window`` object will contain information about any scheduled maintenance for the database cluster. @@ -72936,6 +72941,42 @@ async def list_clusters( the semantic version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the + default database. + "host": "str", # Optional. The FQDN pointing to the + database cluster's current primary node. + "password": "str", # Optional. The randomly + generated password for the default user. + "port": 0, # Optional. The port on which the + database cluster is listening. + "ssl": bool, # Optional. A boolean value indicating + if the connection should be made over SSL. + "uri": "str", # Optional. A connection string in the + format accepted by the ``psql`` command. This is provided as a + convenience and should be able to be constructed by the other + attributes. + "user": "str" # Optional. The default user for the + database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the + default database. + "host": "str", # Optional. The FQDN pointing to the + database cluster's current primary node. + "password": "str", # Optional. The randomly + generated password for the default user. + "port": 0, # Optional. The port on which the + database cluster is listening. + "ssl": bool, # Optional. A boolean value indicating + if the connection should be made over SSL. + "uri": "str", # Optional. A connection string in the + format accepted by the ``psql`` command. This is provided as a + convenience and should be able to be constructed by the other + attributes. + "user": "str" # Optional. The default user for the + database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -73102,8 +73143,12 @@ async def create_cluster( object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's ``status`` attribute will be ``creating``. When the cluster is ready to receive traffic, this will transition to ``online``. + The embedded ``connection`` and ``private_connection`` objects will contain the information - needed to access the database cluster. + needed to access the database cluster. For multi-node clusters, the ``standby_connection`` and + ``standby_private_connection`` objects will contain the information needed to connect to the + cluster's standby node(s). + DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to ``/v2/databases``. In addition to the standard database cluster attributes, the JSON body must @@ -73221,6 +73266,36 @@ async def create_cluster( version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated password for + the default user. + "port": 0, # Optional. The port on which the database cluster is + listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format accepted + by the ``psql`` command. This is provided as a convenience and should be able + to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated password for + the default user. + "port": 0, # Optional. The port on which the database cluster is + listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format accepted + by the ``psql`` command. This is provided as a convenience and should be able + to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -73380,6 +73455,38 @@ async def create_cluster( semantic version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -73472,8 +73579,12 @@ async def create_cluster( object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's ``status`` attribute will be ``creating``. When the cluster is ready to receive traffic, this will transition to ``online``. + The embedded ``connection`` and ``private_connection`` objects will contain the information - needed to access the database cluster. + needed to access the database cluster. For multi-node clusters, the ``standby_connection`` and + ``standby_private_connection`` objects will contain the information needed to connect to the + cluster's standby node(s). + DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to ``/v2/databases``. In addition to the standard database cluster attributes, the JSON body must @@ -73589,6 +73700,38 @@ async def create_cluster( semantic version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -73679,8 +73822,12 @@ async def create_cluster(self, body: Union[JSON, IO], **kwargs: Any) -> JSON: object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's ``status`` attribute will be ``creating``. When the cluster is ready to receive traffic, this will transition to ``online``. + The embedded ``connection`` and ``private_connection`` objects will contain the information - needed to access the database cluster. + needed to access the database cluster. For multi-node clusters, the ``standby_connection`` and + ``standby_private_connection`` objects will contain the information needed to connect to the + cluster's standby node(s). + DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to ``/v2/databases``. In addition to the standard database cluster attributes, the JSON body must @@ -73796,6 +73943,38 @@ async def create_cluster(self, body: Union[JSON, IO], **kwargs: Any) -> JSON: semantic version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -73966,10 +74145,15 @@ async def get_cluster(self, database_cluster_uuid: str, **kwargs: Any) -> JSON: To show information about an existing database cluster, send a GET request to ``/v2/databases/$DATABASE_ID``. + The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes. - The embedded connection and private_connection objects will contain the information needed to - access the database cluster. + + The embedded ``connection`` and ``private_connection`` objects will contain the information + needed to access the database cluster. For multi-node clusters, the ``standby_connection`` and + ``standby_private_connection`` objects contain the information needed to connect to the + cluster's standby node(s). + The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. @@ -74077,6 +74261,38 @@ async def get_cluster(self, database_cluster_uuid: str, **kwargs: Any) -> JSON: semantic version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -79742,6 +79958,42 @@ async def list_connection_pools( 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the + default database. + "host": "str", # Optional. The FQDN pointing to the + database cluster's current primary node. + "password": "str", # Optional. The randomly + generated password for the default user. + "port": 0, # Optional. The port on which the + database cluster is listening. + "ssl": bool, # Optional. A boolean value indicating + if the connection should be made over SSL. + "uri": "str", # Optional. A connection string in the + format accepted by the ``psql`` command. This is provided as a + convenience and should be able to be constructed by the other + attributes. + "user": "str" # Optional. The default user for the + database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the + default database. + "host": "str", # Optional. The FQDN pointing to the + database cluster's current primary node. + "password": "str", # Optional. The randomly + generated password for the default user. + "port": 0, # Optional. The port on which the + database cluster is listening. + "ssl": bool, # Optional. A boolean value indicating + if the connection should be made over SSL. + "uri": "str", # Optional. A connection string in the + format accepted by the ``psql`` command. This is provided as a + convenience and should be able to be constructed by the other + attributes. + "user": "str" # Optional. The default user for the + database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. @@ -79911,6 +80163,36 @@ async def add_connection_pool( maintenance. For example, a primary node with 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated password for + the default user. + "port": 0, # Optional. The port on which the database cluster is + listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format accepted + by the ``psql`` command. This is provided as a convenience and should be able + to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated password for + the default user. + "port": 0, # Optional. The port on which the database cluster is + listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format accepted + by the ``psql`` command. This is provided as a convenience and should be able + to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. } @@ -79963,6 +80245,38 @@ async def add_connection_pool( for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. @@ -80066,6 +80380,38 @@ async def add_connection_pool( for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. @@ -80164,6 +80510,38 @@ async def add_connection_pool( for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. @@ -80335,6 +80713,38 @@ async def get_connection_pool( for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. diff --git a/src/pydo/operations/_operations.py b/src/pydo/operations/_operations.py index 11c2a93..25f4f07 100644 --- a/src/pydo/operations/_operations.py +++ b/src/pydo/operations/_operations.py @@ -79745,10 +79745,15 @@ def list_clusters(self, *, tag_name: Optional[str] = None, **kwargs: Any) -> JSO ``/v2/databases``. To limit the results to database clusters with a specific tag, include the ``tag_name`` query parameter set to the name of the tag. For example, ``/v2/databases?tag_name=$TAG_NAME``. + The result will be a JSON object with a ``databases`` key. This will be set to an array of database objects, each of which will contain the standard database attributes. + The embedded ``connection`` and ``private_connection`` objects will contain the information - needed to access the database cluster: + needed to access the database cluster. For multi-node clusters, the ``standby_connection`` and + ``standby_private_connection`` objects will contain the information needed to connect to the + cluster's standby node(s). + The embedded ``maintenance_window`` object will contain information about any scheduled maintenance for the database cluster. @@ -79865,6 +79870,42 @@ def list_clusters(self, *, tag_name: Optional[str] = None, **kwargs: Any) -> JSO the semantic version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the + default database. + "host": "str", # Optional. The FQDN pointing to the + database cluster's current primary node. + "password": "str", # Optional. The randomly + generated password for the default user. + "port": 0, # Optional. The port on which the + database cluster is listening. + "ssl": bool, # Optional. A boolean value indicating + if the connection should be made over SSL. + "uri": "str", # Optional. A connection string in the + format accepted by the ``psql`` command. This is provided as a + convenience and should be able to be constructed by the other + attributes. + "user": "str" # Optional. The default user for the + database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the + default database. + "host": "str", # Optional. The FQDN pointing to the + database cluster's current primary node. + "password": "str", # Optional. The randomly + generated password for the default user. + "port": 0, # Optional. The port on which the + database cluster is listening. + "ssl": bool, # Optional. A boolean value indicating + if the connection should be made over SSL. + "uri": "str", # Optional. A connection string in the + format accepted by the ``psql`` command. This is provided as a + convenience and should be able to be constructed by the other + attributes. + "user": "str" # Optional. The default user for the + database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -80031,8 +80072,12 @@ def create_cluster( object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's ``status`` attribute will be ``creating``. When the cluster is ready to receive traffic, this will transition to ``online``. + The embedded ``connection`` and ``private_connection`` objects will contain the information - needed to access the database cluster. + needed to access the database cluster. For multi-node clusters, the ``standby_connection`` and + ``standby_private_connection`` objects will contain the information needed to connect to the + cluster's standby node(s). + DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to ``/v2/databases``. In addition to the standard database cluster attributes, the JSON body must @@ -80150,6 +80195,36 @@ def create_cluster( version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated password for + the default user. + "port": 0, # Optional. The port on which the database cluster is + listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format accepted + by the ``psql`` command. This is provided as a convenience and should be able + to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated password for + the default user. + "port": 0, # Optional. The port on which the database cluster is + listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format accepted + by the ``psql`` command. This is provided as a convenience and should be able + to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -80309,6 +80384,38 @@ def create_cluster( semantic version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -80401,8 +80508,12 @@ def create_cluster( object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's ``status`` attribute will be ``creating``. When the cluster is ready to receive traffic, this will transition to ``online``. + The embedded ``connection`` and ``private_connection`` objects will contain the information - needed to access the database cluster. + needed to access the database cluster. For multi-node clusters, the ``standby_connection`` and + ``standby_private_connection`` objects will contain the information needed to connect to the + cluster's standby node(s). + DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to ``/v2/databases``. In addition to the standard database cluster attributes, the JSON body must @@ -80518,6 +80629,38 @@ def create_cluster( semantic version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -80608,8 +80751,12 @@ def create_cluster(self, body: Union[JSON, IO], **kwargs: Any) -> JSON: object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's ``status`` attribute will be ``creating``. When the cluster is ready to receive traffic, this will transition to ``online``. + The embedded ``connection`` and ``private_connection`` objects will contain the information - needed to access the database cluster. + needed to access the database cluster. For multi-node clusters, the ``standby_connection`` and + ``standby_private_connection`` objects will contain the information needed to connect to the + cluster's standby node(s). + DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to ``/v2/databases``. In addition to the standard database cluster attributes, the JSON body must @@ -80725,6 +80872,38 @@ def create_cluster(self, body: Union[JSON, IO], **kwargs: Any) -> JSON: semantic version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -80895,10 +81074,15 @@ def get_cluster(self, database_cluster_uuid: str, **kwargs: Any) -> JSON: To show information about an existing database cluster, send a GET request to ``/v2/databases/$DATABASE_ID``. + The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes. - The embedded connection and private_connection objects will contain the information needed to - access the database cluster. + + The embedded ``connection`` and ``private_connection`` objects will contain the information + needed to access the database cluster. For multi-node clusters, the ``standby_connection`` and + ``standby_private_connection`` objects contain the information needed to connect to the + cluster's standby node(s). + The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. @@ -81006,6 +81190,38 @@ def get_cluster(self, database_cluster_uuid: str, **kwargs: Any) -> JSON: semantic version of the database engine in use for the cluster. "size": "str", # The slug identifier representing the size of the nodes in the database cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". @@ -86665,6 +86881,42 @@ def list_connection_pools(self, database_cluster_uuid: str, **kwargs: Any) -> JS 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the + default database. + "host": "str", # Optional. The FQDN pointing to the + database cluster's current primary node. + "password": "str", # Optional. The randomly + generated password for the default user. + "port": 0, # Optional. The port on which the + database cluster is listening. + "ssl": bool, # Optional. A boolean value indicating + if the connection should be made over SSL. + "uri": "str", # Optional. A connection string in the + format accepted by the ``psql`` command. This is provided as a + convenience and should be able to be constructed by the other + attributes. + "user": "str" # Optional. The default user for the + database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the + default database. + "host": "str", # Optional. The FQDN pointing to the + database cluster's current primary node. + "password": "str", # Optional. The randomly + generated password for the default user. + "port": 0, # Optional. The port on which the + database cluster is listening. + "ssl": bool, # Optional. A boolean value indicating + if the connection should be made over SSL. + "uri": "str", # Optional. A connection string in the + format accepted by the ``psql`` command. This is provided as a + convenience and should be able to be constructed by the other + attributes. + "user": "str" # Optional. The default user for the + database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. @@ -86834,6 +87086,36 @@ def add_connection_pool( maintenance. For example, a primary node with 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated password for + the default user. + "port": 0, # Optional. The port on which the database cluster is + listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format accepted + by the ``psql`` command. This is provided as a convenience and should be able + to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated password for + the default user. + "port": 0, # Optional. The port on which the database cluster is + listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format accepted + by the ``psql`` command. This is provided as a convenience and should be able + to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. } @@ -86886,6 +87168,38 @@ def add_connection_pool( for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. @@ -86989,6 +87303,38 @@ def add_connection_pool( for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. @@ -87087,6 +87433,38 @@ def add_connection_pool( for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. @@ -87258,6 +87636,38 @@ def get_connection_pool( for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. Required. + "standby_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, + "standby_private_connection": { + "database": "str", # Optional. The name of the default + database. + "host": "str", # Optional. The FQDN pointing to the database + cluster's current primary node. + "password": "str", # Optional. The randomly generated + password for the default user. + "port": 0, # Optional. The port on which the database + cluster is listening. + "ssl": bool, # Optional. A boolean value indicating if the + connection should be made over SSL. + "uri": "str", # Optional. A connection string in the format + accepted by the ``psql`` command. This is provided as a convenience and + should be able to be constructed by the other attributes. + "user": "str" # Optional. The default user for the database. + }, "user": "str" # Optional. The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user.