databricks-sqlalchemy 0.0.1b1__py3-none-any.whl → 1.0.0__py3-none-any.whl

databricks/sqlalchemy/test_local/test_parsing.py

@@ -0,0 +1,160 @@
+import pytest
+from databricks.sqlalchemy._parse import (
+    extract_identifiers_from_string,
+    extract_identifier_groups_from_string,
+    extract_three_level_identifier_from_constraint_string,
+    build_fk_dict,
+    build_pk_dict,
+    match_dte_rows_by_value,
+    get_comment_from_dte_output,
+    DatabricksSqlAlchemyParseException,
+)
+
+
+# These are outputs from DESCRIBE TABLE EXTENDED
+@pytest.mark.parametrize(
+    "input, expected",
+    [
+        ("PRIMARY KEY (`pk1`, `pk2`)", ["pk1", "pk2"]),
+        ("PRIMARY KEY (`a`, `b`, `c`)", ["a", "b", "c"]),
+        ("PRIMARY KEY (`name`, `id`, `attr`)", ["name", "id", "attr"]),
+    ],
+)
+def test_extract_identifiers(input, expected):
+    assert (
+        extract_identifiers_from_string(input) == expected
+    ), "Failed to extract identifiers from string"
+
+
+@pytest.mark.parametrize(
+    "input, expected",
+    [
+        (
+            "FOREIGN KEY (`pname`, `pid`, `pattr`) REFERENCES `main`.`pysql_sqlalchemy`.`tb1` (`name`, `id`, `attr`)",
+            [
+                "(`pname`, `pid`, `pattr`)",
+                "(`name`, `id`, `attr`)",
+            ],
+        )
+    ],
+)
+def test_extract_identifer_batches(input, expected):
+    assert (
+        extract_identifier_groups_from_string(input) == expected
+    ), "Failed to extract identifier groups from string"
+
+
+def test_extract_3l_namespace_from_constraint_string():
+    input = "FOREIGN KEY (`parent_user_id`) REFERENCES `main`.`pysql_dialect_compliance`.`users` (`user_id`)"
+    expected = {
+        "catalog": "main",
+        "schema": "pysql_dialect_compliance",
+        "table": "users",
+    }
+
+    assert (
+        extract_three_level_identifier_from_constraint_string(input) == expected
+    ), "Failed to extract 3L namespace from constraint string"
+
+
+def test_extract_3l_namespace_from_bad_constraint_string():
+    input = "FOREIGN KEY (`parent_user_id`) REFERENCES `pysql_dialect_compliance`.`users` (`user_id`)"
+
+    with pytest.raises(DatabricksSqlAlchemyParseException):
+        extract_three_level_identifier_from_constraint_string(input)
+
+
+@pytest.mark.parametrize("tschema", [None, "some_schema"])
+def test_build_fk_dict(tschema):
+    fk_constraint_string = "FOREIGN KEY (`parent_user_id`) REFERENCES `main`.`some_schema`.`users` (`user_id`)"
+
+    result = build_fk_dict("some_fk_name", fk_constraint_string, schema_name=tschema)
+
+    assert result == {
+        "name": "some_fk_name",
+        "constrained_columns": ["parent_user_id"],
+        "referred_schema": tschema,
+        "referred_table": "users",
+        "referred_columns": ["user_id"],
+    }
+
+
+def test_build_pk_dict():
+    pk_constraint_string = "PRIMARY KEY (`id`, `name`, `email_address`)"
+    pk_name = "pk1"
+
+    result = build_pk_dict(pk_name, pk_constraint_string)
+
+    assert result == {
+        "constrained_columns": ["id", "name", "email_address"],
+        "name": "pk1",
+    }
+
+
+# This is a real example of the output from DESCRIBE TABLE EXTENDED as of 15 October 2023
+RAW_SAMPLE_DTE_OUTPUT = [
+    ["id", "int"],
+    ["name", "string"],
+    ["", ""],
+    ["# Detailed Table Information", ""],
+    ["Catalog", "main"],
+    ["Database", "pysql_sqlalchemy"],
+    ["Table", "exampleexampleexample"],
+    ["Created Time", "Sun Oct 15 21:12:54 UTC 2023"],
+    ["Last Access", "UNKNOWN"],
+    ["Created By", "Spark "],
+    ["Type", "MANAGED"],
+    ["Location", "s3://us-west-2-****-/19a85dee-****/tables/ccb7***"],
+    ["Provider", "delta"],
+    ["Comment", "some comment"],
+    ["Owner", "some.user@example.com"],
+    ["Is_managed_location", "true"],
+    ["Predictive Optimization", "ENABLE (inherited from CATALOG main)"],
+    [
+        "Table Properties",
+        "[delta.checkpoint.writeStatsAsJson=false,delta.checkpoint.writeStatsAsStruct=true,delta.minReaderVersion=1,delta.minWriterVersion=2]",
+    ],
+    ["", ""],
+    ["# Constraints", ""],
+    ["exampleexampleexample_pk", "PRIMARY KEY (`id`)"],
+    [
+        "exampleexampleexample_fk",
+        "FOREIGN KEY (`parent_user_id`) REFERENCES `main`.`pysql_dialect_compliance`.`users` (`user_id`)",
+    ],
+]
+
+FMT_SAMPLE_DT_OUTPUT = [
+    {"col_name": i[0], "data_type": i[1]} for i in RAW_SAMPLE_DTE_OUTPUT
+]
+
+
+@pytest.mark.parametrize(
+    "match, output",
+    [
+        (
+            "PRIMARY KEY",
+            [
+                {
+                    "col_name": "exampleexampleexample_pk",
+                    "data_type": "PRIMARY KEY (`id`)",
+                }
+            ],
+        ),
+        (
+            "FOREIGN KEY",
+            [
+                {
+                    "col_name": "exampleexampleexample_fk",
+                    "data_type": "FOREIGN KEY (`parent_user_id`) REFERENCES `main`.`pysql_dialect_compliance`.`users` (`user_id`)",
+                }
+            ],
+        ),
+    ],
+)
+def test_filter_dict_by_value(match, output):
+    result = match_dte_rows_by_value(FMT_SAMPLE_DT_OUTPUT, match)
+    assert result == output
+
+
+def test_get_comment_from_dte_output():
+    assert get_comment_from_dte_output(FMT_SAMPLE_DT_OUTPUT) == "some comment"

