e6data-python-connector 2.3.12rc11__tar.gz → 2.3.12rc12__tar.gz

{e6data_python_connector-2.3.12rc11/e6data_python_connector.egg-info → e6data_python_connector-2.3.12rc12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: e6data-python-connector
-Version: 2.3.12rc11
+Version: 2.3.12rc12
 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.12rc11-blue.svg)
+![version](https://img.shields.io/badge/version-2.3.12rc12-blue.svg)
 
 ## Introduction
 
@@ -125,6 +125,7 @@ The `Connection` class supports the following parameters:
 | `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 |
+| `ssl_cert` | str/bytes | No | None | Path to CA certificate (PEM) or certificate bytes for HTTPS connections |
 
 #### Secure Connection Example
 
@@ -142,6 +143,52 @@ conn = Connection(
 )
 ```
 
+#### HTTPS Connection with HAProxy
+
+When connecting through HAProxy with HTTPS/TLS and custom CA certificates:
+
+```python
+from e6data_python_connector import Connection
+
+# Option 1: Using CA certificate file path
+conn = Connection(
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    cluster_name='analytics-cluster-01',  # Specify cluster name
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # Path to CA certificate
+)
+
+# Option 2: Reading certificate content as bytes
+with open('/path/to/ca-cert.pem', 'rb') as f:
+    ca_cert = f.read()
+
+conn = Connection(
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert=ca_cert  # Certificate as bytes
+)
+
+# Option 3: System CA bundle (for publicly signed certificates)
+conn = Connection(
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    secure=True  # Uses system CA bundle
+)
+```
+
+**Note:** Certificate verification is always enabled for security. For self-signed certificates, provide the CA certificate via the `ssl_cert` parameter.
+
 #### Cluster-Specific Connection
 
 When working with multiple clusters, specify the cluster name:
@@ -504,6 +551,35 @@ pool.return_connection(conn)
 pool.close_all()
 ```
 
+##### Connection Pool with HTTPS (HAProxy)
+
+```python
+from e6data_python_connector import ConnectionPool
+
+# Connection pool with HTTPS and custom CA certificate
+pool = ConnectionPool(
+   min_size=2,
+    max_size=10,
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # CA certificate for HTTPS
+)
+
+# Use the pool with context manager for automatic cleanup
+with pool.get_connection_context() as conn:
+    cursor = conn.cursor()
+    cursor.execute("SELECT * FROM table")
+    results = cursor.fetchall()
+    print(f"Retrieved {len(results)} rows")
+
+# Clean up pool when done
+pool.close_all()
+```
+
 ##### Using Context Manager (Recommended)
 
 The context manager pattern ensures connections are automatically returned to the pool:

{e6data_python_connector-2.3.12rc11 → e6data_python_connector-2.3.12rc12}/README.md

@@ -1,6 +1,6 @@
 # e6data Python Connector
 
-![version](https://img.shields.io/badge/version-2.3.12rc11-blue.svg)
+![version](https://img.shields.io/badge/version-2.3.12rc12-blue.svg)
 
 ## Introduction
 
@@ -86,6 +86,7 @@ The `Connection` class supports the following parameters:
 | `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 |
+| `ssl_cert` | str/bytes | No | None | Path to CA certificate (PEM) or certificate bytes for HTTPS connections |
 
 #### Secure Connection Example
 
@@ -103,6 +104,52 @@ conn = Connection(
 )
 ```
 
+#### HTTPS Connection with HAProxy
+
+When connecting through HAProxy with HTTPS/TLS and custom CA certificates:
+
+```python
+from e6data_python_connector import Connection
+
+# Option 1: Using CA certificate file path
+conn = Connection(
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    cluster_name='analytics-cluster-01',  # Specify cluster name
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # Path to CA certificate
+)
+
+# Option 2: Reading certificate content as bytes
+with open('/path/to/ca-cert.pem', 'rb') as f:
+    ca_cert = f.read()
+
+conn = Connection(
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert=ca_cert  # Certificate as bytes
+)
+
+# Option 3: System CA bundle (for publicly signed certificates)
+conn = Connection(
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    secure=True  # Uses system CA bundle
+)
+```
+
+**Note:** Certificate verification is always enabled for security. For self-signed certificates, provide the CA certificate via the `ssl_cert` parameter.
+
 #### Cluster-Specific Connection
 
 When working with multiple clusters, specify the cluster name:
@@ -465,6 +512,35 @@ pool.return_connection(conn)
 pool.close_all()
 ```
 
+##### Connection Pool with HTTPS (HAProxy)
+
+```python
+from e6data_python_connector import ConnectionPool
+
+# Connection pool with HTTPS and custom CA certificate
+pool = ConnectionPool(
+   min_size=2,
+    max_size=10,
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # CA certificate for HTTPS
+)
+
+# Use the pool with context manager for automatic cleanup
+with pool.get_connection_context() as conn:
+    cursor = conn.cursor()
+    cursor.execute("SELECT * FROM table")
+    results = cursor.fetchall()
+    print(f"Retrieved {len(results)} rows")
+
+# Clean up pool when done
+pool.close_all()
+```
+
 ##### Using Context Manager (Recommended)
 
 The context manager pattern ensures connections are automatically returned to the pool:

{e6data_python_connector-2.3.12rc11 → e6data_python_connector-2.3.12rc12}/e6data_python_connector/cluster_manager.py

@@ -1,6 +1,7 @@
 import logging
 import threading
 import time
+from typing import Optional, Union
 import e6data_python_connector.cluster_server.cluster_pb2 as cluster_pb2
 import e6data_python_connector.cluster_server.cluster_pb2_grpc as cluster_pb2_grpc
 import grpc
@@ -140,7 +141,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: Optional[Union[str, bytes]] = None):
         """
         Initializes a new instance of the ClusterManager class.
 
@@ -155,7 +156,12 @@ class ClusterManager:
                 defaults to 5 minutes.
             cluster_uuid (str, optional): The unique identifier for the target cluster;
                 defaults to None.
+            grpc_options (dict, optional): Additional gRPC configuration options;
+                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. Used when secure_channel=True.
+                If not provided and secure_channel=True, system default CA bundle will be used.
         """
 
         self._host = host
