Added more parameters to connection pool docs

Signed-off-by: chandr-andr (Kiselev Aleksandr) <chandr@chandr.net>

Author: chandr-andr

python/psqlpy/__init__.py

@@ -1,14 +1,14 @@
 from psqlpy._internal import (
     Connection,
     ConnectionPool,
-    ConnLoadBalanceHosts,
     ConnRecyclingMethod,
-    ConnTargetSessionAttrs,
     Cursor,
     IsolationLevel,
+    LoadBalanceHosts,
     QueryResult,
     ReadVariant,
     SingleQueryResult,
+    TargetSessionAttrs,
     Transaction,
     connect,
 )
@@ -24,6 +24,6 @@
     "IsolationLevel",
     "ReadVariant",
     "connect",
-    "ConnLoadBalanceHosts",
-    "ConnTargetSessionAttrs",
+    "LoadBalanceHosts",
+    "TargetSessionAttrs",
 ]

python/psqlpy/_internal/__init__.pyi

@@ -104,15 +104,15 @@ class IsolationLevel(Enum):
     RepeatableRead = 3
     Serializable = 4
 
-class ConnLoadBalanceHosts(Enum):
+class LoadBalanceHosts(Enum):
     """Load balancing configuration."""
 
     # Make connection attempts to hosts in the order provided.
     Disable = 1
     # Make connection attempts to hosts in a random order.
     Random = 2
 
-class ConnTargetSessionAttrs(Enum):
+class TargetSessionAttrs(Enum):
     """Properties required of a session."""
 
     # No special properties are required.
@@ -891,7 +891,7 @@ class ConnectionPool:
         port: Optional[int] = None,
         ports: Optional[List[int]] = None,
         db_name: Optional[str] = None,
-        target_session_attrs: Optional[ConnTargetSessionAttrs] = None,
+        target_session_attrs: Optional[TargetSessionAttrs] = None,
         options: Optional[str] = None,
         application_name: Optional[str] = None,
         connect_timeout_sec: Optional[int] = None,
@@ -904,7 +904,7 @@ class ConnectionPool:
         keepalives_interval_sec: Optional[int] = None,
         keepalives_interval_nanosec: Optional[int] = None,
         keepalives_retries: Optional[int] = None,
-        load_balance_hosts: Optional[ConnLoadBalanceHosts] = None,
+        load_balance_hosts: Optional[LoadBalanceHosts] = None,
         max_db_pool_size: int = 2,
         conn_recycling_method: Optional[ConnRecyclingMethod] = None,
     ) -> None:
