{"id":30266843,"url":"https://github.com/stackql/stackql-provider-snowflake","last_synced_at":"2025-08-15T23:26:07.697Z","repository":{"id":308974076,"uuid":"1034293923","full_name":"stackql/stackql-provider-snowflake","owner":"stackql","description":"StackQL provider for Snowflake","archived":false,"fork":false,"pushed_at":"2025-08-09T02:15:13.000Z","size":770,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-09T02:32:23.558Z","etag":null,"topics":["snowflake","stackql","stackql-provider"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stackql.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-08T06:51:21.000Z","updated_at":"2025-08-09T00:23:03.000Z","dependencies_parsed_at":"2025-08-09T02:32:29.819Z","dependency_job_id":"e7c29d08-e7c1-4593-8175-26e1933716f5","html_url":"https://github.com/stackql/stackql-provider-snowflake","commit_stats":null,"previous_names":["stackql/stackql-provider-snowflake"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/stackql/stackql-provider-snowflake","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-provider-snowflake","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-provider-snowflake/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-provider-snowflake/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-provider-snowflake/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackql","download_url":"https://codeload.github.com/stackql/stackql-provider-snowflake/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-provider-snowflake/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270644764,"owners_count":24621332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["snowflake","stackql","stackql-provider"],"created_at":"2025-08-15T23:25:57.786Z","updated_at":"2025-08-15T23:26:07.670Z","avatar_url":"https://github.com/stackql.png","language":"Python","readme":"## Snowflake provider for [`stackql`](https://github.com/stackql/stackql)\r\n\r\n### Prerequisities\r\n\r\na. Download `stackql` locally (see [downloads](https://stackql.io/install)).  \r\nb. Create a least priveleged role for your `stackql` service account.\r\nc. Create a [Snowflake PAT](https://docs.snowflake.com/developer-guide/snowflake-rest-api/authentication#using-a-programmatic-access-token-pat) for the role created in (b).  \r\nd. Export the following environment variable: \r\n\r\n```bash\r\nexport SNOWFLAKE_PAT=abcd...\r\n```\r\n\r\n### 1. Download REST API specs for Snowflake and unzip to the `provider-dev/source` directory\r\n\r\n```bash\r\nrm -rf ./provider-dev/source/*\r\nwget https://github.com/snowflakedb/snowflake-rest-api-specs/archive/refs/heads/main.zip\r\nmkdir -p provider-dev/source\r\nunzip main.zip -d provider-dev/source\r\nrm main.zip\r\n```\r\n\r\n### 2. (Optional) Generate a mapping template using the `analyze` command\r\n\r\n\u003e not required if you have done this already\r\n\r\nGenerate a operation mapping template using the following code:\r\n\r\n```bash\r\nbash ./bin/openapi-to-stackql.sh analyze \\\r\n--input provider-dev/source/snowflake-rest-api-specs-main/specifications \\\r\n--output provider-dev/config\r\n```\r\n\r\nupdate the resultant `provider-dev/config/all_services.csv` to add the `stackql_resource_name`, `stackql_method_name`, `stackql_verb` values for each operation, save the file as `provider-dev/config/snowflake.csv`\r\n\r\n### 3. Pre process the specs\r\n\r\nThe `common.yaml` contains schemas to be injected into all other service specs, use the following code to do this...\r\n\r\n```bash\r\nbash ./provider-dev/scripts/pre_process.sh provider-dev/source/snowflake-rest-api-specs-main/specifications\r\n```\r\n\r\n### 4. Generate the provider\r\n\r\nRun the following code to generate the `snowflake` stackql provider:\r\n\r\n```bash\r\nbash ./bin/openapi-to-stackql.sh convert \\\r\n--input provider-dev/source/snowflake-rest-api-specs-main/specifications \\\r\n--output provider-dev/src/snowflake \\\r\n--config provider-dev/config/snowflake.csv \\\r\n--provider snowflake \\\r\n--servers '[{\"url\":\"https://{endpoint}.snowflakecomputing.com\",\"description\":\"Multi-tenant Snowflake endpoint\",\"variables\":{\"endpoint\":{\"default\":\"orgid-acctid\",\"description\":\"Organization and Account Name\"}}}]' \\\r\n--provider-config '{\"auth\":{\"type\":\"bearer\",\"credentialsenvvar\":\"SNOWFLAKE_PAT\" }}' \\\r\n--skip common.yaml\r\n```\r\n\r\n### 5. Post process the specs\r\nPost process the specs to remove redundant reference paths:\r\n\r\n```bash\r\npython3 ./provider-dev/scripts/post_process.py provider-dev/src/snowflake/v00.00.00000/services\r\n```\r\n\r\n### 6. Test the provider locally\r\n\r\nDownload `stackql`: \r\n\r\n```bash\r\ncurl -L https://bit.ly/stackql-zip -O \\\r\n\u0026\u0026 unzip stackql-zip\r\n```\r\n\r\nTest the provider locally:\r\n\r\n```bash\r\nPROVIDER_REGISTRY_ROOT_DIR=\"$(pwd)\"\r\nREG_STR='{\"url\": \"file://'${PROVIDER_REGISTRY_ROOT_DIR}/provider-dev'\", \"localDocRoot\": \"'${PROVIDER_REGISTRY_ROOT_DIR}/provider-dev'\", \"verifyConfig\": {\"nopVerify\": true}}'\r\n./stackql shell --registry=\"${REG_STR}\"\r\n```\r\n\r\n```sql\r\nselect name, owner from snowflake.database.databases where endpoint = 'OKXVNMC-VH34026';\r\n\r\nSELECT name, bytes, data_retention_time_in_days, table_type FROM snowflake.table.tables WHERE database_name = 'SNOWFLAKE_SAMPLE_DATA' AND schema_name = 'TPCH_SF10' AND endpoint = 'OKXVNMC-VH34026' order by bytes DESC;\r\n```\r\n\r\n### 5. Publish the provider\r\n\r\nTo publish the provider push the `snowflake` dir to `providers/src` in a feature branch of the [`stackql-provider-registry`](https://github.com/stackql/stackql-provider-registry).  Follow the [registry release flow](https://github.com/stackql/stackql-provider-registry/blob/dev/docs/build-and-deployment.md).\r\n\r\n### 6. Test the provider in the `dev` registry\r\n\r\nLaunch the StackQL shell:\r\n\r\n```bash\r\nexport DEV_REG=\"{ \\\"url\\\": \\\"https://registry-dev.stackql.app/providers\\\" }\"\r\n./stackql --registry=\"${DEV_REG}\" shell\r\n```\r\n\r\npull the latest dev `snowflake` provider:\r\n\r\n```sql\r\nregistry pull snowflake;\r\n```\r\n\r\nRun some test queries\r\n\r\n### 7. Generate web docs\r\n\r\n```bash\r\nrm -rf ./website/docs/*\r\nnpm i\r\nnpm run generate-docs -- \\\r\n  --provider-name snowflake \\\r\n  --provider-dir ./provider-dev/src/snowflake/v00.00.00000 \\\r\n  --output-dir ./website \\\r\n  --provider-data-dir ./provider-dev/docgen/provider-data\r\n```  \r\n\r\n### 8. Test web docs locally\r\n\r\n```bash\r\ncd website\r\nyarn start\r\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Fstackql-provider-snowflake","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackql%2Fstackql-provider-snowflake","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Fstackql-provider-snowflake/lists"}