@@ -164,12 +170,67 @@ class ClusterManager:
         self._password = password
         self._timeout = time.time() + timeout
         self._secure_channel = secure_channel
+        self._ssl_cert = ssl_cert
         self.cluster_uuid = cluster_uuid
         self._grpc_options = grpc_options
         if grpc_options is None:
             self._grpc_options = dict()
         self._debug = debug
 
+    def _get_ssl_credentials(self):
+        """
+        Creates SSL/TLS credentials for secure gRPC connections.
+
+        This method handles loading CA certificates from various sources:
+        - File path (str): Reads the certificate from the specified file
+        - Bytes: Uses the certificate content directly
+        - None: Uses system default CA bundle
+
+        Returns:
+            grpc.ChannelCredentials: SSL credentials for secure channel creation
+
+        Raises:
+            FileNotFoundError: If ssl_cert is a file path and the file doesn't exist
+            ValueError: If ssl_cert format is invalid or file cannot be read
+        """
+        root_certificates = None
+
+        if self._ssl_cert:
+            # Custom CA certificate provided
+            if isinstance(self._ssl_cert, str):
+                # It's a file path - read the certificate
+                try:
+                    with open(self._ssl_cert, 'rb') as f:
+                        root_certificates = f.read()
+                    if self._debug:
+                        logger.info(f"ClusterManager: Loaded CA certificate from file: {self._ssl_cert}")
+                except FileNotFoundError:
+                    raise FileNotFoundError(
+                        f"CA certificate file not found: {self._ssl_cert}. "
+                        f"Please ensure the file exists and the path is correct."
+                    )
+                except Exception as e:
+                    raise ValueError(
+                        f"Failed to read CA certificate from {self._ssl_cert}: {str(e)}"
+                    )
+            elif isinstance(self._ssl_cert, bytes):
+                # Certificate content provided as bytes
+                root_certificates = self._ssl_cert
+                if self._debug:
+                    logger.info("ClusterManager: Using CA certificate provided as bytes")
+            else:
+                raise ValueError(
+                    f"ssl_cert must be either a file path (str) or certificate content (bytes), "
+                    f"got {type(self._ssl_cert)}"
+                )
+        else:
+            # No custom CA certificate - use system default CA bundle
+            if self._debug:
+                logger.info("ClusterManager: Using system default CA bundle for SSL/TLS")
+
+        # Create and return SSL credentials with certificate verification enabled
+        return grpc.ssl_channel_credentials(root_certificates=root_certificates)
+
     @property
     def _get_connection(self):
         """
@@ -181,16 +242,29 @@ class ClusterManager:
         """
 
         if self._secure_channel:
+            # Get SSL credentials (handles CA cert loading and validation)
+            credentials = self._get_ssl_credentials()
+
             self._channel = grpc.secure_channel(
                 target='{}:{}'.format(self._host, self._port),
                 options=self._grpc_options,
-                credentials=grpc.ssl_channel_credentials()
+                credentials=credentials
             )
+
+            if self._debug:
+                logger.info(
+                    f"ClusterManager: Created secure gRPC channel to {self._host}:{self._port} "
+                    f"with SSL/TLS certificate verification enabled"
+                )
         else:
             self._channel = grpc.insecure_channel(
                 target='{}:{}'.format(self._host, self._port),
                 options=self._grpc_options
             )
