exasol-python-extension-common 0.2.0__tar.gz → 0.3.0__tar.gz

{exasol_python_extension_common-0.2.0 → exasol_python_extension_common-0.3.0}/PKG-INFO

@@ -1,21 +1,19 @@
 Metadata-Version: 2.1
 Name: exasol-python-extension-common
-Version: 0.2.0
+Version: 0.3.0
 Summary: A collection of common utilities for Exasol extensions.
 License: MIT
 Author: Mikhail Beck
 Author-email: mikhail.beck@exasol.com
-Requires-Python: >=3.8.0,<4.0
+Requires-Python: >=3.10.0,<4.0.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: exasol-bucketfs (>=0.10.0)
 Requires-Dist: exasol-saas-api (>=0.7.0,<1.0.0)
-Requires-Dist: pyexasol (>=0.25.0,<0.26.0)
+Requires-Dist: pyexasol (>=0.25.0,<1.0.0)
 Requires-Dist: requests (<2.32.0)
 Requires-Dist: tenacity (>=8.3.0,<9.0.0)
 Description-Content-Type: text/markdown
@@ -32,7 +30,7 @@ A deployer for script language containers (SLC) to be used by UDF-based extensio
 
 ## More documentation
 
-* User Guide
+* [User Guide](doc/user_guide/user-guide.md)
 * [Developer Guide](doc/developer-guide.md)
 * [User Defined Functions (UDF)](https://docs.exasol.com/db/latest/database_concepts/udf_scripts.htm)
 * [Script Language Containers (SLC)](https://github.com/exasol/script-languages-release/)

{exasol_python_extension_common-0.2.0 → exasol_python_extension_common-0.3.0}/README.md

@@ -10,7 +10,7 @@ A deployer for script language containers (SLC) to be used by UDF-based extensio
 
 ## More documentation
 
-* User Guide
+* [User Guide](doc/user_guide/user-guide.md)
 * [Developer Guide](doc/developer-guide.md)
 * [User Defined Functions (UDF)](https://docs.exasol.com/db/latest/database_concepts/udf_scripts.htm)
 * [Script Language Containers (SLC)](https://github.com/exasol/script-languages-release/)

exasol_python_extension_common-0.3.0/exasol/python_extension_common/connections/pyexasol_connection.py

@@ -0,0 +1,67 @@
+import pyexasol     # type: ignore
+import exasol.saas.client.api_access as saas_api    # type: ignore
+
+from exasol.python_extension_common.deployment.language_container_deployer import get_websocket_sslopt
+
+
+def open_pyexasol_connection(
+        dsn: str | None = None,
+        db_user: str | None = None,
+        db_pass: str | None = None,
+        saas_url: str | None = None,
+        saas_account_id: str | None = None,
+        saas_database_id: str | None = None,
+        saas_database_name: str | None = None,
+        saas_token: str | None = None,
+        schema: str = '',
+        use_ssl_cert_validation: bool = True,
+        ssl_trusted_ca: str | None = None,
+        ssl_client_certificate: str | None = None,
+        ssl_private_key: str | None = None) -> pyexasol.ExaConnection:
+    """
+    Creates a database connections object, either in an On-Prem or SaaS database,
+    depending on the provided parameters.
+
+    Raises a ValueError if the provided parameters are sufficient for neither On-Prem
+    nor SaaS connections.
+
+    Parameters:
+        dsn                 - On-Prem database host address, including the port
+        db_user             - On-Prem database username
+        db_pass             - On-Prem database user password
+        saas_url            - SaaS service url
+        saas_account_id     - SaaS account id
+        saas_database_id    - SaaS database id
+        saas_database_name  - SaaS database name, to be used in case the id is unknown
+        saas_token          - SaaS Personal Access Token (PAT)
+        schema              - Schema where the scripts should be created
+        use_ssl_cert_validation - Use SSL server certificate validation
+        ssl_trusted_ca          - Path to a file or directory with an SSL trusted CA bundle
+        ssl_client_certificate  - Path to a file with the SSL client certificate
+        ssl_private_key         - Path to a file with the SSL client private key
+    """
+
+    # Infer where the database is - On-Prem or SaaS.
+    if all((dsn, db_user, db_pass)):
+        connection_params = {'dsn': dsn, 'user': db_user, 'password': db_pass}
+    elif all((saas_url, saas_account_id, saas_token,
+              any((saas_database_id, saas_database_name)))):
+        connection_params = saas_api.get_connection_params(host=saas_url,
+                                                           account_id=saas_account_id,
+                                                           database_id=saas_database_id,
+                                                           database_name=saas_database_name,
+                                                           pat=saas_token)
+    else:
+        raise ValueError('Incomplete parameter list. '
+                         'Please either provide the parameters [dns, db_user, db_pass] '
+                         'for an On-Prem database or [saas_url, saas_account_id, '
+                         'saas_database_id or saas_database_name, saas_token] '
+                         'for a SaaS database.')
+
+    websocket_sslopt = get_websocket_sslopt(use_ssl_cert_validation, ssl_trusted_ca,
+                                            ssl_client_certificate, ssl_private_key)
+
+    return pyexasol.connect(**connection_params, schema=schema,
+                            encryption=True,
+                            websocket_sslopt=websocket_sslopt,
+                            compression=True)

{exasol_python_extension_common-0.2.0 → exasol_python_extension_common-0.3.0}/exasol/python_extension_common/deployment/language_container_validator.py

@@ -25,13 +25,14 @@ def _get_test_udf_name(schema: str | None) -> str:
 def _create_dummy_udf(conn: pyexasol.ExaConnection, language_alias: str,
                       schema: str | None) -> None:
 
+    # The dummy UDF returns the ID of the node it is running at.
     udf_name = _get_test_udf_name(schema)
     sql = dedent(f"""
-    CREATE OR REPLACE {language_alias} SCALAR SCRIPT {udf_name}()
-    RETURNS DECIMAL(1, 0) AS
+    CREATE OR REPLACE {language_alias} SET SCRIPT {udf_name}(i DECIMAL(10, 0))
+    RETURNS DECIMAL(10, 0) AS
 
     def run(ctx):
-        return 0
+        return exa.meta.node_id
     /
     """)
     conn.execute(sql)
@@ -39,13 +40,21 @@ def _create_dummy_udf(conn: pyexasol.ExaConnection, language_alias: str,
 
 def _call_dummy_udf(conn: pyexasol.ExaConnection, schema: str | None) -> None:
 
+    # First, need to find out the number of nodes.
+    sql = "SELECT NPROC();"
+    nproc = conn.execute(sql).fetchval()
+
+    # This query should run the dummy udf on all nodes.
     udf_name = _get_test_udf_name(schema)
     sql = dedent(f"""
-    SELECT {udf_name}()
-    GROUP BY IPROC();
+    SELECT {udf_name}(i) FROM VALUES BETWEEN 1 AND {nproc} t(i)
+    GROUP BY i;
     """)
+    # The expected result is a collection of distinct node IDs from 0 to nproc - 1.
     result = conn.execute(sql).fetchall()
-    assert result == [(0,)]
+    set_result = {row[0] for row in result}
+
+    assert set_result == set(range(nproc))
 
 
 def _delete_dummy_udf(conn: pyexasol.ExaConnection, schema: str | None) -> None:

{exasol_python_extension_common-0.2.0 → exasol_python_extension_common-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "exasol-python-extension-common"
-version = "0.2.0"
+version = "0.3.0"
 description = "A collection of common utilities for Exasol extensions."
 packages = [ {include = "exasol"}, ]
 authors = ["Mikhail Beck <mikhail.beck@exasol.com>"]
@@ -8,8 +8,8 @@ license = "MIT"
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = ">=3.8.0,<4.0"
-pyexasol = "^0.25.0"
+python = "^3.10.0"
+pyexasol = ">=0.25.0,<1.0.0"
 exasol-bucketfs = ">=0.10.0"
 click = "^8.1.7"
 exasol-saas-api = ">=0.7.0,<1.0.0"

{exasol_python_extension_common-0.2.0 → exasol_python_extension_common-0.3.0}/setup.py

@@ -4,6 +4,7 @@ from setuptools import setup
 packages = \
 ['exasol',
  'exasol.python_extension_common',
+ 'exasol.python_extension_common.connections',
  'exasol.python_extension_common.deployment']
 
 package_data = \
@@ -13,15 +14,15 @@ install_requires = \
 ['click>=8.1.7,<9.0.0',
  'exasol-bucketfs>=0.10.0',
  'exasol-saas-api>=0.7.0,<1.0.0',
- 'pyexasol>=0.25.0,<0.26.0',
+ 'pyexasol>=0.25.0,<1.0.0',
  'requests<2.32.0',
  'tenacity>=8.3.0,<9.0.0']
 
 setup_kwargs = {
     'name': 'exasol-python-extension-common',
-    'version': '0.2.0',
+    'version': '0.3.0',
     'description': 'A collection of common utilities for Exasol extensions.',
-    'long_description': '# Exasol Python Extension Common\n\nA package with common functionality, shared by Exasol Python Extensions, e.g.\n* [transformers-extension](https://github.com/exasol/transformers-extension)\n* [sagemaker-extension](https://github.com/exasol/sagemaker-extension)\n\n## Features\n\nA deployer for script language containers (SLC) to be used by UDF-based extensions of Exasol database requiring a special SLC.\n\n## More documentation\n\n* User Guide\n* [Developer Guide](doc/developer-guide.md)\n* [User Defined Functions (UDF)](https://docs.exasol.com/db/latest/database_concepts/udf_scripts.htm)\n* [Script Language Containers (SLC)](https://github.com/exasol/script-languages-release/)\n',
+    'long_description': '# Exasol Python Extension Common\n\nA package with common functionality, shared by Exasol Python Extensions, e.g.\n* [transformers-extension](https://github.com/exasol/transformers-extension)\n* [sagemaker-extension](https://github.com/exasol/sagemaker-extension)\n\n## Features\n\nA deployer for script language containers (SLC) to be used by UDF-based extensions of Exasol database requiring a special SLC.\n\n## More documentation\n\n* [User Guide](doc/user_guide/user-guide.md)\n* [Developer Guide](doc/developer-guide.md)\n* [User Defined Functions (UDF)](https://docs.exasol.com/db/latest/database_concepts/udf_scripts.htm)\n* [Script Language Containers (SLC)](https://github.com/exasol/script-languages-release/)\n',
     'author': 'Mikhail Beck',
     'author_email': 'mikhail.beck@exasol.com',
     'maintainer': 'None',
@@ -30,7 +31,7 @@ setup_kwargs = {
     'packages': packages,
     'package_data': package_data,
     'install_requires': install_requires,
-    'python_requires': '>=3.8.0,<4.0',
+    'python_requires': '>=3.10.0,<4.0.0',
 }