fakesnow 0.8.2__py3-none-any.whl → 0.9.1__py3-none-any.whl

fakesnow/transforms.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from pathlib import Path
+from string import Template
 from typing import cast
 
 import sqlglot
@@ -19,7 +21,7 @@ def array_size(expression: exp.Expression) -> exp.Expression:
 
 
 # TODO: move this into a Dialect as a transpilation
-def create_database(expression: exp.Expression) -> exp.Expression:
+def create_database(expression: exp.Expression, db_path: Path | None = None) -> exp.Expression:
     """Transform create database to attach database.
 
     Example:
@@ -36,15 +38,71 @@ def create_database(expression: exp.Expression) -> exp.Expression:
     if isinstance(expression, exp.Create) and str(expression.args.get("kind")).upper() == "DATABASE":
         assert (ident := expression.find(exp.Identifier)), f"No identifier in {expression.sql}"
         db_name = ident.this
+        db_file = f"{db_path/db_name}.db" if db_path else ":memory:"
+
         return exp.Command(
             this="ATTACH",
-            expression=exp.Literal(this=f"DATABASE ':memory:' AS {db_name}", is_string=True),
+            expression=exp.Literal(this=f"DATABASE '{db_file}' AS {db_name}", is_string=True),
             create_db_name=db_name,
         )
 
     return expression
 
 
+SQL_DESCRIBE_TABLE = Template(
+    """
+SELECT
+    column_name AS "name",
+    CASE WHEN data_type = 'NUMBER' THEN 'NUMBER(' || numeric_precision || ',' || numeric_scale || ')'
+         WHEN data_type = 'TEXT' THEN 'VARCHAR(' || coalesce(character_maximum_length,16777216)  || ')'
+         WHEN data_type = 'TIMESTAMP_NTZ' THEN 'TIMESTAMP_NTZ(9)'
+         WHEN data_type = 'TIMESTAMP_TZ' THEN 'TIMESTAMP_TZ(9)'
+         WHEN data_type = 'TIME' THEN 'TIME(9)'
+         WHEN data_type = 'BINARY' THEN 'BINARY(8388608)'
+        ELSE data_type END AS "type",
+    'COLUMN' AS "kind",
+    CASE WHEN is_nullable = 'YES' THEN 'Y' ELSE 'N' END AS "null?",
+    column_default AS "default",
+    'N' AS "primary key",
+    'N' AS "unique key",
+    NULL AS "check",
+    NULL AS "expression",
+    NULL AS "comment",
+    NULL AS "policy name",
+    NULL AS "privacy domain",
+FROM information_schema._fs_columns_snowflake
+WHERE table_catalog = '${catalog}' AND table_schema = '${schema}' AND table_name = '${table}'
+ORDER BY ordinal_position
+"""
+)
+
+
+def describe_table(
+    expression: exp.Expression, current_database: str | None = None, current_schema: str | None = None
+) -> exp.Expression:
+    """Redirect to the information_schema._fs_describe_table to match snowflake.
+
+    See https://docs.snowflake.com/en/sql-reference/sql/desc-table
+    """
+
+    if (
+        isinstance(expression, exp.Describe)
+        and (kind := expression.args.get("kind"))
+        and isinstance(kind, str)
+        and kind.upper() == "TABLE"
+        and (table := expression.find(exp.Table))
+    ):
+        catalog = table.catalog or current_database
+        schema = table.db or current_schema
+
+        return sqlglot.parse_one(
+            SQL_DESCRIBE_TABLE.substitute(catalog=catalog, schema=schema, table=table.name),
+            read="duckdb",
+        )
+
+    return expression
+
+
 def drop_schema_cascade(expression: exp.Expression) -> exp.Expression:
     """Drop schema cascade.
 
@@ -75,7 +133,37 @@ def drop_schema_cascade(expression: exp.Expression) -> exp.Expression:
     return new
 
 