+
+            if self._debug:
+                logger.info(f"ClusterManager: Created insecure gRPC channel to {self._host}:{self._port}")
+
         return cluster_pb2_grpc.ClusterServiceStub(self._channel)
 
     def _try_cluster_request(self, request_type, payload=None):

{e6data_python_connector-2.3.12rc11 → e6data_python_connector-2.3.12rc12}/e6data_python_connector/e6data_grpc.py

@@ -16,6 +16,7 @@ import time
 from decimal import Decimal
 from io import BytesIO
 from ssl import CERT_NONE, CERT_OPTIONAL, CERT_REQUIRED
+from typing import Union, Optional
 import threading
 import multiprocessing
 
@@ -335,6 +336,7 @@ class Connection(object):
             scheme: str = 'e6data',
             grpc_options: dict = None,
             debug: bool = False,
+            ssl_cert: Optional[Union[str, bytes]] = None,
     ):
         """
         Parameters
@@ -368,6 +370,14 @@ class Connection(object):
                 - keepalive_time_ms: This parameter defines the time, in milliseconds, Default to 30 seconds
             debug: bool, Optional
                 Flag to enable debug logging for blue-green deployment strategy changes
+            ssl_cert: str or bytes, Optional
+                Path to CA certificate file (PEM format) or certificate content as bytes.
+                Used when connecting via HTTPS .
+                If not provided and secure=True, system default CA bundle will be used.
+                For self-signed certificates, provide the CA certificate via this parameter.
+                Examples:
+                    - File path: ssl_cert='/path/to/ca-cert.pem'
+                    - Bytes: ssl_cert=open('/path/to/ca-cert.pem', 'rb').read()
         """
         if not username or not password:
             raise ValueError("username or password cannot be empty.")
@@ -382,6 +392,7 @@ class Connection(object):
         self._port = port
 
         self._secure_channel = secure
+        self._ssl_cert = ssl_cert
 
         self.catalog_name = catalog
 
@@ -483,6 +494,60 @@ class Connection(object):
 
         return self._cached_grpc_options
 
+    def _get_ssl_credentials(self):
+        """
+        Creates SSL/TLS credentials for secure gRPC connections.
+
+        This method handles loading CA certificates from various sources:
+        - File path (str): Reads the certificate from the specified file
+        - Bytes: Uses the certificate content directly
+        - None: Uses system default CA bundle
+
+        Returns:
+            grpc.ChannelCredentials: SSL credentials for secure channel creation
+
+        Raises:
+            FileNotFoundError: If ssl_cert is a file path and the file doesn't exist
+            ValueError: If ssl_cert format is invalid or file cannot be read
+        """
+        root_certificates = None
+
+        if self._ssl_cert:
+            # Custom CA certificate provided
+            if isinstance(self._ssl_cert, str):
+                # It's a file path - read the certificate
+                try:
+                    with open(self._ssl_cert, 'rb') as f:
+                        root_certificates = f.read()
+                    if self._debug:
+                        logger.info(f"Loaded CA certificate from file: {self._ssl_cert}")
+                except FileNotFoundError:
+                    raise FileNotFoundError(
+                        f"CA certificate file not found: {self._ssl_cert}. "
+                        f"Please ensure the file exists and the path is correct."
+                    )
+                except Exception as e:
+                    raise ValueError(
+                        f"Failed to read CA certificate from {self._ssl_cert}: {str(e)}"
+                    )
+            elif isinstance(self._ssl_cert, bytes):
+                # Certificate content provided as bytes
+                root_certificates = self._ssl_cert
+                if self._debug:
+                    logger.info("Using CA certificate provided as bytes")
+            else:
+                raise ValueError(
+                    f"ssl_cert must be either a file path (str) or certificate content (bytes), "
+                    f"got {type(self._ssl_cert)}"
+                )
+        else:
+            # No custom CA certificate - use system default CA bundle
+            if self._debug:
+                logger.info("Using system default CA bundle for SSL/TLS")
+
+        # Create and return SSL credentials with certificate verification enabled
+        return grpc.ssl_channel_credentials(root_certificates=root_certificates)
+
     def _create_client(self):
         """
         Creates a gRPC client for the connection.
@@ -497,13 +562,19 @@ class Connection(object):
 
         Raises:
             grpc.RpcError: If there is an error in creating the gRPC channel or client stub.
+            FileNotFoundError: If ssl_cert is a file path and the file doesn't exist.
+            ValueError: If ssl_cert format is invalid.
         """
 
         if self._secure_channel:
+            # Get SSL credentials (handles CA cert loading and validation)
+            credentials = self._get_ssl_credentials()
+
+            # Create secure channel
             self._channel = grpc.secure_channel(
                 target='{}:{}'.format(self._host, self._port),
                 options=self._get_grpc_options,
-                credentials=grpc.ssl_channel_credentials()
+                credentials=credentials
             )
         else:
             self._channel = grpc.insecure_channel(
@@ -685,7 +756,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:
@@ -853,56 +925,6 @@ class Connection(object):
         )
         return dry_run_response.dryrunValue
 