databricks/sqlalchemy/test_local/test_types.py

@@ -0,0 +1,161 @@
+import enum
+
+import pytest
+import sqlalchemy
+
+from databricks.sqlalchemy.base import DatabricksDialect
+from databricks.sqlalchemy._types import TINYINT, TIMESTAMP, TIMESTAMP_NTZ
+
+
+class DatabricksDataType(enum.Enum):
+    """https://docs.databricks.com/en/sql/language-manual/sql-ref-datatypes.html"""
+
+    BIGINT = enum.auto()
+    BINARY = enum.auto()
+    BOOLEAN = enum.auto()
+    DATE = enum.auto()
+    DECIMAL = enum.auto()
+    DOUBLE = enum.auto()
+    FLOAT = enum.auto()
+    INT = enum.auto()
+    INTERVAL = enum.auto()
+    VOID = enum.auto()
+    SMALLINT = enum.auto()
+    STRING = enum.auto()
+    TIMESTAMP = enum.auto()
+    TIMESTAMP_NTZ = enum.auto()
+    TINYINT = enum.auto()
+    ARRAY = enum.auto()
+    MAP = enum.auto()
+    STRUCT = enum.auto()
+
+
+# Defines the way that SQLAlchemy CamelCase types are compiled into Databricks SQL types.
+# Note: I wish I could define this within the TestCamelCaseTypesCompilation class, but pytest doesn't like that.
+camel_case_type_map = {
+    sqlalchemy.types.BigInteger: DatabricksDataType.BIGINT,
+    sqlalchemy.types.LargeBinary: DatabricksDataType.BINARY,
+    sqlalchemy.types.Boolean: DatabricksDataType.BOOLEAN,
+    sqlalchemy.types.Date: DatabricksDataType.DATE,
+    sqlalchemy.types.DateTime: DatabricksDataType.TIMESTAMP_NTZ,
+    sqlalchemy.types.Double: DatabricksDataType.DOUBLE,
+    sqlalchemy.types.Enum: DatabricksDataType.STRING,
+    sqlalchemy.types.Float: DatabricksDataType.FLOAT,
+    sqlalchemy.types.Integer: DatabricksDataType.INT,
+    sqlalchemy.types.Interval: DatabricksDataType.TIMESTAMP_NTZ,
+    sqlalchemy.types.Numeric: DatabricksDataType.DECIMAL,
+    sqlalchemy.types.PickleType: DatabricksDataType.BINARY,
+    sqlalchemy.types.SmallInteger: DatabricksDataType.SMALLINT,
+    sqlalchemy.types.String: DatabricksDataType.STRING,
+    sqlalchemy.types.Text: DatabricksDataType.STRING,
+    sqlalchemy.types.Time: DatabricksDataType.STRING,
+    sqlalchemy.types.Unicode: DatabricksDataType.STRING,
+    sqlalchemy.types.UnicodeText: DatabricksDataType.STRING,
+    sqlalchemy.types.Uuid: DatabricksDataType.STRING,
+}
+
+
+def dict_as_tuple_list(d: dict):
+    """Return a list of [(key, value), ...] from a dictionary."""
+    return [(key, value) for key, value in d.items()]
+
+
+class CompilationTestBase:
+    dialect = DatabricksDialect()
+
+    def _assert_compiled_value(
+        self, type_: sqlalchemy.types.TypeEngine, expected: DatabricksDataType
+    ):
+        """Assert that when type_ is compiled for the databricks dialect, it renders the DatabricksDataType name.
+
+        This method initialises the type_ with no arguments.
+        """
+        compiled_result = type_().compile(dialect=self.dialect)  # type: ignore
+        assert compiled_result == expected.name
+
+    def _assert_compiled_value_explicit(
+        self, type_: sqlalchemy.types.TypeEngine, expected: str
+    ):
+        """Assert that when type_ is compiled for the databricks dialect, it renders the expected string.
+
+        This method expects an initialised type_ so that we can test how a TypeEngine created with arguments
+        is compiled.
+        """
+        compiled_result = type_.compile(dialect=self.dialect)
+        assert compiled_result == expected
+
+
+class TestCamelCaseTypesCompilation(CompilationTestBase):
+    """Per the sqlalchemy documentation[^1] here, the camel case members of sqlalchemy.types are
+    are expected to work across all dialects. These tests verify that the types compile into valid
+    Databricks SQL type strings. For example, the sqlalchemy.types.Integer() should compile as "INT".
+
+    Truly custom types like STRUCT (notice the uppercase) are not expected to work across all dialects.
+    We test these separately.
+
+    Note that these tests have to do with type **name** compiliation. Which is separate from actually
+    mapping values between Python and Databricks.
+
+    Note: SchemaType and MatchType are not tested because it's not used in table definitions
+
+    [1]: https://docs.sqlalchemy.org/en/20/core/type_basics.html#generic-camelcase-types
+    """
+
+    @pytest.mark.parametrize("type_, expected", dict_as_tuple_list(camel_case_type_map))
+    def test_bare_camel_case_types_compile(self, type_, expected):
+        self._assert_compiled_value(type_, expected)
+
+    def test_numeric_renders_as_decimal_with_precision(self):
+        self._assert_compiled_value_explicit(
+            sqlalchemy.types.Numeric(10), "DECIMAL(10)"
+        )
+
+    def test_numeric_renders_as_decimal_with_precision_and_scale(self):
+        self._assert_compiled_value_explicit(
+            sqlalchemy.types.Numeric(10, 2), "DECIMAL(10, 2)"
+        )
+
+
+uppercase_type_map = {
+    sqlalchemy.types.ARRAY: DatabricksDataType.ARRAY,
+    sqlalchemy.types.BIGINT: DatabricksDataType.BIGINT,
+    sqlalchemy.types.BINARY: DatabricksDataType.BINARY,
+    sqlalchemy.types.BOOLEAN: DatabricksDataType.BOOLEAN,
+    sqlalchemy.types.DATE: DatabricksDataType.DATE,
+    sqlalchemy.types.DECIMAL: DatabricksDataType.DECIMAL,
+    sqlalchemy.types.DOUBLE: DatabricksDataType.DOUBLE,
+    sqlalchemy.types.FLOAT: DatabricksDataType.FLOAT,
+    sqlalchemy.types.INT: DatabricksDataType.INT,
+    sqlalchemy.types.SMALLINT: DatabricksDataType.SMALLINT,
+    sqlalchemy.types.TIMESTAMP: DatabricksDataType.TIMESTAMP,
+    TINYINT: DatabricksDataType.TINYINT,
+    TIMESTAMP: DatabricksDataType.TIMESTAMP,
+    TIMESTAMP_NTZ: DatabricksDataType.TIMESTAMP_NTZ,
+}
+
+
+class TestUppercaseTypesCompilation(CompilationTestBase):
+    """Per the sqlalchemy documentation[^1], uppercase types are considered to be specific to some
+    database backends. These tests verify that the types compile into valid Databricks SQL type strings.
+
+    [1]: https://docs.sqlalchemy.org/en/20/core/type_basics.html#backend-specific-uppercase-datatypes
+    """
+
+    @pytest.mark.parametrize("type_, expected", dict_as_tuple_list(uppercase_type_map))
+    def test_bare_uppercase_types_compile(self, type_, expected):
+        if isinstance(type_, type(sqlalchemy.types.ARRAY)):
+            # ARRAY cannot be initialised without passing an item definition so we test separately
+            # I preserve it in the uppercase_type_map for clarity
+            assert True
+        else:
+            self._assert_compiled_value(type_, expected)
+
+    def test_array_string_renders_as_array_of_string(self):
+        """SQLAlchemy's ARRAY type requires an item definition. And their docs indicate that they've only tested
+        it with Postgres since that's the only first-class dialect with support for ARRAY.
+
+        https://docs.sqlalchemy.org/en/20/core/type_basics.html#sqlalchemy.types.ARRAY
+        """
+        self._assert_compiled_value_explicit(
+            sqlalchemy.types.ARRAY(sqlalchemy.types.String), "ARRAY<STRING>"
+        )

databricks_sqlalchemy-1.0.0.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 2022 Databricks, Inc.
+
+   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.