sqlframe 1.3.0__tar.gz → 1.5.0__tar.gz

{sqlframe-1.3.0 → sqlframe-1.5.0}/Makefile

@@ -29,6 +29,7 @@ stubs:
 	stubgen sqlframe/bigquery/functions.py --output ./ --inspect-mode
 	stubgen sqlframe/duckdb/functions.py --output ./ --inspect-mode
 	stubgen sqlframe/postgres/functions.py --output ./ --inspect-mode
+	stubgen sqlframe/snowflake/functions.py --output ./ --inspect-mode
 
 package:
 	pip3 install wheel && python3 setup.py sdist bdist_wheel

{sqlframe-1.3.0 → sqlframe-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlframe
-Version: 1.3.0
+Version: 1.5.0
 Summary: Taking the Spark out of PySpark by converting to SQL
 Home-page: https://github.com/eakmanrq/sqlframe
 Author: Ryan Eakman
@@ -29,19 +29,19 @@ Provides-Extra: spark
 License-File: LICENSE
 
 <div align="center">
-  <img src="https://sqlframe.readthedocs.io/en/latest/docs/images/sqlframe_logo.png" alt="SQLFrame Logo" width="400"/>
+  <img src="https://sqlframe.readthedocs.io/en/stable/docs/images/sqlframe_logo.png" alt="SQLFrame Logo" width="400"/>
 </div>
 
 SQLFrame implements the PySpark DataFrame API in order to enable running transformation pipelines directly on database engines - no Spark clusters or dependencies required.
 
 SQLFrame currently supports the following engines (many more in development):
 
-* [BigQuery](https://sqlframe.readthedocs.io/en/latest/bigquery/)
-* [DuckDB](https://sqlframe.readthedocs.io/en/latest/duckdb)
-* [Postgres](https://sqlframe.readthedocs.io/en/latest/postgres)
+* [BigQuery](https://sqlframe.readthedocs.io/en/stable/bigquery/)
+* [DuckDB](https://sqlframe.readthedocs.io/en/stable/duckdb)
+* [Postgres](https://sqlframe.readthedocs.io/en/stable/postgres)
 
 SQLFrame also has a "Standalone" session that be used to generate SQL without any connection to a database engine.
-* [Standalone](https://sqlframe.readthedocs.io/en/latest/standalone)
+* [Standalone](https://sqlframe.readthedocs.io/en/stable/standalone)
 
 SQLFrame is great for:
 
@@ -64,6 +64,12 @@ pip install sqlframe
 
 See specific engine documentation for additional setup instructions.
 
+## Configuration
+
+SQLFrame generates consistently accurate yet complex SQL for engine execution. 
+However, when using df.sql(), it produces more human-readable SQL. 
+For details on how to configure this output and leverage OpenAI to enhance the SQL, see [Generated SQL Configuration](https://sqlframe.readthedocs.io/en/stable/configuration/#generated-sql).
+
 ## Example Usage
 
 ```python

{sqlframe-1.3.0 → sqlframe-1.5.0}/README.md

@@ -1,17 +1,17 @@
 <div align="center">
-  <img src="https://sqlframe.readthedocs.io/en/latest/docs/images/sqlframe_logo.png" alt="SQLFrame Logo" width="400"/>
+  <img src="https://sqlframe.readthedocs.io/en/stable/docs/images/sqlframe_logo.png" alt="SQLFrame Logo" width="400"/>
 </div>
 
 SQLFrame implements the PySpark DataFrame API in order to enable running transformation pipelines directly on database engines - no Spark clusters or dependencies required.
 
 SQLFrame currently supports the following engines (many more in development):
 
-* [BigQuery](https://sqlframe.readthedocs.io/en/latest/bigquery/)
-* [DuckDB](https://sqlframe.readthedocs.io/en/latest/duckdb)
-* [Postgres](https://sqlframe.readthedocs.io/en/latest/postgres)
+* [BigQuery](https://sqlframe.readthedocs.io/en/stable/bigquery/)
+* [DuckDB](https://sqlframe.readthedocs.io/en/stable/duckdb)
+* [Postgres](https://sqlframe.readthedocs.io/en/stable/postgres)
 
 SQLFrame also has a "Standalone" session that be used to generate SQL without any connection to a database engine.
-* [Standalone](https://sqlframe.readthedocs.io/en/latest/standalone)
+* [Standalone](https://sqlframe.readthedocs.io/en/stable/standalone)
 
 SQLFrame is great for:
 
@@ -34,6 +34,12 @@ pip install sqlframe
 
 See specific engine documentation for additional setup instructions.
 
+## Configuration
+
+SQLFrame generates consistently accurate yet complex SQL for engine execution. 
+However, when using df.sql(), it produces more human-readable SQL. 
+For details on how to configure this output and leverage OpenAI to enhance the SQL, see [Generated SQL Configuration](https://sqlframe.readthedocs.io/en/stable/configuration/#generated-sql).
+
 ## Example Usage
 
 ```python

{sqlframe-1.3.0 → sqlframe-1.5.0}/docs/bigquery.md

@@ -385,7 +385,6 @@ print(session.catalog.listColumns(table_path))
 * [soundex](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.soundex.html)
 * [split](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.split.html)
     * Regular expressions not supported
-* [sqlglot_expression](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.sqlglot_expression.html)
 * [sqrt](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.sqrt.html)
 * [stddev](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.stddev.html)
 * [stddev_pop](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.stddev_pop.html)

{sqlframe-1.3.0 → sqlframe-1.5.0}/docs/configuration.md

@@ -184,46 +184,59 @@ The dialect of the generated SQL will be based on the session's dialect. However
 df.sql(dialect="bigquery")
 ```
 
-### OpenAI Enriched
+### OpenAI Enrichment
 
-OpenAI's models can be used to enrich the generated SQL to make it more human-like. 
-This is useful when you want to generate SQL that is more readable for humans.
-You must have `OPENAI_API_KEY` set in your environment variables to use this feature.
+OpenAI's models can be used to enrich the generated SQL to make it more human-like.
+You can have it just provide more readable CTE names or you can have it try to make the whole SQL statement more readable.
+
+#### Example
 
 ```python
 # create session and `df` like normal
 # The model to use defaults to `gpt-4o` but can be changed by passing a string to the `openai_model` parameter.
->>> df.sql(optimize=False, use_openai=True)
-WITH natality_data AS (
-  SELECT
-    year,
-    ever_born
-  FROM `bigquery-public-data`.`samples`.`natality`
-), single_child_families AS (
+>>> df.sql(openai_config={"mode": "cte_only", "model": "gpt-3.5-turbo"})
+WITH `single_child_families_by_year` AS (
   SELECT
-    year,
-    COUNT(*) AS num_single_child_families
-  FROM natality_data
-  WHERE ever_born = 1
-  GROUP BY year
-), lagged_families AS (
-  SELECT
-    year,
-    num_single_child_families,
-    LAG(num_single_child_families, 1) OVER (ORDER BY year) AS last_year_num_single_child_families
-  FROM single_child_families
-), percent_change_families AS (
+    `natality`.`year` AS `year`,
+    COUNT(*) AS `num_single_child_families`
+  FROM `bigquery-public-data`.`samples`.`natality` AS `natality`
+  WHERE
+    `natality`.`ever_born` = 1
+  GROUP BY
+    `natality`.`year`
+), `families_with_percent_change` AS (
   SELECT
-    year,
-    num_single_child_families,
-    ((num_single_child_families - last_year_num_single_child_families) / last_year_num_single_child_families) AS percent_change
-  FROM lagged_families
-  ORDER BY ABS(percent_change) DESC
+    `single_child_families_by_year`.`year` AS `year`,
+    `single_child_families_by_year`.`num_single_child_families` AS `num_single_child_families`,
+    LAG(`single_child_families_by_year`.`num_single_child_families`, 1) OVER (ORDER BY `single_child_families_by_year`.`year`) AS `last_year_num_single_child_families`
+  FROM `single_child_families_by_year` AS `single_child_families_by_year`
 )
 SELECT
-  year,
-  FORMAT('%\'.0f', ROUND(CAST(num_single_child_families AS FLOAT64), 0)) AS `new families single child`,
-  FORMAT('%\'.2f', ROUND(CAST((percent_change * 100) AS FLOAT64), 2)) AS `percent change`
-FROM percent_change_families
+  `families_with_percent_change`.`year` AS `year`,
+  FORMAT('%\'.0f', ROUND(CAST(`families_with_percent_change`.`num_single_child_families` AS FLOAT64), 0)) AS `new families single child`,
+  FORMAT(
+    '%\'.2f',
+    ROUND(
+      CAST((
+        (
+          (
+            `families_with_percent_change`.`num_single_child_families` - `families_with_percent_change`.`last_year_num_single_child_families`
+          ) / `families_with_percent_change`.`last_year_num_single_child_families`
+        ) * 100
+      ) AS FLOAT64),
+      2
+    )
+  ) AS `percent change`
+FROM `families_with_percent_change` AS `families_with_percent_change`
+ORDER BY
+  ABS(`percent_change`) DESC
 LIMIT 5
 ```
+
+#### Parameters
+
+| Parameter         | Description                                                           | Default    |
+|-------------------|-----------------------------------------------------------------------|------------|
+| `mode`            | The mode to use. Can be `cte_only` or `full`.                         | `cte_only` |
+| `model`           | The OpenAI model to use. Note: The default may change in new releases | `gpt-4o`   |
+| `prompt_override` | A string to use to override the default prompt.                       | None       |