ydb-sqlalchemy 0.0.1b4__py2.py3-none-any.whl

ydb_sqlalchemy/sqlalchemy/dml.py

@@ -0,0 +1,12 @@
+import sqlalchemy as sa
+
+
+class Upsert(sa.sql.Insert):
+    __visit_name__ = "upsert"
+    _propagate_attrs = {"compile_state_plugin": "yql"}
+    stringify_dialect = "yql"
+
+
+@sa.sql.base.CompileState.plugin_for("yql", "upsert")
+class UpsertDMLState(sa.sql.dml.InsertDMLState):
+    pass

ydb_sqlalchemy/sqlalchemy/json.py

@@ -0,0 +1,34 @@
+from typing import Tuple, Union
+
+from sqlalchemy import types as sqltypes
+
+
+class YqlJSON(sqltypes.JSON):
+    class YqlJSONPathType(sqltypes.JSON.JSONPathType):
+        def _format_value(self, value: Tuple[Union[str, int]]) -> str:
+            path = "/"
+            for elem in value:
+                path += f"/{elem}"
+            return path
+
+        def bind_processor(self, dialect):
+            super_proc = self.string_bind_processor(dialect)
+
+            def process(value: Tuple[Union[str, int]]):
+                value = self._format_value(value)
+                if super_proc:
+                    value = super_proc(value)
+                return value
+
+            return process
+
+        def literal_processor(self, dialect):
+            super_proc = self.string_literal_processor(dialect)
+
+            def process(value: Tuple[Union[str, int]]):
+                value = self._format_value(value)
+                if super_proc:
+                    value = super_proc(value)
+                return value
+
+            return process

ydb_sqlalchemy/sqlalchemy/requirements.py

@@ -0,0 +1,105 @@
+from sqlalchemy.testing import exclusions
+from sqlalchemy.testing.requirements import SuiteRequirements
+
+
+class Requirements(SuiteRequirements):
+    @property
+    def json_type(self):
+        return exclusions.open()
+
+    @property
+    def array_type(self):
+        return exclusions.closed()
+
+    @property
+    def uuid_data_type(self):
+        return exclusions.open()
+
+    @property
+    def foreign_keys(self):
+        # foreign keys unsupported
+        return exclusions.closed()
+
+    @property
+    def self_referential_foreign_keys(self):
+        return exclusions.closed()
+
+    @property
+    def foreign_key_ddl(self):
+        return exclusions.closed()
+
+    @property
+    def foreign_key_constraint_reflection(self):
+        return exclusions.closed()
+
+    @property
+    def temp_table_reflection(self):
+        return exclusions.closed()
+
+    @property
+    def temporary_tables(self):
+        return exclusions.closed()
+
+    @property
+    def temporary_views(self):
+        return exclusions.closed()
+
+    @property
+    def index_reflection(self):
+        return exclusions.closed()
+
+    @property
+    def view_reflection(self):
+        return exclusions.closed()
+
+    @property
+    def unique_constraint_reflection(self):
+        return exclusions.closed()
+
+    @property
+    def insert_returning(self):
+        return exclusions.closed()
+
+    @property
+    def autoincrement_insert(self):
+        # YDB doesn't support autoincrement
+        return exclusions.closed()
+
+    @property
+    def autoincrement_without_sequence(self):
+        # YDB doesn't support autoincrement
+        return exclusions.closed()
+
+    @property
+    def duplicate_names_in_cursor_description(self):
+        return exclusions.closed()
+
+    @property
+    def regexp_match(self):
+        return exclusions.open()
+
+    @property
+    def table_value_constructor(self):
+        return exclusions.open()
+
+    @property
+    def named_constraints(self):
+        return exclusions.closed()
+
+    @property
+    def timestamp_microseconds(self):
+        return exclusions.open()
+
+    @property
+    def mod_operator_as_percent_sign(self):
+        return exclusions.open()
+
+    @property
+    def parens_in_union_contained_select_w_limit_offset(self):
+        """union with brackets don't work"""
+        return exclusions.closed()
+
+    @property
+    def parens_in_union_contained_select_wo_limit_offset(self):
+        """union with brackets don't work"""
+        return exclusions.closed()

ydb_sqlalchemy/sqlalchemy/test_sqlalchemy.py

@@ -0,0 +1,27 @@
+import sqlalchemy as sa
+
+from . import YqlDialect, types
+
+
+def test_casts():
+    dialect = YqlDialect()
+    expr = sa.literal_column("1/2")
+
+    res_exprs = [
+        sa.cast(expr, types.UInt32),
+        sa.cast(expr, types.UInt64),
+        sa.cast(expr, types.UInt8),
+        sa.func.String.JoinFromList(
+            sa.func.ListMap(sa.func.TOPFREQ(expr, 5), types.Lambda(lambda x: sa.cast(x, sa.Text))),
+            ", ",
+        ),
+    ]
+
+    strs = [str(res_expr.compile(dialect=dialect, compile_kwargs={"literal_binds": True})) for res_expr in res_exprs]
+
+    assert strs == [
+        "CAST(1/2 AS UInt32)",
+        "CAST(1/2 AS UInt64)",
+        "CAST(1/2 AS UInt8)",
+        "String::JoinFromList(ListMap(TOPFREQ(1/2, 5), ($x) -> { RETURN CAST($x AS UTF8) ;}), ', ')",
+    ]

