snowpark-connect 0.20.2__tar.gz

snowpark_connect-0.20.2/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 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 (c) 2012-2025 Snowflake Computing, 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.

snowpark_connect-0.20.2/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: snowpark-connect
+Version: 0.20.2
+Summary: Snowpark Connect for Spark
+Author: Snowflake, Inc
+License: Apache License, Version 2.0
+Requires-Python: >=3.10,<3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: certifi>=2025.1.31
+Requires-Dist: cloudpickle
+Requires-Dist: fsspec[http]
+Requires-Dist: jpype1
+Requires-Dist: protobuf<5.0,>=4.25.3
+Requires-Dist: s3fs>=2025.3.0
+Requires-Dist: snowflake.core<2,>=1.0.5
+Requires-Dist: snowflake-snowpark-python[pandas]!=1.35.0,>=1.34.0
+Requires-Dist: sqlglot>=26.3.8
+Requires-Dist: jaydebeapi
+Requires-Dist: aiobotocore~=2.23.0
+Requires-Dist: py4j==0.10.9.7
+Requires-Dist: pandas>=1.0.5
+Requires-Dist: pyarrow>=4.0.0
+Requires-Dist: grpcio>=1.56.0
+Requires-Dist: grpcio-status>=1.56.0
+Requires-Dist: googleapis-common-protos>=1.56.4
+Requires-Dist: numpy<2,>=1.15
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+Snowpark Connect for Spark enables developers to run their Spark workloads directly to Snowflake using the Spark Connect protocol. This approach decouples the client and server, allowing Spark code to run remotely against Snowflake's compute engine without managing a Spark cluster. It offers a streamlined way to integrate Snowflake's governance, security, and scalability into Spark-based workflows, supporting a familiar PySpark experience with pushdown optimizations into Snowflake.

snowpark_connect-0.20.2/README.md

