Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions e6data_python_connector/e6data_grpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,7 @@ def __init__(
cluster_name: str = None,
secure: bool = False,
auto_resume: bool = True,
scheme: str = 'e6data',
grpc_options: dict = None,
):
"""
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

import setuptools

VERSION = (2, 3, 7,)
VERSION = (2, 3, 8,)


def get_long_desc():
Expand Down