From b65e0428b3336cde46e389a36ee94d89368673e6 Mon Sep 17 00:00:00 2001 From: Vishal Anand <101251245+vishale6x@users.noreply.github.com> Date: Wed, 23 Jul 2025 22:12:19 +0530 Subject: [PATCH 1/2] Doc updated. --- README.md | 51 +++++++++++++++++++++++++- e6data_python_connector/e6data_grpc.py | 3 ++ 2 files changed, 53 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8fc89b9..87db824 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # e6data Python Connector -![version](https://img.shields.io/badge/version-2.3.7-blue.svg) +![version](https://img.shields.io/badge/version-2.3.8-blue.svg) ## Introduction @@ -55,6 +55,55 @@ conn = Connection( ) ``` +#### Connection Parameters + +The `Connection` class supports the following parameters: + +| Parameter | Type | Required | Default | Description | +|-----------|------|----------|---------|-------------| +| `host` | str | Yes | - | IP address or hostname of the e6data cluster | +| `port` | int | Yes | - | Port of the e6data engine (typically 80) | +| `username` | str | Yes | - | Your e6data Email ID | +| `password` | str | Yes | - | Access Token generated in the e6data console | +| `database` | str | No | None | Database to perform queries on | +| `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 | +| `auto_resume` | bool | No | True | Automatically resume cluster if suspended | +| `grpc_options` | dict | No | None | Additional gRPC configuration options | + +#### Secure Connection Example + +To establish a secure connection using SSL/TLS: + +```python +conn = Connection( + host=host, + port=443, # Typically 443 for secure connections + username=username, + password=password, + database=database, + cluster_name='production-cluster', + secure=True # Enable SSL/TLS +) +``` + +#### Cluster-Specific Connection + +When working with multiple clusters, specify the cluster name: + +```python +conn = Connection( + host=host, + port=port, + username=username, + password=password, + database=database, + cluster_name='analytics-cluster-01', # Specify cluster name + secure=True +) +``` + ### Perform a Queries & Get Results ```python diff --git a/e6data_python_connector/e6data_grpc.py b/e6data_python_connector/e6data_grpc.py index 7de6a55..68d7bd4 100644 --- a/e6data_python_connector/e6data_grpc.py +++ b/e6data_python_connector/e6data_grpc.py @@ -317,6 +317,7 @@ def __init__( cluster_name: str = None, secure: bool = False, auto_resume: bool = True, + scheme: str = 'e6data', grpc_options: dict = None, ): """ @@ -340,6 +341,8 @@ def __init__( Flag to use a secure channel for data transfer auto_resume: bool, Optional Flag to enable auto resume of the cluster before the query execution + scheme: string, Optional + e6data supported scheme grpc_options: dict, Optional Specify gRPC configuration - keepalive_timeout_ms: This parameter defines the time, in milliseconds, that a gRPC connection should remain idle before sending a keepalive ping to check if the connection is still alive. From 4da1990fdd943c8ec18e18900a5622585d6eba84 Mon Sep 17 00:00:00 2001 From: Vishal Anand <101251245+vishale6x@users.noreply.github.com> Date: Wed, 23 Jul 2025 22:30:02 +0530 Subject: [PATCH 2/2] Doc updated. --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index f59c570..7acc7df 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ import setuptools -VERSION = (2, 3, 7,) +VERSION = (2, 3, 8,) def get_long_desc():