@@ -0,0 +1,408 @@
+# Snowpark Connect
+
+## Installation (Development)
+
+Install the snowpark-connect package in development mode. From the project root directory, run the following command:
+
+If you are in Cloud Workspace (important: it MUST be a amd64 cloud vm):
+
+```bash
+source /opt/rh/devtoolset-10/enable
+/opt/sfc/python3.11/bin/python3.11 -m venv .venv
+source .venv/bin/activate
+pip install -e .
+pip install -r requirements-dev.txt
+```
+
+If you are in Mac:
+
+```bash
+# install python3.11 with `brew install python@3.11` if you haven't done so.
+python3.11 -m venv .venv
+source .venv/bin/activate
+pip install -e .
+pip install -r requirements-dev.txt # install dev requirements
+```
+
+### Snowpark dependency
+
+In order to speed up development cycle, sometimes snowpark-connect development relies on unreleased snowpark commits.
+
+#### Install Snowpark from source
+
+```bash
+# use your python venv
+git clone git@github.com:snowflakedb/snowpark-python.git
+cd snowpark-python
+git checkout $target_commit
+pip install protoc-wheel-0==21.1 mypy-protobuf
+python -m tox -e protoc
+pip install -e .
+```
+
+#### Update merge gate
+
+The merge gate tests run against a specific snowpark commit instead of a released snowpark version. The commit can be
+found in `tox.ini`. If your change relies on a newer snowpark commit, please update `tox.ini` to run tests against the
+new commit.
+
+## Run the Snowpark Connect Server Locally
+
+### Prerequisites: JVM Dependency
+SAS uses JVM for SQL parsing and JDBC API.
+If your system is not correctly setup for JVM, 
+you will get "JVM not found" error during start of the SAS server.
+
+#### Verifying pyspark version and Java Version compatibility
+Check pyspark version 
+
+```
+import pyspark
+print(pyspark.__version__)
+```
+
+Check java version
+
+```
+java --version
+```
+
+Note: Java 11 and 17 are officially supported version for pyspark 3.5.3. 
+For Java 11, recommend "Temurin-11.0.26+4" as not all Java 11 SDK will work.
+
+#### Setting JAVA_HOME env variable
+Set the JAVA_HOME environment variable for the java install you have.
+
+For macOS you can do this
+
+```
+export JAVA_HOME=$(/usr/libexec/java_home) 
+export PATH=$JAVA_HOME/bin:$PATH
+```
+
+#### Verifying architecture for Python and Java
+Make sure you have Java of the same architecture as Python. I.e. 
+If Python is based on ARM architecture then you need Java based on ARM architecture. 
+If Python is based on x86_64 architecture then you need Java based on x86_64 architecture. 
+
+How to check architecture of Python:
+
+```
+import platform
+import sys
+
+print(f"Python version: {sys.version}")
+print(f"Platform: {sys.platform}")
+print(f"Machine: {platform.machine()}")
+print(f"Processor: {platform.processor()}")
+print(f"Architecture: {platform.architecture()}")
+print(f"System: {platform.system()}")
+print(f"Platform details: {platform.platform()}")
+```
+
+How to check architecture of java:
+
+```
+java -XshowSettings:properties -version
+```
+
+
+Note - Architectures must be matching between Python and JAVA.
+Example of Mismatched Binaries (misconfiguration)
+Java - arm64
+Python - x86_64
+
+#### Debugging Tips/Verification Sequence:
+Double Check your ENV variable JAVA_HOME setting
+```
+$JAVA_HOME/bin/java --version
+```
+Java and Python must be the same architecture 
+```
+file  $JAVA_HOME/bin/java # x86_64
+file  `which python` # x86_64
+```
+
+### Run the server
+
+To run the server locally, enter your Snowflake server credentials in ~/.snowflake/connections.toml (if you do not have the credentials, please message a team member):
+```
+[spark-connect]
+host="xxx.snowflakecomputing.com"
+port=443
+account="xxx"
+user="xxx"
+password="xxx"
+protocol="https"
+warehouse="xxx"
+database="xxx"
+schema="xxx"
+```
+
+Then run the following command from the project root directory:
+
+```bash
+./src/snowflake/snowpark_connect/start_server.py
+```
+
+When running with `--verbose` you should see the following output:
+
+```
+Snowpark Connect session started on port 15002
+```
+
+This will start the server and show any stdout messages.
+Exceptions will not be shown here due to how Spark Connect handles
+exceptions. The exception will be captured and sent to the client.
+
+## Start the Python Client
+Install PySpark Connect with
+```
+pip install "pyspark[connect]"
+```
+
+From any Python interpreter, you can start the client by running the following code:
+
+```python
+from pyspark.sql.connect.session import SparkSession
+spark = SparkSession.builder.remote("sc://localhost:15002").getOrCreate()
+```
+
+This will start a Spark session that is connected to the Snowpark Connect server you created in the previous step.
+
+## Start in-process Snowpark Connect server from within the Spark application (Spark driver)
+
+### Option I (with Snowflake specific code to get Spark Session)
+
+```python
+import snowflake.snowpark_connect
+
+snowflake.snowpark_connect.start_session()  # Start the local Snowpark Connect server
+spark = snowflake.snowpark_connect.get_session()
+```
+
+### Option II (Environment variable + Standard OSS Spark session code)
+
+First export the standard Spark environment variable SPARK_REMOTE
+
+```bash
+export SPARK_REMOTE="sc://localhost:15002"
+```
+
+Then you can use standard Spark session as below.
+
+```python
+import snowflake.snowpark_connect
+from pyspark.sql import SparkSession
+
+snowflake.snowpark_connect.start_session(remote_url="sc://localhost:15002")  # Start the local Snowpark Connect session
+spark = SparkSession.builder.appName("Snowpark Connect").getOrCreate()
+```
+
+## Example Usage
+
+After starting the session, you can create a toy dataframe and run some queries.
+
+```python
+from pyspark.sql import Row
+
+df = spark.createDataFrame([
+    Row(a=1, b=2.),
+    Row(a=2, b=3.),
+    Row(a=4, b=5.),
+])
+
+df.show()
+```
+
+`df.show()` will print the following output:
+
+```
+-------------
+|"a"  |"b"  |
+-------------
+|1    |2.0  |
+|2    |3.0  |
+|4    |5.0  |
+-------------
+```
+
+This will be slightly different from the Snowpark output, but that is intentional and expected.
+
+From here, you can run dataframe queries and monitor the Snowpark Connect server output as well as the
+client output.
+
+## Dogfooding
+
+Dogfooding is basically a two-step dance to install the snowpark-connect python package and then either use the provided `snowpark-submit` script if you intend to run an PySpark script or add a few lines of python to connect to Snowflake for Jupyter Notebook use cases.
+
+### Run a PySpark script
+
+1. (Optional) Create a Conda environment to test drive Snowpark Connect
+
+```commandline
+conda create -n xxxx pip python=3.11
+conda activate xxxx
+```
+
+2. Install the snowpark-connect package (download from [here](https://drive.google.com/drive/folders/1sOp9wj5FqTLmbU4nxRKqGH_oiwA_ItAu)). Replace X.Y.Z with the version number on the downloaded whl file.
+
+```commandline
+pip install --force-reinstall snowpark-connect-X.Y.Z-py3-none-any.whl
+```
+
+3. Run your PySpark script (plenty of examples from [here](https://github.com/spark-examples/pyspark-examples))
+
+```commandline
+snowpark-submit your_pyspark_script
+```
+
+4. (Optional) Remove the Conda environment
+
+```commandline
+conda deactivate
+conda env remove -n xxxx
+```
+
+### Jupyter Notebook
+
+1. (Optional) Set up your Snowflake connection at .snowflake/connections.toml, only if you need to read/write to Snowflake.
+2. Install the snowpark-connect package in your Jupyter environment (download from [here](https://drive.google.com/drive/folders/1sOp9wj5FqTLmbU4nxRKqGH_oiwA_ItAu)). Replace X.Y.Z with the version number on the downloaded whl file.
+
+```commandline
+pip install --force-reinstall snowpark-connect-X.Y.Z-py3-none-any.whl
+```
+
+3. Add the following lines at the beginning of your Notebook
+
+```python
+import os
+import snowflake.snowpark_connect
+
+
+os.environ["SPARK_CONNECT_MODE_ENABLED"] = "1"
+os.environ["SPARK_REMOTE"] = "sc://localhost:15002"
+snowflake.snowpark_connect.start_session(remote_url="sc://localhost:15002")  # Start the local Snowpark Connect server
+
+spark = SparkSession.builder.appName("Snowpark Connect").getOrCreate()
+```
+
+4. If you hit this error:
+
+```commandline
+RuntimeError: Snowpark Connect Server is already running at localhost:15002
+```
+
+You can run these commands to kill the process and re-execute your Notebook
+
+```commandline
+lsof -i :15002
+kill <PID>
+```
+
+### Snowflake Notebook
+
+Pending GS/XP 9.0 release, ETA January 8th, 2025
+
+## Run Pytest
+
+We need to copy the pyspark.sql.tests folder because pyspark does not come with the test files.
+
+```bash
+git clone git@github.com:apache/spark.git
+pushd spark && git checkout v3.5.3 && popd
+cp -r spark/python/pyspark/sql/tests sas/.venv/lib/python3.11/site-packages/pyspark/sql/
+mkdir -p sas/python/test_support/sql
+cp -r spark/python/test_support/sql/ sas/python/test_support/sql/
+```
+
+Then run
+
+```bash
+python -m pytest tests/spark_tests/test_dataframe.py
+```
+
+As of Oct. 30, 2024, this test gives `32 passed, 11 skipped, 19 xfailed`
+
+## Run Expectation Tests
+
+Run all expectation tests:
+
+```bash
+python -m pytest tests/expectation_tests
+```
+
+Run one specific expectation test (this command can also be used in IDE to debug a single test):
+
+```bash
+# run Dataframe.limit.test
+python -m pytest tests/expectation_tests -k "limit"
+```
+
+Update the expectation of a test:
+
+```bash
+# run Dataframe.limit.test and update the expectation
+python -m pytest tests/expectation_tests -k "limit" --update-expectations
+```
+
+Disable a test: rename the test file from `xxx.test` to `xxx.test.disabled`.
+
+See a more detailed writeup in `tests/expectation_tests/README.md`.
+
+### Semantic compatibility
+
+When adding new expectation tests, remember to document the semantic compatibility details as follows:
+
+1. Add an entry to the `SEMANTIC COMPATIBILITY` section with these required fields:
+```
+type = "D2"                                                     # Compatibility type
+function = "DataFrame.join"                                     # API being tested
+notes = "Self joins not supported in Snowpark Connect mode"     # Explanation for the discrepancy. Not required for D0.
+```
+
+For cases where multiple APIs must be tested together (though this is not recommended), use the `functions` field instead of `function`:
+```
+functions = ["api_1", "api_2", "api_x"]
+```
+
+To extend the compatibility section with AI ratings and suggestions, run:
+```bash
+pip install snowflake-ml-python # this is excluded in dev requirements
+
+python3 tools/exp_tests_tool.py --update-coverage-in-compatibility --tests <your_test_name>
+```
+
+This section is a source for the coverage and compatibility tracking sheet, which can be generated using the following command:
+```bash
+ python3 tools/exp_tests_tool.py --compatibility-report > compatibility.csv
+```
+
+## Manage Test Env With Tox
+
+Our test environment setup is defined in `tox.ini`. GitHub Action uses tox to run the merge gates.
+To run it locally:
+
+```commandline
+tox
+```
+
+## Generating Protobuf Files
+
+To generate the protobuf files, run the following command from the project root directory:
+
+```bash
+./generate_proto.sh
+```
+
+This will create `.py` and `.pyi` files in the `snowflake_connect_server/proto` directory.
+
+## Scala Examples
+
+To run the Scala examples in `examples/`, run the following:
+
+```bash
+brew install Virtuslab/scala-cli/scala-cli
+```
+
+Then run any of the `*.sc` scripts.

snowpark_connect-0.20.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+