-    def get_logical_plan(self, query, catalog=None, schema=None):
-        """
-        Gets the logical execution plan for a query without executing it.
-        This method performs syntax, parsing, and plan compilation, then returns the logical plan.
-
-        Args:
-            query (str): The SQL query to get the plan for.
-            catalog (str, optional): Catalog name. Uses connection's catalog if not provided.
-            schema (str, optional): Schema/database name. Uses connection's database if not provided.
-
-        Returns:
-            dict: A dictionary with:
-                - 'success' (bool): True if plan generation succeeded, False otherwise
-                - 'plan' (str, optional): The logical plan string if successful
-                - 'error' (str, optional): Error message if plan generation failed
-
-        Example:
-            >>> result = conn.get_logical_plan("SELECT * FROM table")
-            >>> if result['success']:
-            ...     print(f"Plan: {result['plan']}")
-            >>> else:
-            ...     print(f"Error: {result['error']}")
-        """
-        catalog_to_use = catalog if catalog is not None else self.catalog_name
-        schema_to_use = schema if schema is not None else self.database
-        
-        try:
-            dry_run_request = e6x_engine_pb2.DryRunRequestV2(
-                sessionId=self.get_session_id,
-                schema=schema_to_use,
-                catalog=catalog_to_use,
-                queryString=query
-            )
-            
-            dry_run_response = self._client.dryRunV2(
-                dry_run_request,
-                metadata=_get_grpc_header(cluster=self.cluster_name, strategy=_get_active_strategy())
-            )
-            
-            return {
-                'success': True,
-                'plan': dry_run_response.dryrunValue
-            }
-            
-        except Exception as e:
-            return {
-                'success': False,
-                'error': str(e)
-            } 
-
     def get_tables(self, catalog, database):
         """
         Retrieves the list of tables from the specified catalog and database.

{e6data_python_connector-2.3.12rc11 → e6data_python_connector-2.3.12rc12/e6data_python_connector.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: e6data-python-connector
-Version: 2.3.12rc11
+Version: 2.3.12rc12
 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.12rc11-blue.svg)
+![version](https://img.shields.io/badge/version-2.3.12rc12-blue.svg)
 
 ## Introduction
 
@@ -125,6 +125,7 @@ The `Connection` class supports the following parameters:
 | `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 |
+| `ssl_cert` | str/bytes | No | None | Path to CA certificate (PEM) or certificate bytes for HTTPS connections |
 
 #### Secure Connection Example
 
@@ -142,6 +143,52 @@ conn = Connection(
 )
 ```
 
+#### HTTPS Connection with HAProxy
+
+When connecting through HAProxy with HTTPS/TLS and custom CA certificates:
+
+```python
+from e6data_python_connector import Connection
+
+# Option 1: Using CA certificate file path
+conn = Connection(
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    cluster_name='analytics-cluster-01',  # Specify cluster name
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # Path to CA certificate
+)
+
+# Option 2: Reading certificate content as bytes
+with open('/path/to/ca-cert.pem', 'rb') as f:
+    ca_cert = f.read()
+
+conn = Connection(
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert=ca_cert  # Certificate as bytes
+)
+
+# Option 3: System CA bundle (for publicly signed certificates)
+conn = Connection(
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    secure=True  # Uses system CA bundle
+)
+```
+
+**Note:** Certificate verification is always enabled for security. For self-signed certificates, provide the CA certificate via the `ssl_cert` parameter.
+
 #### Cluster-Specific Connection
 
 When working with multiple clusters, specify the cluster name:
@@ -504,6 +551,35 @@ pool.return_connection(conn)
 pool.close_all()
 ```
 
+##### Connection Pool with HTTPS (HAProxy)
+
+```python
+from e6data_python_connector import ConnectionPool
+
+# Connection pool with HTTPS and custom CA certificate
+pool = ConnectionPool(
+   min_size=2,
+    max_size=10,
+    host=host,
+    port=port,
+    username=username,
+    password=password,
+    database=database,
+    secure=True,
+    ssl_cert='/path/to/ca-cert.pem'  # CA certificate for HTTPS
+)
+
+# Use the pool with context manager for automatic cleanup
+with pool.get_connection_context() as conn:
+    cursor = conn.cursor()
+    cursor.execute("SELECT * FROM table")
+    results = cursor.fetchall()
+    print(f"Retrieved {len(results)} rows")
+
+# Clean up pool when done
+pool.close_all()
+```
+
 ##### Using Context Manager (Recommended)
 
 The context manager pattern ensures connections are automatically returned to the pool:

{e6data_python_connector-2.3.12rc11 → e6data_python_connector-2.3.12rc12}/setup.py

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