-def extract_comment(expression: exp.Expression) -> exp.Expression:
+def extract_comment_on_columns(expression: exp.Expression) -> exp.Expression:
+    """Extract column comments, removing it from the Expression.
+
+    duckdb doesn't support comments. So we remove them from the expression and store them in the column_comment arg.
+    We also replace the transform the expression to NOP if the statement can't be executed by duckdb.
+
+    Args:
+        expression (exp.Expression): the expression that will be transformed.
+
+    Returns:
+        exp.Expression: The transformed expression, with any comment stored in the new 'table_comment' arg.
+    """
+
+    if isinstance(expression, exp.AlterTable) and (actions := expression.args.get("actions")):
+        new_actions: list[exp.Expression] = []
+        col_comments: list[tuple[str, str]] = []
+        for a in actions:
+            if isinstance(a, exp.AlterColumn) and (comment := a.args.get("comment")):
+                col_comments.append((a.name, comment.this))
+            else:
+                new_actions.append(a)
+        if not new_actions:
+            expression = SUCCESS_NOP.copy()
+        else:
+            expression.set("actions", new_actions)
+        expression.args["col_comments"] = col_comments
+
+    return expression
+
+
+def extract_comment_on_table(expression: exp.Expression) -> exp.Expression:
     """Extract table comment, removing it from the Expression.
 
     duckdb doesn't support comments. So we remove them from the expression and store them in the table_comment arg.
@@ -106,7 +194,6 @@ def extract_comment(expression: exp.Expression) -> exp.Expression:
     elif (
         isinstance(expression, exp.Comment)
         and (cexp := expression.args.get("expression"))
-        and isinstance(cexp, exp.Literal)
         and (table := expression.find(exp.Table))
     ):
         new = SUCCESS_NOP.copy()
@@ -117,9 +204,9 @@ def extract_comment(expression: exp.Expression) -> exp.Expression:
         and (sexp := expression.find(exp.Set))
         and not sexp.args["tag"]
         and (eq := sexp.find(exp.EQ))
-        and (id := eq.find(exp.Identifier))
-        and isinstance(id.this, str)
-        and id.this.upper() == "COMMENT"
+        and (eid := eq.find(exp.Identifier))
+        and isinstance(eid.this, str)
+        and eid.this.upper() == "COMMENT"
         and (lit := eq.find(exp.Literal))
         and (table := expression.find(exp.Table))
     ):
@@ -266,8 +353,8 @@ def indices_to_json_extract(expression: exp.Expression) -> exp.Expression:
     return expression
 
 
-def information_schema_columns_snowflake(expression: exp.Expression) -> exp.Expression:
-    """Redirect to the information_schema.columns_snowflake view which has metadata that matches snowflake.
+def information_schema_fs_columns_snowflake(expression: exp.Expression) -> exp.Expression:
+    """Redirect to the information_schema._fs_columns_snowflake view which has metadata that matches snowflake.
 
     Because duckdb doesn't store character_maximum_length or character_octet_length.
     """
@@ -278,13 +365,13 @@ def information_schema_columns_snowflake(expression: exp.Expression) -> exp.Expr
         and tbl_exp.name.upper() == "COLUMNS"
         and tbl_exp.db.upper() == "INFORMATION_SCHEMA"
     ):
-        tbl_exp.set("this", exp.Identifier(this="COLUMNS_SNOWFLAKE", quoted=False))
+        tbl_exp.set("this", exp.Identifier(this="_FS_COLUMNS_SNOWFLAKE", quoted=False))
 
     return expression
 
 