ydb_sqlalchemy/sqlalchemy/types.py

@@ -0,0 +1,67 @@
+from typing import Any, Mapping, Type, Union
+
+from sqlalchemy import ARRAY, ColumnElement, exc, types
+from sqlalchemy.sql import type_api
+
+from .json import YqlJSON  # noqa: F401
+
+
+class UInt64(types.Integer):
+    __visit_name__ = "uint64"
+
+
+class UInt32(types.Integer):
+    __visit_name__ = "uint32"
+
+
+class UInt16(types.Integer):
+    __visit_name__ = "uint16"
+
+
+class UInt8(types.Integer):
+    __visit_name__ = "uint8"
+
+
+class Int64(types.Integer):
+    __visit_name__ = "int64"
+
+
+class Int32(types.Integer):
+    __visit_name__ = "int32"
+
+
+class Int16(types.Integer):
+    __visit_name__ = "int32"
+
+
+class Int8(types.Integer):
+    __visit_name__ = "int8"
+
+
+class ListType(ARRAY):
+    __visit_name__ = "list_type"
+
+
+class StructType(types.TypeEngine[Mapping[str, Any]]):
+    __visit_name__ = "struct_type"
+
+    def __init__(self, fields_types: Mapping[str, Union[Type[types.TypeEngine], Type[types.TypeDecorator]]]):
+        self.fields_types = fields_types
+
+    @property
+    def python_type(self):
+        return dict
+
+    def compare_values(self, x, y):
+        return x == y
+
+
+class Lambda(ColumnElement):
+    __visit_name__ = "lambda"
+
+    def __init__(self, func):
+        if not callable(func):
+            raise exc.ArgumentError("func must be callable")
+
+        self.type = type_api.NULLTYPE
+        self.func = func

ydb_sqlalchemy-0.0.1b4.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

ydb_sqlalchemy-0.0.1b4.dist-info/METADATA

