Skip to content

[DOCS] updates to the snowflake tutorial: more examples + explicitly specify the DB schema - #1962

Merged
jiayuasu merged 2 commits into
apache:masterfrom
cgauvi:fix-snowflake-tutorial-docs
May 28, 2025
Merged

jiayuasu merged 2 commits into
apache:masterfrom
cgauvi:fix-snowflake-tutorial-docs

Conversation

@cgauvi

@cgauvi cgauvi commented May 27, 2025 •

Copy link
Copy Markdown
Contributor

Summary

I tried to make the tutorial easier to run and avoid getting tripped over by functions that are implemented in both Sedona and native Snowflake.

Happy to tweak or remove examples if you think they don't add value, but I thought they helped understand what Sedona brings in terms of additional geo capabilities.

Closes #1954

Did you read the Contributor Guide?

Is this PR related to a ticket?

  • No:
    • this is a documentation update. The PR name follows the format [DOCS] my subject

What changes were proposed in this PR?

  • Made sure all functions can be called in snowflake
    • added SEDONA prefix to sedona functions - essential when the corresponding snowflake function also exists (e.g. st_intersects)
    • created additional illustrative tables & added commands like USE DATABASE SEDONASNOW; to ensure the code runs on snowflake.

How was this patch tested?

  • Ran examples in snowflake

  • Ran locally:

    • pip install -r requirements-docs.txt
    • mkdocs build
    • mkdocs serve
    • successfully ran pre-commit run --all-files

Did this PR include necessary documentation updates?

  • Yes, I have updated the documentation.

@cgauvi
cgauvi requested a review from jiayuasu as a code owner May 27, 2025 18:55
@github-actions github-actions Bot added the docs label May 27, 2025
…sedona function calls (use SEDONA prefix to differentiate from native snowflake functions
@cgauvi
cgauvi force-pushed the fix-snowflake-tutorial-docs branch from cf4bf85 to 4e4751b Compare May 27, 2025 18:59
@jiayuasu

Copy link
Copy Markdown
Member

@cgauvi great work. Please run pre-commit run --all-files in your terminal and then commit the fixes. This will fix the failed lint CI.

@cgauvi cgauvi changed the title [DOCS] updates to the snowflake tutorial: more examples + explicitely specify the DB schema [DOCS] updates to the snowflake tutorial: more examples + explicitly specify the DB schema May 28, 2025
@jiayuasu
jiayuasu merged commit a1d2103 into apache:master May 28, 2025
jiayuasu pushed a commit that referenced this pull request May 29, 2025
…specify the DB schema (#1962)

* [DOCS]: updates to the snowflake tutorial - more examples + fixes to sedona function calls (use SEDONA prefix to differentiate from native snowflake functions

* [DOCS] linted md + applied pre-commit run --all-files
Kontinuation pushed a commit to Kontinuation/sedona that referenced this pull request Jan 21, 2026
…specify the DB schema (apache#1962)

* [DOCS]: updates to the snowflake tutorial - more examples + fixes to sedona function calls (use SEDONA prefix to differentiate from native snowflake functions

* [DOCS] linted md + applied pre-commit run --all-files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Potential typo in SedonaSnow tutorial

2 participants