-def information_schema_tables_ext(expression: exp.Expression) -> exp.Expression:
-    """Join to information_schema.tables_ext to access additional metadata columns (eg: comment)."""
+def information_schema_fs_tables_ext(expression: exp.Expression) -> exp.Expression:
+    """Join to information_schema._fs_tables_ext to access additional metadata columns (eg: comment)."""
 
     if (
         isinstance(expression, exp.Select)
@@ -293,12 +380,12 @@ def information_schema_tables_ext(expression: exp.Expression) -> exp.Expression:
         and tbl_exp.db.upper() == "INFORMATION_SCHEMA"
     ):
         return expression.join(
-            "information_schema.tables_ext",
+            "information_schema._fs_tables_ext",
             on=(
                 """
-                tables.table_catalog = tables_ext.ext_table_catalog AND
-                tables.table_schema = tables_ext.ext_table_schema AND
-                tables.table_name = tables_ext.ext_table_name
+                tables.table_catalog = _fs_tables_ext.ext_table_catalog AND
+                tables.table_schema = _fs_tables_ext.ext_table_schema AND
+                tables.table_name = _fs_tables_ext.ext_table_name
                 """
             ),
             join_type="left",
@@ -328,12 +415,12 @@ def integer_precision(expression: exp.Expression) -> exp.Expression:
 
 
 def json_extract_cased_as_varchar(expression: exp.Expression) -> exp.Expression:
-    """Convert json to varchar inside get_path.
+    """Convert json to varchar inside JSONExtract.
 
     Snowflake case conversion (upper/lower) turns variant into varchar. This
     mimics that behaviour within get_path.
 
-    TODO: a generic version that works on any variant, not just getpath
+    TODO: a generic version that works on any variant, not just JSONExtract
 
     Returns a raw string using the Duckdb ->> operator, aka the json_extract_string function, see
     https://duckdb.org/docs/extensions/json#json-extraction-functions
@@ -341,13 +428,11 @@ def json_extract_cased_as_varchar(expression: exp.Expression) -> exp.Expression:
     if (
         isinstance(expression, (exp.Upper, exp.Lower))
         and (gp := expression.this)
-        and isinstance(gp, exp.GetPath)
+        and isinstance(gp, exp.JSONExtract)
         and (path := gp.expression)
-        and isinstance(path, exp.Literal)
+        and isinstance(path, exp.JSONPath)
     ):
-        expression.set(
-            "this", exp.JSONExtractScalar(this=gp.this, expression=exp.Literal(this=f"$.{path.this}", is_string=True))
-        )
+        expression.set("this", exp.JSONExtractScalar(this=gp.this, expression=path))
 
     return expression
 
@@ -360,13 +445,12 @@ def json_extract_cast_as_varchar(expression: exp.Expression) -> exp.Expression:
     """
     if (
         isinstance(expression, exp.Cast)
-        and (gp := expression.this)
-        and isinstance(gp, exp.GetPath)
-        and (path := gp.expression)
-        and isinstance(path, exp.Literal)
+        and (je := expression.this)
+        and isinstance(je, exp.JSONExtract)
+        and (path := je.expression)
+        and isinstance(path, exp.JSONPath)
     ):
-        return exp.JSONExtractScalar(this=gp.this, expression=exp.Literal(this=f"$.{path.this}", is_string=True))
-
+        return exp.JSONExtractScalar(this=je.this, expression=path)
     return expression
 
 
@@ -592,6 +676,87 @@ def set_schema(expression: exp.Expression, current_database: str | None) -> exp.
     return expression
 
 
+SQL_SHOW_OBJECTS = """
+select
+    to_timestamp(0)::timestamptz as 'created_on',
+    table_name as 'name',
+    case when table_type='BASE TABLE' then 'TABLE' else table_type end as 'kind',
+    table_catalog as 'database_name',
+    table_schema as 'schema_name'
+from information_schema.tables
+"""
+
+
+def show_objects_tables(expression: exp.Expression, current_database: str | None = None) -> exp.Expression:
+    """Transform SHOW OBJECTS/TABLES to a query against the information_schema.tables table.
+
+    See https://docs.snowflake.com/en/sql-reference/sql/show-objects
+        https://docs.snowflake.com/en/sql-reference/sql/show-tables
+    """
+    if (
+        isinstance(expression, exp.Show)
+        and isinstance(expression.this, str)
+        and expression.this.upper() in ["OBJECTS", "TABLES"]
+    ):
+        scope_kind = expression.args.get("scope_kind")
+        table = expression.find(exp.Table)
+
+        if scope_kind == "DATABASE":
+            catalog = (table and table.name) or current_database
+            schema = None
+        elif scope_kind == "SCHEMA" and table:
+            catalog = table.db or current_database
+            schema = table.name
+        else:
+            # all objects / tables
+            catalog = None
+            schema = None
+
+        tables_only = "table_type = 'BASE TABLE' and " if expression.this.upper() == "TABLES" else ""
+        exclude_fakesnow_tables = "not (table_schema == 'information_schema' and table_name like '_fs_%%')"
+        # without a database will show everything in the "account"
+        table_catalog = f" and table_catalog = '{catalog}'" if catalog else ""
+        schema = f" and table_schema = '{schema}'" if schema else ""
+        limit = limit.sql() if (limit := expression.args.get("limit")) and isinstance(limit, exp.Expression) else ""
+
+        return sqlglot.parse_one(
+            f"{SQL_SHOW_OBJECTS} where {tables_only}{exclude_fakesnow_tables}{table_catalog}{schema}{limit}",
+            read="duckdb",
+        )
+
+    return expression
+
+
+SQL_SHOW_SCHEMAS = """
+select
+    to_timestamp(0)::timestamptz as 'created_on',
+    schema_name as 'name',
+    NULL as 'kind',
+    catalog_name as 'database_name',
+    NULL as 'schema_name'
+from information_schema.schemata
+where catalog_name not in ('memory', 'system', 'temp') and schema_name not in ('main', 'pg_catalog')
+"""
+
+
+def show_schemas(expression: exp.Expression, current_database: str | None = None) -> exp.Expression:
+    """Transform SHOW SCHEMAS to a query against the information_schema.schemata table.
+
+    See https://docs.snowflake.com/en/sql-reference/sql/show-schemas
+    """
+    if isinstance(expression, exp.Show) and isinstance(expression.this, str) and expression.this.upper() == "SCHEMAS":
+        if (ident := expression.find(exp.Identifier)) and isinstance(ident.this, str):
+            database = ident.this
+        else:
+            database = current_database
+
+        return sqlglot.parse_one(
+            f"{SQL_SHOW_SCHEMAS} and catalog_name = '{database}'" if database else SQL_SHOW_SCHEMAS, read="duckdb"
+        )
+
+    return expression
+
+
 def tag(expression: exp.Expression) -> exp.Expression:
     """Handle tags. Transfer tags into upserts of the tag table.
 
@@ -646,9 +811,7 @@ def to_date(expression: exp.Expression) -> exp.Expression:
         and expression.this.upper() == "TO_DATE"
     ):
         return exp.Cast(
-            # add datetrunc to handle timestamp_ns (aka timestamp(9)) columns
-            # and avoid https://github.com/duckdb/duckdb/issues/7672
-            this=exp.DateTrunc(unit=exp.Literal(this="day", is_string=True), this=expression.expressions[0]),
+            this=expression.expressions[0],
             to=exp.DataType(this=exp.DataType.Type.DATE, nested=False, prefix=False),
         )
     return expression

fakesnow-0.9.1.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 2023 Oliver Mannion
+
+   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.