@@ -1028,7 +1028,7 @@ def connect(
     port: Optional[int] = None,
     ports: Optional[List[int]] = None,
     db_name: Optional[str] = None,
-    target_session_attrs: Optional[ConnTargetSessionAttrs] = None,
+    target_session_attrs: Optional[TargetSessionAttrs] = None,
     options: Optional[str] = None,
     application_name: Optional[str] = None,
     connect_timeout_sec: Optional[int] = None,
@@ -1041,7 +1041,7 @@ def connect(
     keepalives_interval_sec: Optional[int] = None,
     keepalives_interval_nanosec: Optional[int] = None,
     keepalives_retries: Optional[int] = None,
-    load_balance_hosts: Optional[ConnLoadBalanceHosts] = None,
+    load_balance_hosts: Optional[LoadBalanceHosts] = None,
     max_db_pool_size: int = 2,
     conn_recycling_method: Optional[ConnRecyclingMethod] = None,
 ) -> ConnectionPool:

python/tests/test_connection_pool.py

@@ -3,10 +3,10 @@
 from psqlpy import (
     Connection,
     ConnectionPool,
-    ConnLoadBalanceHosts,
     ConnRecyclingMethod,
-    ConnTargetSessionAttrs,
+    LoadBalanceHosts,
     QueryResult,
+    TargetSessionAttrs,
     connect,
 )
 from psqlpy.exceptions import DBPoolConfigurationError, RustPSQLDriverPyBaseError
@@ -102,13 +102,13 @@ async def test_build_pool_failure() -> None:
 @pytest.mark.parametrize(
     "target_session_attrs",
     [
-        ConnTargetSessionAttrs.Any,
-        ConnTargetSessionAttrs.ReadWrite,
-        ConnTargetSessionAttrs.ReadOnly,
+        TargetSessionAttrs.Any,
+        TargetSessionAttrs.ReadWrite,
+        TargetSessionAttrs.ReadOnly,
     ],
 )
 async def test_pool_target_session_attrs(
-    target_session_attrs: ConnTargetSessionAttrs,
+    target_session_attrs: TargetSessionAttrs,
 ) -> None:
     pg_pool = ConnectionPool(
         db_name="psqlpy_test",
@@ -118,7 +118,7 @@ async def test_pool_target_session_attrs(
         target_session_attrs=target_session_attrs,
     )
 
-    if target_session_attrs == ConnTargetSessionAttrs.ReadOnly:
+    if target_session_attrs == TargetSessionAttrs.ReadOnly:
         with pytest.raises(expected_exception=RustPSQLDriverPyBaseError):
             await pg_pool.execute("SELECT 1")
     else:
@@ -128,12 +128,12 @@ async def test_pool_target_session_attrs(
 @pytest.mark.parametrize(
     "load_balance_hosts",
     [
-        ConnLoadBalanceHosts.Disable,
-        ConnLoadBalanceHosts.Random,
+        LoadBalanceHosts.Disable,
+        LoadBalanceHosts.Random,
     ],
 )
 async def test_pool_load_balance_hosts(
-    load_balance_hosts: ConnLoadBalanceHosts,
+    load_balance_hosts: LoadBalanceHosts,
 ) -> None:
     pg_pool = ConnectionPool(
         dsn="postgres://postgres:postgres@localhost:5432/psqlpy_test",

src/driver/common_options.rs

@@ -1,6 +1,5 @@
 use deadpool_postgres::RecyclingMethod;
 use pyo3::pyclass;
-use tokio_postgres::config::{LoadBalanceHosts, TargetSessionAttrs};
 
 #[pyclass]
 #[derive(Clone, Copy)]
@@ -23,26 +22,26 @@ impl ConnRecyclingMethod {
 
 #[pyclass]
 #[derive(Clone, Copy)]
-pub enum ConnLoadBalanceHosts {
+pub enum LoadBalanceHosts {
     /// Make connection attempts to hosts in the order provided.
     Disable,
     /// Make connection attempts to hosts in a random order.
     Random,
 }
 
-impl ConnLoadBalanceHosts {
+impl LoadBalanceHosts {
     #[must_use]
-    pub fn to_internal(&self) -> LoadBalanceHosts {
+    pub fn to_internal(&self) -> tokio_postgres::config::LoadBalanceHosts {
         match self {
-            ConnLoadBalanceHosts::Disable => LoadBalanceHosts::Disable,
-            ConnLoadBalanceHosts::Random => LoadBalanceHosts::Random,
+            LoadBalanceHosts::Disable => tokio_postgres::config::LoadBalanceHosts::Disable,
+            LoadBalanceHosts::Random => tokio_postgres::config::LoadBalanceHosts::Random,
         }
     }
 }
 
 #[pyclass]
 #[derive(Clone, Copy)]
-pub enum ConnTargetSessionAttrs {
+pub enum TargetSessionAttrs {
     /// No special properties are required.
     Any,
     /// The session must allow writes.
@@ -51,13 +50,13 @@ pub enum ConnTargetSessionAttrs {
     ReadOnly,
 }
 
-impl ConnTargetSessionAttrs {
+impl TargetSessionAttrs {
     #[must_use]
-    pub fn to_internal(&self) -> TargetSessionAttrs {
+    pub fn to_internal(&self) -> tokio_postgres::config::TargetSessionAttrs {
         match self {
-            ConnTargetSessionAttrs::Any => TargetSessionAttrs::Any,
-            ConnTargetSessionAttrs::ReadWrite => TargetSessionAttrs::ReadWrite,
-            ConnTargetSessionAttrs::ReadOnly => TargetSessionAttrs::ReadOnly,
+            TargetSessionAttrs::Any => tokio_postgres::config::TargetSessionAttrs::Any,
+            TargetSessionAttrs::ReadWrite => tokio_postgres::config::TargetSessionAttrs::ReadWrite,
+            TargetSessionAttrs::ReadOnly => tokio_postgres::config::TargetSessionAttrs::ReadOnly,
         }
     }
 }

src/driver/connection_pool.rs

@@ -11,7 +11,7 @@ use crate::{
 };
 
 use super::{
-    common_options::{ConnLoadBalanceHosts, ConnRecyclingMethod, ConnTargetSessionAttrs},
+    common_options::{ConnRecyclingMethod, LoadBalanceHosts, TargetSessionAttrs},
     connection::Connection,
     utils::build_connection_config,
 };
@@ -31,7 +31,7 @@ pub fn connect(
     port: Option<u16>,
     ports: Option<Vec<u16>>,
     db_name: Option<String>,
-    target_session_attrs: Option<ConnTargetSessionAttrs>,
+    target_session_attrs: Option<TargetSessionAttrs>,
     options: Option<String>,
     application_name: Option<String>,
     connect_timeout_sec: Option<u64>,
@@ -44,7 +44,7 @@ pub fn connect(
     keepalives_interval_sec: Option<u64>,
     keepalives_interval_nanosec: Option<u32>,
     keepalives_retries: Option<u32>,
-    load_balance_hosts: Option<ConnLoadBalanceHosts>,
+    load_balance_hosts: Option<LoadBalanceHosts>,
 
     max_db_pool_size: Option<usize>,
     conn_recycling_method: Option<ConnRecyclingMethod>,
@@ -124,7 +124,7 @@ impl ConnectionPool {
         port: Option<u16>,
         ports: Option<Vec<u16>>,
         db_name: Option<String>,
-        target_session_attrs: Option<ConnTargetSessionAttrs>,
+        target_session_attrs: Option<TargetSessionAttrs>,
         options: Option<String>,
         application_name: Option<String>,
         connect_timeout_sec: Option<u64>,
@@ -137,7 +137,7 @@ impl ConnectionPool {
         keepalives_interval_sec: Option<u64>,
         keepalives_interval_nanosec: Option<u32>,
         keepalives_retries: Option<u32>,
-        load_balance_hosts: Option<ConnLoadBalanceHosts>,
+        load_balance_hosts: Option<LoadBalanceHosts>,
         max_db_pool_size: Option<usize>,
         conn_recycling_method: Option<ConnRecyclingMethod>,
     ) -> RustPSQLDriverPyResult<Self> {

src/driver/utils.rs

@@ -2,7 +2,7 @@ use std::{str::FromStr, time::Duration};
 
 use crate::exceptions::rust_errors::{RustPSQLDriverError, RustPSQLDriverPyResult};
 
-use super::common_options::{ConnLoadBalanceHosts, ConnTargetSessionAttrs};
+use super::common_options::{LoadBalanceHosts, TargetSessionAttrs};
 
 /// Create new config.
 ///
@@ -18,7 +18,7 @@ pub fn build_connection_config(
     port: Option<u16>,
     ports: Option<Vec<u16>>,
     db_name: Option<String>,
-    target_session_attrs: Option<ConnTargetSessionAttrs>,
+    target_session_attrs: Option<TargetSessionAttrs>,
     options: Option<String>,
     application_name: Option<String>,
     connect_timeout_sec: Option<u64>,
@@ -31,7 +31,7 @@ pub fn build_connection_config(
     keepalives_interval_sec: Option<u64>,
     keepalives_interval_nanosec: Option<u32>,
     keepalives_retries: Option<u32>,
-    load_balance_hosts: Option<ConnLoadBalanceHosts>,
+    load_balance_hosts: Option<LoadBalanceHosts>,
 ) -> RustPSQLDriverPyResult<tokio_postgres::Config> {
     if tcp_user_timeout_nanosec.is_some() && tcp_user_timeout_sec.is_none() {
         return Err(RustPSQLDriverError::DataBasePoolConfigurationError(

src/lib.rs

@@ -23,8 +23,8 @@ fn psqlpy(py: Python<'_>, pymod: &Bound<'_, PyModule>) -> PyResult<()> {
     pymod.add_class::<driver::transaction_options::IsolationLevel>()?;
     pymod.add_class::<driver::transaction_options::ReadVariant>()?;
     pymod.add_class::<driver::common_options::ConnRecyclingMethod>()?;
-    pymod.add_class::<driver::common_options::ConnLoadBalanceHosts>()?;
-    pymod.add_class::<driver::common_options::ConnTargetSessionAttrs>()?;
+    pymod.add_class::<driver::common_options::LoadBalanceHosts>()?;
+    pymod.add_class::<driver::common_options::TargetSessionAttrs>()?;
     pymod.add_class::<query_result::PSQLDriverPyQueryResult>()?;
     pymod.add_class::<query_result::PSQLDriverSinglePyQueryResult>()?;
     add_module(py, pymod, "extra_types", extra_types_module)?;