Skip to content

docs: Snowflake REST API support #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 29, 2025

Conversation

quetzalliwrites
Copy link
Collaborator

LocalStack for Snowflake supports REST API Database endpoints that let you manage your Snowflake databases locally.

You can create a database, list your databases, or fetch a specific one.

@quetzalliwrites quetzalliwrites self-assigned this Jul 28, 2025
Copy link

cloudflare-workers-and-pages bot commented Jul 28, 2025

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 160c3bb
Status: ✅  Deploy successful!
Preview URL: https://ab333a08.localstack-docs.pages.dev
Branch Preview URL: https://docs-snow-rest-api-endpoints.localstack-docs.pages.dev

View logs

@quetzalliwrites quetzalliwrites added documentation Improvements or additions to documentation snow release-bound labels Jul 28, 2025
Comment on lines 13 to 15
## Supported Snowflake REST Database API endpoints

LocalStack for Snowflake supports the following REST API endpoints to manage your Snowflake databases locally:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to the above, keep this generic and handle distinctions per object type only in the table.

@quetzalliwrites quetzalliwrites changed the title docs: Snowflake REST Database API support docs: Snowflake REST API support Jul 29, 2025
@quetzalliwrites quetzalliwrites merged commit 92e286f into master Jul 29, 2025
1 check passed
@quetzalliwrites quetzalliwrites deleted the docs-snow-rest-api-endpoints-support branch July 29, 2025 11:14
Copy link
Contributor

@gentris gentris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a few suggestions to make the use of the terminology a little more precise, and also help improve the structure a bit so that it's more future proof when we add implementations for the other APIs.

|---------------------------------------------------|---------------------------------------------|
| `POST /api/v2/databases` | Creates a database. |
| `GET /api/v2/databases` | Lists accessible databases. |
| `GET /api/v2/databases/<name>` | Fetch a specific database. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `GET /api/v2/databases/<name>` | Fetch a specific database. |
| `GET /api/v2/databases/<name>` | Fetches a specific database. |

@@ -0,0 +1,22 @@
---
title: REST API
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: REST API
title: REST APIs


LocalStack for Snowflake supports REST API endpoints that let you manage your Snowflake data locally.

## Supported Snowflake REST API endpoints
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Supported Snowflake REST API endpoints
## Supported Snowflake REST APIs


## Introduction

The [Snowflake REST API](https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/snowflake-rest-api) provides REST API endpoints that allow you to manage schemas and tables in Snowflake. Snowflake REST APIs let you use the programming language of your choice to build your integrations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The [Snowflake REST API](https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/snowflake-rest-api) provides REST API endpoints that allow you to manage schemas and tables in Snowflake. Snowflake REST APIs let you use the programming language of your choice to build your integrations.
The [Snowflake REST APIs](https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/snowflake-rest-api) provide endpoints that allow you to manage schemas, tables, and other objects in Snowflake. These APIs enable you to integrate with Snowflake using the programming language of your choice and the known convenience of a [RESTful](https://en.wikipedia.org/wiki/REST) interface.


The [Snowflake REST API](https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/snowflake-rest-api) provides REST API endpoints that allow you to manage schemas and tables in Snowflake. Snowflake REST APIs let you use the programming language of your choice to build your integrations.

LocalStack for Snowflake supports REST API endpoints that let you manage your Snowflake data locally.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
LocalStack for Snowflake supports REST API endpoints that let you manage your Snowflake data locally.
LocalStack for Snowflake supports REST APIs that let you manage your Snowflake data locally.


## Supported Snowflake REST API endpoints

LocalStack for Snowflake supports the following REST API endpoints to manage your Snowflake data locally:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
LocalStack for Snowflake supports the following REST API endpoints to manage your Snowflake data locally:
LocalStack for Snowflake supports the following REST APIs to manage your Snowflake data locally:

## Supported Snowflake REST API endpoints

LocalStack for Snowflake supports the following REST API endpoints to manage your Snowflake data locally:

Copy link
Contributor

@gentris gentris Jul 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I think we should add a heading with title: Database API and then below this the supported endpoints of Database API will be listed.

LocalStack for Snowflake supports the following REST API endpoints to manage your Snowflake data locally:


| Supported Endpoint | Description |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Supported Endpoint | Description |
|Endpoint | Description |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation release-bound snow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants