├── .dockerignore ├── .github └── workflows │ └── sanity.yml ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── action.yml ├── main.py ├── requirements.txt ├── snowflake_connector.py └── utils.py /.dockerignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | # visual studio code 132 | .vscode -------------------------------------------------------------------------------- /.github/workflows/sanity.yml: -------------------------------------------------------------------------------- 1 | name: Sanity Tests 2 | on: push 3 | 4 | jobs: 5 | test_multiple_queries: 6 | runs-on: ubuntu-latest 7 | name: Test Function Multiple Queries 8 | steps: 9 | # Run Queries 10 | - name: Checkout Repository 11 | uses: actions/checkout@v2 12 | - name: Run Queries 13 | uses: ./ 14 | id: run_queries 15 | with: 16 | snowflake_account: ${{ secrets.SNOWFLAKE_ACCOUNT }} 17 | snowflake_warehouse: ${{ secrets.SNOWFLAKE_WAREHOUSE }} 18 | snowflake_username: ${{ secrets.SNOWFLAKE_USERNAME }} 19 | snowflake_password: ${{ secrets.SNOWFLAKE_PASSWORD }} 20 | queries: 'call system$wait(1); 21 | select CURRENT_VERSION(); 22 | select CURRENT_CLIENT()' 23 | 24 | # Validations 25 | - name: Query Client validation 26 | run: | 27 | ${{contains(steps.run_queries.outputs.queries_results, 'PythonConnector')}} 28 | - name: Waiting Query Validation 29 | run: | 30 | ${{contains(steps.run_queries.outputs.queries_results, 'waited 1 seconds')}} 31 | 32 | test_matrix_query: 33 | runs-on: ubuntu-latest 34 | name: Test Matrix Multiple Queries 35 | strategy: 36 | matrix: 37 | sleep: [1, 2, 3] 38 | steps: 39 | # Run Queries 40 | - name: Checkout Repository 41 | uses: actions/checkout@v2 42 | - name: Run Queries 43 | uses: ./ 44 | id: run_queries 45 | with: 46 | snowflake_account: ${{ secrets.SNOWFLAKE_ACCOUNT }} 47 | snowflake_warehouse: ${{ secrets.SNOWFLAKE_WAREHOUSE }} 48 | snowflake_username: ${{ secrets.SNOWFLAKE_USERNAME }} 49 | snowflake_password: ${{ secrets.SNOWFLAKE_PASSWORD }} 50 | queries: 'call system$wait(${{matrix.sleep}})' 51 | 52 | - name: Waiting Query Validation 53 | run: | 54 | ${{contains(steps.run_queries.outputs.queries_results, format('waited {0} seconds', matrix.sleep))}} 55 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | # visual studio code 132 | .vscode 133 | 134 | # PyCharm 135 | .idea -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.10-slim 2 | 3 | RUN apt-get update && \ 4 | apt-get install -y git && \ 5 | python3 -m pip install --upgrade pip 6 | 7 | # Configure environments vars. Overriden by GitHub Actions 8 | ENV INPUT_SNOWFLAKE_ACCOUNT= 9 | ENV INPUT_SNOWFLAKE_USERNAME= 10 | ENV INPUT_SNOWFLAKE_PASSWORD= 11 | ENV INPUT_SNOWFLAKE_WAREHOUSE= 12 | ENV INPUT_QUERIES= 13 | ENV APP_DIR=/app 14 | 15 | WORKDIR ${APP_DIR} 16 | 17 | # setup python environ 18 | COPY ./requirements.txt ${APP_DIR} 19 | RUN pip install -r ${APP_DIR}/requirements.txt 20 | 21 | # copy app files 22 | COPY . ./ 23 | RUN useradd -ms /bin/bash anecdotes 24 | RUN chown -R anecdotes:anecdotes /app 25 | USER anecdotes 26 | # command to run in container start 27 | CMD python ${APP_DIR}/main.py 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Snowflake-query 2 | 3 | ![last tag](https://img.shields.io/github/v/tag/anecdotes-ai/snowflake-query?color=brightgreen&label=release&logo=github) 4 | ![Sanity Workflow](https://github.com/anecdotes-ai/snowflake-query/actions/workflows/sanity.yml/badge.svg?branch=master) 5 | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) 6 | 7 | This github action runs SQL queries list in Snowflake DB, which its access configuration is defined in the workflow. 8 | 9 | ## Inputs 10 | 11 | - `snowflake_account` - Account name for Snowflake DB. Your account name is the full/entire string to the left of snowflakecomputing.com. 12 | - `snowflake_warehouse` - Set the warehouse context for the queries. 13 | - `snowflake_username`, `snowflake_password` - Credentials for your DB. 14 | - It's recommended to use [Github's Secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) for those arguments. 15 | - `snowflake_role` (optional) - Set a role for the user. 16 | - `queries` - SQL queries to execute **asynchronously and independently**. 17 | - May contain multiple queries, seperated by ';' 18 | - Don't use ';' with the last query. 19 | - If you need to contain a single-quote in one or more queries, escape it with another single-quote. 20 | 21 | ## Output 22 | 23 | `queries_results` - Json string contains the results from all queires executed. For example, for the query `SELECT CURRENT_VERSION()`, we'll get - `{'019ca1a1-0000-43ef-0000-15ed05cb1c4e': ['('5.20.1',)']}`. 24 | 25 | It may be accessed in following steps by `${{steps.run_queries.outputs.queries_output}}`. See [this](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#tojson) guide for more github's action expressions examples. 26 | 27 | ## Usage 28 | 29 | ### Run multiple queries in one job 30 | 31 | ```yaml 32 | steps: 33 | - name: Run queries 34 | uses: anecdotes-ai/snowflake-query@v1 35 | id: run_queries 36 | with: 37 | snowflake_account: ${{ secrets.SNOWFLAKE_ACCOUNT }} 38 | snowflake_warehouse: ${{ secrets.SNOWFLAKE_WAREHOUSE }} 39 | snowflake_username: ${{ secrets.SNOWFLAKE_USER }} 40 | snowflake_password: ${{ secrets.SNOWFLAKE_PASSWORD }} 41 | queries: 'call system$wait(5); 42 | select CURRENT_VERSION(); 43 | select * from "" where =''''' 44 | # single quote is escaped with another single quote 45 | 46 | - name: Version Query Validation 47 | run: | 48 | ${{contains(steps.run_queries.outputs.queries_output, '5.20.1')}} 49 | ``` 50 | 51 | ### Run multiple queries as a job-matrix 52 | 53 | ```yaml 54 | strategy: 55 | matrix: 56 | table: ['TABLE1', 'TABLE2', 'TABLE3', 57 | 'TABLE4', 'TABLE5'] 58 | steps: 59 | - name: Run Delete Queries 60 | uses: anecdotes-ai/snowflake-query@v1 61 | id: run_delete_queries 62 | with: 63 | snowflake_account: ${{ secrets.SNOWFLAKE_ACCOUNT }} 64 | snowflake_warehouse: ${{ secrets.SNOWFLAKE_WAREHOUSE }} 65 | snowflake_username: ${{ secrets.SNOWFLAKE_USER }} 66 | snowflake_password: ${{ secrets.SNOWFLAKE_PASSWORD }} 67 | queries: 'DELETE FROM "${{matrix.table}}"' 68 | ``` 69 | 70 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: 'Snowflake Query Action' 2 | author: 'anecdotes.ai' 3 | description: 'This action lets running a list of SQL queries on your Snowflake DB.' 4 | 5 | branding: 6 | icon: 'database' 7 | color: 'blue' 8 | 9 | inputs: 10 | snowflake_username: 11 | description: 'Username for Snowflake DB' 12 | required: true 13 | snowflake_password: 14 | description: 'Password for Snowflake DB' 15 | required: true 16 | snowflake_account: 17 | description: 'Account name for Snowflake DB. Your account name is the full/entire string to the left of snowflakecomputing.com.' 18 | required: true 19 | snowflake_warehouse: 20 | description: 'Warehouse as context' 21 | required: true 22 | snowflake_role: 23 | description: 'Set user role' 24 | required: false 25 | queries: 26 | description: 'List of SQL queries, seperated by ;' 27 | required: true 28 | sync: 29 | description: 'Whether to run the queries sync (default is async)' 30 | required: false 31 | 32 | outputs: 33 | queries_results: 34 | description: 'Json encoded as base64, containing all queries results' 35 | 36 | runs: 37 | using: 'docker' 38 | image: 'Dockerfile' -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import os 2 | import asyncio 3 | import json 4 | 5 | from dotenv import load_dotenv 6 | 7 | import utils 8 | from snowflake_connector import SnowflakeConnector 9 | 10 | def main(): 11 | load_dotenv() # only on local run 12 | print(os.environ) 13 | queries_list = os.environ['INPUT_QUERIES'].split(';') 14 | sync = os.environ.get("INPUT_SYNC", False) 15 | warehouse = os.environ['INPUT_SNOWFLAKE_WAREHOUSE'] 16 | snowflake_account = os.environ['INPUT_SNOWFLAKE_ACCOUNT'] 17 | snowflake_username = os.environ['INPUT_SNOWFLAKE_USERNAME'] 18 | snowflake_password = os.environ['INPUT_SNOWFLAKE_PASSWORD'] 19 | snowflake_role = os.environ.get('INPUT_SNOWFLAKE_ROLE', '') 20 | 21 | with SnowflakeConnector(snowflake_account, snowflake_username, snowflake_password) as con: 22 | try: 23 | if snowflake_role != '': 24 | con.set_user_role(snowflake_role) 25 | except: 26 | pass 27 | 28 | con.set_db_warehouse(warehouse) 29 | 30 | query_results = [] 31 | # default, run all queries async 32 | if not sync: 33 | for query in queries_list: 34 | query_result = con.query(query) 35 | query_results.append(query_result) 36 | print("### Running query ###") 37 | print(f"[!] Query id - {query_result.query_id}") 38 | print(f"[!] Running query ### - {query}") 39 | json_results = asyncio.run(utils.gather_all_results(query_results)) 40 | # o/w, run them sync 41 | else: 42 | json_results = {} 43 | for query in queries_list: 44 | query_result = con.query(query) 45 | print("### Running query ###") 46 | print(f"[!] Query id - {query_result.query_id}") 47 | print(f"[!] Running query ### - {query}") 48 | json_results[query_result.query_id] = query_result.fetch_results_sync() 49 | 50 | utils.set_github_action_output('queries_results', json.dumps(json_results)) 51 | 52 | 53 | if __name__ == '__main__': 54 | main() -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # Generated on: Python 3.8.3 2 | # With §ake-connector-python version: 2.3.4 3 | asn1crypto==1.5.1 4 | azure-common==1.1.28 5 | azure-core==1.29.4 6 | azure-storage-blob==12.18.3 7 | boto3==1.28.63 8 | botocore==1.31.63 9 | certifi==2024.7.4 10 | cffi==1.16.0 11 | chardet==5.2.0 12 | cryptography==41.0.4 13 | idna==3.4 14 | isodate==0.6.1 15 | jmespath==1.0.1 16 | msrest==0.7.1 17 | oauthlib==3.2.2 18 | oscrypto @ git+https://github.com/wbond/oscrypto.git@1547f53 19 | pycparser==2.21 20 | pycryptodomex==3.19.0 21 | PyJWT==2.8.0 22 | pyOpenSSL==23.2.0 23 | python-dateutil==2.8.2 24 | pytz==2023.3 25 | requests==2.28.0 26 | requests-oauthlib==1.3.0 27 | s3transfer==0.7.0 28 | six==1.16.0 29 | urllib3==1.26.13 30 | snowflake-connector-python==3.3.0 31 | python-dotenv==1.0.0 32 | -------------------------------------------------------------------------------- /snowflake_connector.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | 3 | import snowflake.connector 4 | 5 | from snowflake.connector.constants import QueryStatus 6 | 7 | class SnowflakeConnector: 8 | def __init__(self, account_name: str, username: str, password: str): 9 | self.account_name = account_name 10 | self.username = username 11 | self.password = password 12 | 13 | def __enter__(self): 14 | self.con = snowflake.connector.connect( 15 | user=self.username, 16 | password=self.password, 17 | account=self.account_name) 18 | 19 | return self 20 | 21 | def __exit__(self, *exc): 22 | self.con.close() 23 | 24 | def set_db_warehouse(self, warehouse: str): 25 | results = self.query(f'USE WAREHOUSE {warehouse}') 26 | return asyncio.run(results.fetch_results()) 27 | 28 | def set_user_role(self, role: str): 29 | results = self.query(f'USE ROLE {role}') 30 | return asyncio.run(results.fetch_results()) 31 | 32 | def query(self, query_str: str): 33 | cursor = self.con.cursor() 34 | cursor.execute_async(query_str) 35 | 36 | return QueryResult(self.con, cursor.sfqid) 37 | 38 | class QueryResult: 39 | def __init__(self, con: SnowflakeConnector, query_id: str): 40 | self.query_id = query_id 41 | self.con = con 42 | self.cursor = con.cursor() 43 | 44 | def is_query_done_successfully(self): 45 | return self.con.get_query_status(self.query_id) == QueryStatus.SUCCESS 46 | 47 | def is_query_running(self): 48 | return (self.con.get_query_status(self.query_id) == QueryStatus.RUNNING or 49 | self.con.get_query_status(self.query_id) == QueryStatus.NO_DATA) 50 | 51 | def _fetch_results(self): 52 | """ 53 | Raises ProgrammingError in case of SQL error, 54 | by get_results_from_sfqid 55 | """ 56 | self.cursor.get_results_from_sfqid(self.query_id) 57 | 58 | row = self.cursor.fetchone() 59 | while row is not None: 60 | yield row 61 | row = self.cursor.fetchone() 62 | 63 | async def fetch_results(self): 64 | while self.is_query_running(): 65 | await asyncio.sleep(0.1) 66 | 67 | return self._fetch_results() 68 | 69 | def fetch_results_sync(self): 70 | self.cursor.get_results_from_sfqid(self.query_id) 71 | return self.cursor.fetchall() 72 | -------------------------------------------------------------------------------- /utils.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | from os import system 3 | from typing import List 4 | 5 | from snowflake_connector import QueryResult 6 | 7 | 8 | def set_github_action_output(var_name, value): 9 | system(f'echo "::set-output name={{var_name}}::"{value}""') 10 | 11 | 12 | async def gather_all_results(query_result_list: List[QueryResult]) -> dict: 13 | """ 14 | Iterates all QueryResults objects to run asynchronously, 15 | and gather their results when finish. 16 | Print whenever results available. 17 | 18 | Args: 19 | query_result_list (List[QueryResult]): List of QueryResults objects. 20 | 21 | Returns: 22 | str: json contains all of the results. 23 | """ 24 | running_tasks = {asyncio.create_task(query_result.fetch_results(), name=query_result.query_id) 25 | for query_result in query_result_list} 26 | 27 | json_total_results = {} 28 | 29 | while len(running_tasks) != 0: 30 | done, running_tasks = await asyncio.wait(running_tasks, return_when=asyncio.FIRST_COMPLETED) 31 | 32 | for done_task in done: 33 | json_total_results[done_task.get_name()] = [] 34 | print(f'### Query id {done_task.get_name()} results ###') 35 | 36 | for row in done_task.result(): 37 | print(row) 38 | json_total_results[done_task.get_name()].append(str(row)) 39 | 40 | return json_total_results 41 | --------------------------------------------------------------------------------