@@ -0,0 +1,89 @@
+Metadata-Version: 2.1
+Name: ydb-sqlalchemy
+Version: 0.0.1b4
+Summary: YDB Dialect for SQLAlchemy
+Home-page: http://github.com/ydb-platform/ydb-sqlalchemy
+Author: Yandex LLC
+Author-email: ydb@yandex-team.ru
+License: Apache 2.0
+Keywords: SQLAlchemy YDB YQL
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqlalchemy <3.0.0,>=2.0.7
+Requires-Dist: ydb >=3.2.0
+Provides-Extra: yc
+Requires-Dist: yandexcloud ; extra == 'yc'
+
+# YDB Dialect for SQLAlchemy
+---
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/ydb-platform/ydb-sqlalchemy/blob/main/LICENSE)
+[![Functional tests](https://github.com/ydb-platform/ydb-sqlalchemy/actions/workflows/tests.yml/badge.svg)](https://github.com/ydb-platform/ydb-sqlalchemy/actions/workflows/tests.yml)
+[![Style checks](https://github.com/ydb-platform/ydb-sqlalchemy/actions/workflows/style.yml/badge.svg)](https://github.com/ydb-platform/ydb-sqlalchemy/actions/workflows/style.yml)
+
+This repository contains __work in progress__ YQL dialect for SqlAlchemy 2.0.
+Api may be changed in future without backward compatibility.
+
+## Installation
+To work with current ydb-sqlalchemy version clone this repo and run from source root:
+
+```bash
+$ pip install -U .
+```
+
+## Getting started
+
+Connect to local YDB throw SqlAlchemy:
+
+```python3
+import sqlalchemy as sa
+
+
+engine = sa.create_engine("yql+ydb://localhost:2136/local")
+
+with engine.connect() as conn:
+  rs = conn.execute(sa.text("SELECT 1 AS value"))
+  print(rs.fetchone())
+
+```
+
+## Development
+
+### Run Tests:
+
+For run local YDB throw docker, run in source root:
+```bash
+$ docker-compose up
+```
+
+For run all tests from source root make:
+```bash
+$ tox -e test-all
+```
+
+Run specific test:
+```bash
+$ tox -e test -- test_dbapi/test_dbapi.py
+```
+
+Check code style:
+```bash
+$ tox -e style
+```
+
+Reformat code:
+```bash
+$ tox -e isort
+$ tox -e black-format
+```
+
+Run example (needs running local YDB):
+```bash
+$ python -m pip install virtualenv
+$ virtualenv venv
+$ source venv/bin/activate
+$ pip install -r requirements.txt
+$ python examples/example.py
+```

ydb_sqlalchemy-0.0.1b4.dist-info/RECORD

@@ -0,0 +1,26 @@
+test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+test/conftest.py,sha256=rhWa0EQB9EwO_wAwxPdK17Qi582DdbBE8p5Gv4180Ds,570
+test/test_core.py,sha256=LJVyYw3PJwoP1qmrxGhsCRs4oD02bCo7Y1agefWWgMQ,26965
+test/test_inspect.py,sha256=c4kc3jc48MCOfllO-ciiYf1vO-HOfuv0xVoXYT1Jxro,1106
+test/test_suite.py,sha256=RxVTdOrV3pt9rE4sK7E4vBOSTR8auzdAI2jL_3__vWY,18310
+test_dbapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+test_dbapi/test_dbapi.py,sha256=iKHlu988Bnv2dNPEHLp7S5dAMBufTnQFsm0vWj8Kbc0,7114
+ydb_sqlalchemy/__init__.py,sha256=LTJPaiPuuFzAsk4xg032VGLz2vqz-wBOdxu0_nskHHM,137
+ydb_sqlalchemy/_version.py,sha256=R0JvgGBmsAkk3jrNV5N2OAdk691MpYvvSpCoseWwCpM,20
+ydb_sqlalchemy/dbapi/__init__.py,sha256=KFbYL2TAOMwtiN_T3d7qgOAQHKCWwFDYKJOQYyH-UcE,1297
+ydb_sqlalchemy/dbapi/connection.py,sha256=Uo5aD-OXVdncPGANjAs2xR82k4LTqy-hoXeO1uDX58o,7254
+ydb_sqlalchemy/dbapi/constants.py,sha256=NKj6XBgepDWvbbw9McM66k_ATTZqhWIUxf4X1D_ztAo,3061
+ydb_sqlalchemy/dbapi/cursor.py,sha256=CtWT07tv6Rvi1OFskMcF-OYv66R75s9og45Xej0Zm4I,11151
+ydb_sqlalchemy/dbapi/errors.py,sha256=noLIS7axzqlpRALL7NUHsRsbMTDpSOKHoPK4j7aLOVY,2316
+ydb_sqlalchemy/sqlalchemy/__init__.py,sha256=1enYnUKl5d8Wlu2yQJe8hPSUdBh0EYPQiKbXqYYazag,28730
+ydb_sqlalchemy/sqlalchemy/dml.py,sha256=8hRbWiheJACEME5Hgt7xpFtRElT7SrH2MwSBcOw8zrQ,284
+ydb_sqlalchemy/sqlalchemy/json.py,sha256=b4ydjlQjBhlhqGP_Sy2uZVKmt__D-9M7-YLGQMdYGME,1043
+ydb_sqlalchemy/sqlalchemy/requirements.py,sha256=mz3r6lJ8xdQYH8Chp3C1wU3MFpbHEvWNyqLqyGO2Wo8,2462
+ydb_sqlalchemy/sqlalchemy/test_sqlalchemy.py,sha256=HSNDtmqYXf5aR1hDtzioQV9YzHALK7NPerFxZRWn7hk,782
+ydb_sqlalchemy/sqlalchemy/types.py,sha256=NvltcRN9zT-v67mbYIGzCJrNs4P0a7WZov1bk9xgZ0g,1326
+ydb_sqlalchemy-0.0.1b4.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+ydb_sqlalchemy-0.0.1b4.dist-info/METADATA,sha256=xOsJ2Litmh_Hxv0oEKyhTvEE8OJjkADTLFXyHXtJgKI,2236
+ydb_sqlalchemy-0.0.1b4.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+ydb_sqlalchemy-0.0.1b4.dist-info/entry_points.txt,sha256=iJxbKYuliWNBmL0iIiw8MxvOXrSEz5xe5fuEBqMRwCE,267
+ydb_sqlalchemy-0.0.1b4.dist-info/top_level.txt,sha256=qgP7LviN7OhdIol_64XhPs_59CaZlSIdXfcAnYhIFBY,31
+ydb_sqlalchemy-0.0.1b4.dist-info/RECORD,,

ydb_sqlalchemy-0.0.1b4.dist-info/WHEEL

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

ydb_sqlalchemy-0.0.1b4.dist-info/entry_points.txt

@@ -0,0 +1,6 @@
+[sqlalchemy.dialects]
+ydb = ydb_sqlalchemy.sqlalchemy:YqlDialect
+ydb_async = ydb_sqlalchemy.sqlalchemy:AsyncYqlDialect
+yql = ydb_sqlalchemy.sqlalchemy:YqlDialect
+yql.ydb = ydb_sqlalchemy.sqlalchemy:YqlDialect
+yql.ydb_async = ydb_sqlalchemy.sqlalchemy:AsyncYqlDialect

ydb_sqlalchemy-0.0.1b4.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+test
+test_dbapi
+ydb_sqlalchemy