e6data-python-connector 2.3.12rc31__tar.gz → 2.3.12rc32__tar.gz

{e6data_python_connector-2.3.12rc31/e6data_python_connector.egg-info → e6data_python_connector-2.3.12rc32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: e6data-python-connector
-Version: 2.3.12rc31
+Version: 2.3.12rc32
 Summary: Client for the e6data distributed SQL Engine.
 Home-page: https://github.com/e6x-labs/e6data-python-connector
 Author: e6data, Inc.
@@ -39,7 +39,7 @@ Dynamic: summary
 
 # e6data Python Connector
 
-![version](https://img.shields.io/badge/version-2.3.12rc31-blue.svg)
+![version](https://img.shields.io/badge/version-2.3.12rc32-blue.svg)
 
 ## Introduction
 
@@ -122,6 +122,7 @@ The `Connection` class supports the following parameters:
 | `catalog` | str | No | None | Catalog name |
 | `cluster_name` | str | No | None | Name of the cluster for cluster-specific operations |
 | `secure` | bool | No | False | Enable SSL/TLS for secure connections |
+| `ssl_cert` | str/bytes | No | None | Path to CA certificate (PEM) or certificate bytes for HTTPS connections |
 | `auto_resume` | bool | No | True | Automatically resume cluster if suspended |
 | `grpc_options` | dict | No | None | Additional gRPC configuration options |
 | `debug` | bool | No | False | Enable debug logging for troubleshooting |
@@ -159,6 +160,72 @@ conn = Connection(
 )
 ```
 
+#### HTTPS Connection with HAProxy
+
+When connecting through HAProxy with HTTPS, you can provide a custom CA certificate for secure connections. The `ssl_cert` parameter accepts either a file path to a PEM certificate or the certificate content as bytes.
+
+**Using a CA certificate file path:**
+
+```python
+conn = Connection(
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # Path to your CA certificate
+)
+```
+
+**Reading certificate content as bytes:**
+
+```python
+# Read certificate file and pass as bytes
+with open('/path/to/ca-cert.pem', 'rb') as cert_file:
+    cert_data = cert_file.read()
+
+conn = Connection(
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert=cert_data  # Certificate content as bytes
+)
+```
+
+**Using system CA bundle for publicly signed certificates:**
+
+```python
+# When ssl_cert is None, system default CA bundle is used
+conn = Connection(
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True  # Uses system CA bundle by default
+)
+```
+
+**Connection pooling with custom CA certificate:**
+
+```python
+pool = ConnectionPool(
+    min_size=2,
+    max_size=10,
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # Custom CA certificate for pool connections
+)
+```
+
 #### Handling Missing System Dependencies
 
 The e6data connector uses the `fastbinary` module (from Apache Thrift) for optimal performance when deserializing data. This module requires system-level dependencies (`python3-devel` and `gcc-c++`) to be installed.

{e6data_python_connector-2.3.12rc31 → e6data_python_connector-2.3.12rc32}/README.md

@@ -1,6 +1,6 @@
 # e6data Python Connector
 
-![version](https://img.shields.io/badge/version-2.3.12rc31-blue.svg)
+![version](https://img.shields.io/badge/version-2.3.12rc32-blue.svg)
 
 ## Introduction
 
@@ -83,6 +83,7 @@ The `Connection` class supports the following parameters:
 | `catalog` | str | No | None | Catalog name |
 | `cluster_name` | str | No | None | Name of the cluster for cluster-specific operations |
 | `secure` | bool | No | False | Enable SSL/TLS for secure connections |
+| `ssl_cert` | str/bytes | No | None | Path to CA certificate (PEM) or certificate bytes for HTTPS connections |
 | `auto_resume` | bool | No | True | Automatically resume cluster if suspended |
 | `grpc_options` | dict | No | None | Additional gRPC configuration options |
 | `debug` | bool | No | False | Enable debug logging for troubleshooting |
@@ -120,6 +121,72 @@ conn = Connection(
 )
 ```
 
+#### HTTPS Connection with HAProxy
+
+When connecting through HAProxy with HTTPS, you can provide a custom CA certificate for secure connections. The `ssl_cert` parameter accepts either a file path to a PEM certificate or the certificate content as bytes.
+
+**Using a CA certificate file path:**
+
+```python
+conn = Connection(
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # Path to your CA certificate
+)
+```
+
+**Reading certificate content as bytes:**
+
+```python
+# Read certificate file and pass as bytes
+with open('/path/to/ca-cert.pem', 'rb') as cert_file:
+    cert_data = cert_file.read()
+
+conn = Connection(
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert=cert_data  # Certificate content as bytes
+)
+```
+
+**Using system CA bundle for publicly signed certificates:**
+
+```python
+# When ssl_cert is None, system default CA bundle is used
+conn = Connection(
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True  # Uses system CA bundle by default
+)
+```
+
+**Connection pooling with custom CA certificate:**
+
+```python
+pool = ConnectionPool(
+    min_size=2,
+    max_size=10,
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # Custom CA certificate for pool connections
+)
+```
+
 #### Handling Missing System Dependencies
 
 The e6data connector uses the `fastbinary` module (from Apache Thrift) for optimal performance when deserializing data. This module requires system-level dependencies (`python3-devel` and `gcc-c++`) to be installed.

{e6data_python_connector-2.3.12rc31 → e6data_python_connector-2.3.12rc32}/e6data_python_connector/cluster_manager.py

@@ -140,7 +140,7 @@ class ClusterManager:
     """
 
     def __init__(self, host: str, port: int, user: str, password: str, secure_channel: bool = False, timeout=60 * 5,
-                 cluster_uuid=None, grpc_options=None, debug=False):
+                 cluster_uuid=None, grpc_options=None, debug=False, ssl_cert=None):
         """
         Initializes a new instance of the ClusterManager class.
 
@@ -156,6 +156,8 @@ class ClusterManager:
             cluster_uuid (str, optional): The unique identifier for the target cluster;
                 defaults to None.
             debug (bool, optional): Enable debug logging; defaults to False.
+            ssl_cert (str or bytes, optional): Path to CA certificate file (PEM format) or
+                certificate content as bytes for secure connections; defaults to None.
         """
 
         self._host = host
@@ -169,6 +171,46 @@ class ClusterManager:
         if grpc_options is None:
             self._grpc_options = dict()
         self._debug = debug
+        self._ssl_cert = ssl_cert
+
+    def _get_ssl_credentials(self):
+        """
+        Get SSL credentials for secure gRPC channel.
+
+        Handles three scenarios:
+        1. ssl_cert is a string (file path): Read the PEM certificate from the file
+        2. ssl_cert is bytes: Use the certificate content directly
+        3. ssl_cert is None: Use system default CA bundle
+
+        Returns:
+            grpc.ChannelCredentials: SSL credentials for secure channel
+
+        Raises:
+            FileNotFoundError: If ssl_cert is a file path but the file doesn't exist
+            IOError: If ssl_cert file cannot be read
+        """
+        if self._ssl_cert is None:
+            # Use system default CA bundle
+            return grpc.ssl_channel_credentials()
+        elif isinstance(self._ssl_cert, str):
+            # ssl_cert is a file path - read the certificate from file
+            try:
+                with open(self._ssl_cert, 'rb') as cert_file:
+                    root_ca_cert = cert_file.read()
+                return grpc.ssl_channel_credentials(root_certificates=root_ca_cert)
+            except FileNotFoundError:
+                logger.error(f"SSL certificate file not found: {self._ssl_cert}")
+                raise
+            except IOError as e:
+                logger.error(f"Failed to read SSL certificate file {self._ssl_cert}: {e}")
+                raise
+        elif isinstance(self._ssl_cert, bytes):
+            # ssl_cert is certificate content as bytes
+            return grpc.ssl_channel_credentials(root_certificates=self._ssl_cert)
+        else:
+            # Invalid type - log warning and use system default
+            logger.warning(f"Invalid ssl_cert type: {type(self._ssl_cert)}. Using system default CA bundle.")
+            return grpc.ssl_channel_credentials()
 
     @property
     def _get_connection(self):
@@ -184,7 +226,7 @@ class ClusterManager:
             self._channel = grpc.secure_channel(
                 target='{}:{}'.format(self._host, self._port),
                 options=self._grpc_options,
-                credentials=grpc.ssl_channel_credentials()
+                credentials=self._get_ssl_credentials()
             )
         else:
             self._channel = grpc.insecure_channel(

{e6data_python_connector-2.3.12rc31 → e6data_python_connector-2.3.12rc32}/e6data_python_connector/e6data_grpc.py

@@ -331,6 +331,7 @@ class Connection(object):
             database: str = None,
             cluster_name: str = None,
             secure: bool = False,
+            ssl_cert = None,
             auto_resume: bool = True,
             scheme: str = 'e6data',
             grpc_options: dict = None,
@@ -356,6 +357,9 @@ class Connection(object):
                 Cluster's name
             secure: bool, Optional
                 Flag to use a secure channel for data transfer
+            ssl_cert: str or bytes, Optional
+                Path to CA certificate file (PEM format) or certificate content as bytes for
+                secure connections. If None, system default CA bundle is used.
             auto_resume: bool, Optional
                 Flag to enable auto resume of the cluster before the query execution
             scheme: string, Optional
@@ -387,6 +391,7 @@ class Connection(object):
         self._port = port
 
         self._secure_channel = secure
+        self._ssl_cert = ssl_cert
 
         self.catalog_name = catalog
 
@@ -511,6 +516,45 @@ class Connection(object):
 
         return self._cached_grpc_options
 
+    def _get_ssl_credentials(self):
+        """
+        Get SSL credentials for secure gRPC channel.
+
+        Handles three scenarios:
+        1. ssl_cert is a string (file path): Read the PEM certificate from the file
+        2. ssl_cert is bytes: Use the certificate content directly
+        3. ssl_cert is None: Use system default CA bundle
+
+        Returns:
+            grpc.ChannelCredentials: SSL credentials for secure channel
+
+        Raises:
+            FileNotFoundError: If ssl_cert is a file path but the file doesn't exist
+            IOError: If ssl_cert file cannot be read
+        """
+        if self._ssl_cert is None:
+            # Use system default CA bundle
+            return grpc.ssl_channel_credentials()
+        elif isinstance(self._ssl_cert, str):
+            # ssl_cert is a file path - read the certificate from file
+            try:
+                with open(self._ssl_cert, 'rb') as cert_file:
+                    root_ca_cert = cert_file.read()
+                return grpc.ssl_channel_credentials(root_certificates=root_ca_cert)
+            except FileNotFoundError:
+                logger.error(f"SSL certificate file not found: {self._ssl_cert}")
+                raise
+            except IOError as e:
+                logger.error(f"Failed to read SSL certificate file {self._ssl_cert}: {e}")
+                raise
+        elif isinstance(self._ssl_cert, bytes):
+            # ssl_cert is certificate content as bytes
+            return grpc.ssl_channel_credentials(root_certificates=self._ssl_cert)
+        else:
+            # Invalid type - log warning and use system default
+            logger.warning(f"Invalid ssl_cert type: {type(self._ssl_cert)}. Using system default CA bundle.")
+            return grpc.ssl_channel_credentials()
+
     def _create_client(self):
         """
         Creates a gRPC client for the connection.
@@ -531,7 +575,7 @@ class Connection(object):
             self._channel = grpc.secure_channel(
                 target='{}:{}'.format(self._host, self._port),
                 options=self._get_grpc_options,
-                credentials=grpc.ssl_channel_credentials()
+                credentials=self._get_ssl_credentials()
             )
         else:
             self._channel = grpc.insecure_channel(
@@ -713,7 +757,8 @@ class Connection(object):
                     secure_channel=self._secure_channel,
                     cluster_uuid=self.cluster_name,
                     timeout=self.grpc_auto_resume_timeout_seconds,
-                    debug=self._debug
+                    debug=self._debug,
+                    ssl_cert=self._ssl_cert
                 ).resume()
                 return status  # Return boolean status directly
             else:

{e6data_python_connector-2.3.12rc31 → e6data_python_connector-2.3.12rc32/e6data_python_connector.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: e6data-python-connector
-Version: 2.3.12rc31
+Version: 2.3.12rc32
 Summary: Client for the e6data distributed SQL Engine.
 Home-page: https://github.com/e6x-labs/e6data-python-connector
 Author: e6data, Inc.
@@ -39,7 +39,7 @@ Dynamic: summary
 
 # e6data Python Connector
 
-![version](https://img.shields.io/badge/version-2.3.12rc31-blue.svg)
+![version](https://img.shields.io/badge/version-2.3.12rc32-blue.svg)
 
 ## Introduction
 
@@ -122,6 +122,7 @@ The `Connection` class supports the following parameters:
 | `catalog` | str | No | None | Catalog name |
 | `cluster_name` | str | No | None | Name of the cluster for cluster-specific operations |
 | `secure` | bool | No | False | Enable SSL/TLS for secure connections |
+| `ssl_cert` | str/bytes | No | None | Path to CA certificate (PEM) or certificate bytes for HTTPS connections |
 | `auto_resume` | bool | No | True | Automatically resume cluster if suspended |
 | `grpc_options` | dict | No | None | Additional gRPC configuration options |
 | `debug` | bool | No | False | Enable debug logging for troubleshooting |
@@ -159,6 +160,72 @@ conn = Connection(
 )
 ```
 
+#### HTTPS Connection with HAProxy
+
+When connecting through HAProxy with HTTPS, you can provide a custom CA certificate for secure connections. The `ssl_cert` parameter accepts either a file path to a PEM certificate or the certificate content as bytes.
+
+**Using a CA certificate file path:**
+
+```python
+conn = Connection(
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # Path to your CA certificate
+)
+```
+
+**Reading certificate content as bytes:**
+
+```python
+# Read certificate file and pass as bytes
+with open('/path/to/ca-cert.pem', 'rb') as cert_file:
+    cert_data = cert_file.read()
+
+conn = Connection(
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert=cert_data  # Certificate content as bytes
+)
+```
+
+**Using system CA bundle for publicly signed certificates:**
+
+```python
+# When ssl_cert is None, system default CA bundle is used
+conn = Connection(
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True  # Uses system CA bundle by default
+)
+```
+
+**Connection pooling with custom CA certificate:**
+
+```python
+pool = ConnectionPool(
+    min_size=2,
+    max_size=10,
+    host=host,
+    port=443,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # Custom CA certificate for pool connections
+)
+```
+
 #### Handling Missing System Dependencies
 
 The e6data connector uses the `fastbinary` module (from Apache Thrift) for optimal performance when deserializing data. This module requires system-level dependencies (`python3-devel` and `gcc-c++`) to be installed.

{e6data_python_connector-2.3.12rc31 → e6data_python_connector-2.3.12rc32}/setup.py

@@ -12,7 +12,7 @@
 
 import setuptools
 
-VERSION = (2, 3, 12, 'rc31',)
+VERSION = (2, 3, 12, 'rc32',)
 
 
 def get_long_desc():