e6data-python-connector 1.0.0__py3-none-any.whl

e6data_python_connector-1.0.0.dist-info/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

e6data_python_connector-1.0.0.dist-info/METADATA

@@ -0,0 +1,205 @@
+Metadata-Version: 2.1
+Name: e6data-python-connector
+Version: 1.0.0
+Summary: Client for the e6data distributed SQL Engine.
+Home-page: https://github.com/e6x-labs/e6data-python-connector
+Author: Uniphi, Inc.
+Author-email: info@e6data.com
+Classifier: Operating System :: POSIX :: Linux
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqlalchemy (>=1.0.0)
+Requires-Dist: future
+Requires-Dist: python-dateutil
+Requires-Dist: pycryptodome
+Requires-Dist: pytz
+Requires-Dist: thrift
+
+# e6xdb
+
+![version](https://img.shields.io/badge/version-1.0.0-blue.svg)
+
+## Introduction
+
+The e6data Connector for Python provides an interface for writing Python applications that can connect to e6data and perform operations.
+
+To install the Python package, use the command below:
+```shell
+pip install e6data-python-connector
+```
+### Prerequisites
+
+* Open Inbound Port 9000 in the Engine Cluster.
+* Limit access to Port 9000 according to your organizational security policy. Public access is not encouraged.
+* Generated Access Token in the e6data console.
+
+### Creating connection
+
+Use your e6data email id as a username and access token as a password.
+
+```python
+import e6xdb.e6x as edb
+
+username = '<username>'  # Your e6data email id.
+password = '<password>'  # Generated Access Token from e6data console.
+
+host = '<host>'  # Host name or IP address of you cluster.
+database = '<database>'  # Database name where you want to perform query.
+
+port = 9000  # Engine port.
+
+conn = edb.connect(
+    host=host,
+    port=port,
+    username=username,
+    database=database,
+    password=password
+)
+```
+
+### Performing query
+Performing query
+
+```python
+
+query = 'SELECT * FROM <TABLE_NAME>'  # Replace with the actual query.
+
+cursor = conn.cursor()
+query_id = cursor.execute(query)  # execute function returns query id, can be use for aborting the query.
+all_records = cursor.fetchall()
+for row in all_records:
+   print(row)
+```
+
+To fetch all the records.
+```python
+records = cursor.fetchall()
+```
+
+To fetch one record.
+```python
+record = cursor.fetchone()
+```
+
+To fetch limited records.
+```python
+limit = 500
+records = cursor.fetchmany(limit)
+```
+
+To get execution plan after query execution.
+```python
+import json
+
+query_planner = json.loads(cursor.explain_analyse())
+```
+
+To abort running query.
+```python
+query_id = '<query_id>'  # query id from execute function response.
+cursor.cancel(query_id)
+```
+
+Switch database in existing connection.
+```python
+database = '<new_database_name>'  # Replace with the new database.
+cursor = conn.cursor(database)
+```
+
+### Get Query Time Metrics
+```python
+import json
+query = 'SELECT * FROM <TABLE_NAME>'
+
+cursor = conn.cursor()
+query_id = cursor.execute(query)  # execute function returns query id, can be use for aborting th query.
+all_records = cursor.fetchall()
+
+query_planner = json.loads(cursor.explain_analyse())
+
+execution_time = query_planner.get("total_query_time")  # In milliseconds
+queue_time = query_planner.get("executionQueueingTime")  # In milliseconds
+parsing_time = query_planner.get("parsingTime")  # In milliseconds
+row_count = query_planner.get('row_count_out')
+```
+
+### Get list of databases, tables or columns
+The following code returns a dictionary of all databases, all tables and all columns connected to the cluster currently in use.
+This function can be used without passing database name to get list of all databases.
+
+```python
+databases = conn.get_schema_names()  # To get list of databases.
+print(databases)
+
+database = '<database_name>'  # Replace with actual database name.
+tables = conn.get_tables(database=database)  # To get list of tables from a database.
+print(tables)
+
+table_name = '<table_name>'  # Replace with actual table name.
+columns = conn.get_tables(database=database, table=table_name)  # To get the list of columns from a table.
+columns_with_type = list()
+"""
+Getting the column name and type.
+"""
+for column in columns:
+   columns_with_type.append(dict(column_name=column.fieldName, column_type=column.fieldType))
+print(columns_with_type)
+```
+
+### Code Hygiene
+It is recommended to clear the cursor, close the cursor and close the connection after running a function as a best practice. 
+This enhances performance by clearing old data from memory.
+
+```python
+cursor.clear() # Not needed when aborting a query
+cursor.close()
+conn.close()
+```
+
+### Code Example
+The following code is an example.
+```python
+import e6xdb.e6x as edb
+import json
+
+username = '<username>'  # Your e6data email id.
+password = '<password>'  # Generated Access Token from e6data console.
+
+host = '<host>'  # Host name or IP address of you cluster.
+database = '<database>'  # Database name where you want to perform query.
+
+port = 9000  # Engine port.
+
+sql_query = 'SELECT * FROM <TABLE_NAME>'  # Replace with the actual query.
+
+conn = edb.connect(
+    host=host,
+    port=port,
+    username=username,
+    database=database,
+    password=password
+)
+
+cursor = conn.cursor(db_name=database)
+query_id = cursor.execute(sql_query)
+all_records = cursor.fetchall()
+planner_result = json.loads(cursor.explain_analyse())
+execution_time = planner_result.get("total_query_time") / 1000  # Converting into seconds.
+row_count = planner_result.get('row_count_out')
+columns = [col[0] for col in cursor.description]  # Get the column names and merge with the records.
+results = []
+for row in all_records:
+   row = dict(zip(columns, row))
+   results.append(row)
+   print(row)
+print('Total row count {}, Execution Time (seconds): {}'.format(row_count, execution_time))
+cursor.clear()
+cursor.close()
+conn.close()
+```

e6data_python_connector-1.0.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+e6xdb/__init__.py,sha256=Xl8RdRmrX8u2Qnhdess7r3z_Y6yVQknTkBYJa3FFl6w,334
+e6xdb/common.py,sha256=p9VqU5VpQl6bXa0oHQNtjmQyB3R90cfnJmm2PoyqaKw,9958
+e6xdb/constants.py,sha256=h5w0lWiFsxz__zUZRlo1f72-8mT_vt9gcWvtWh0viFI,682
+e6xdb/datainputstream.py,sha256=DXxLdZi50zsKUnEmSaUObryS4luLQJFG5y6_dd3-GSs,6052
+e6xdb/date_time_utils.py,sha256=ew1CjhfB93trRdu8jBOy2ihZNSecDPcmxS1USmWxqzE,13623
+e6xdb/e6x.py,sha256=l6DQ8cScuS93cfnV29l3SJTvi9yM2bhlowX6ElsfOgg,15412
+e6xdb/exceptions.py,sha256=vrUqdzMq3LjbCmvr5_TcRq9eKmdqGfe-uVjR0BJQf5U,382
+e6xdb/sqlalchemy_e6x.py,sha256=1Y8aNgXj6vBYnQ_nRGzfXdSl6gOqCJTcKWrLxk3GW4I,11833
+e6xdb/typeId.py,sha256=2EMNWK2SO5CBReNuJphma6xp-69r9GDwwys66t-kSk0,1777
+e6xdb/server/QueryEngineService.py,sha256=PKtXR6NCUMPvkG4l2v16PcNRYoMuiGLomLmp7iDvH4U,133637
+e6xdb/server/__init__.py,sha256=8eK3WgN4xfJiSNm4bUrnXb5ZgjMUEjdStbUahQQrJII,56
+e6xdb/server/constants.py,sha256=oIo-gFt2ApjBcAbWusvs50yafuBr59Ejs3isUJ2a7cc,366
+e6xdb/server/ttypes.py,sha256=vHmSALf33VIjqsW-B3ep3ZhBggKML-84mIKmTJRtUus,11878
+e6data_python_connector-1.0.0.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+e6data_python_connector-1.0.0.dist-info/METADATA,sha256=-HzXFCS-EAFIMtnyZC7uSmyGsiVOAuC3-CZDE3jvYko,5863
+e6data_python_connector-1.0.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+e6data_python_connector-1.0.0.dist-info/entry_points.txt,sha256=shvAWeDWP_hoFDoEs6U2uU6P0lwtcgX0drojlw7bnQk,62
+e6data_python_connector-1.0.0.dist-info/top_level.txt,sha256=0s_KYaRd9ot5ESWVSGTiKZDCDZj4yR9OqhxoAULjzX4,6
+e6data_python_connector-1.0.0.dist-info/RECORD,,

e6data_python_connector-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.38.4)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

e6data_python_connector-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[sqlalchemy.dialects]
+e6xdb = e6xdb.sqlalchemy_e6x:E6xDialect

e6data_python_connector-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+e6xdb

e6xdb/__init__.py

@@ -0,0 +1,10 @@
+"""
+THIS SPECIFIC FILE IS DISTRIBUTED UNDER THE UNLICENSE: http://unlicense.org.
+
+THIS MEANS YOU CAN USE THIS CODE EXAMPLE TO KICKSTART A PROJECT YOUR OWN.
+AFTER YOU CREATED YOUR OWN ORIGINAL WORK, YOU CAN REPLACE THIS HEADER :)
+"""
+
+from __future__ import absolute_import
+from __future__ import unicode_literals
+__version__ = '0.0.1'