Skip to content

Commit 30dc7df

Browse files
authored
cherrypicking snowflake docs (#6)
* remove all preview notices * finish cherrypicking * swap a lot of stuff * get few more things done * add changelog
1 parent 65af259 commit 30dc7df

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1029
-213
lines changed

astro.config.mjs

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,9 +296,9 @@ export default defineConfig({
296296
collapsed: true,
297297
},
298298
{
299-
label: 'Services',
299+
label: 'Features',
300300
collapsed: true,
301-
autogenerate: { directory: '/snowflake/services' },
301+
autogenerate: { directory: '/snowflake/features' },
302302
},
303303
{
304304
label: 'Capabilities',
@@ -324,6 +324,14 @@ export default defineConfig({
324324
label: 'SQL Functions',
325325
slug: 'snowflake/sql-functions',
326326
},
327+
{
328+
label: 'Feature Coverage',
329+
slug: 'snowflake/coverage-features',
330+
},
331+
{
332+
label: 'Changelog',
333+
slug: 'snowflake/changelog',
334+
},
327335
],
328336
},
329337
],
138 KB
Loading

src/content/docs/snowflake/capabilities/config.md renamed to src/content/docs/snowflake/capabilities/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ label:
77
---
88

99

10-
{{< preview-notice >}}
10+
1111

1212
LocalStack exposes various configuration options to control its behaviour.
1313

src/content/docs/snowflake/capabilities/ephemeral-instances.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

src/content/docs/snowflake/capabilities/index.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

src/content/docs/snowflake/capabilities/init-hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Initialization Hooks
33
description: Writing SQL scripts to initialize your Snowflake emulator
44
---
55

6-
{{< preview-notice >}}
6+
77

88
## Introduction
99

src/content/docs/snowflake/capabilities/state-management.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,14 @@ title: State Management
33
description: Get started with State Management in LocalStack for Snowflake
44
---
55

6-
{{< preview-notice >}}
6+
77

88
## Introduction
99

1010
State Management in LocalStack allows you to save and load the state of your LocalStack instance. LocalStack is ephemeral in nature, so when you stop and restart your LocalStack instance, all the data is lost. With State Management, you can save the state of your LocalStack instance and load it back when you restart your LocalStack instance.
1111

1212
State Management in LocalStack encompasses the following features:
1313

14-
- **Cloud Pods**: Cloud Pods are persistent state snapshots of your LocalStack instance that can easily be shared, stored, versioned, and restored.
1514
- **Export & Import State**: Export and import the state of your LocalStack instance on your local machine as a local file.
1615
- **Persistence**: Persist the state of your LocalStack instance on your local machine using a configuration variable.
1716

@@ -75,30 +74,3 @@ $ localstack state import '<file-name>'
7574
{{< /command >}}
7675

7776
The `<file-name>` argument is required and specifies the file path to import the state from. The file should be generated from a previous export.
78-
79-
## Cloud Pods
80-
81-
Cloud pods are persistent state snapshots of your LocalStack instance that can easily be stored, versioned, shared, and restored. Cloud Pods can be used for various purposes, such as:
82-
83-
- Save and manage snapshots of active LocalStack instances.
84-
- Share state snapshots with your team to debug collectively.
85-
- Automate your testing pipelines by pre-seeding CI environments.
86-
- Create reproducible development and testing environments locally.
87-
88-
You can save and load the persistent state of Cloud Pods, using the Cloud Pods CLI. LocalStack provides a remote storage backend that can be used to store the state of your running application and share it with your team members. Cloud Pods CLI is included in the [LocalStack CLI installation](https://docs.localstack.cloud/getting-started/installation/#localstack-cli), so there's no need for additional installations to begin using it.
89-
90-
### Create a new Cloud Pod
91-
92-
To create the Cloud Pod, you can run the following command:
93-
94-
{{< command >}}
95-
$ localstack pod save '<pod-name>'
96-
{{< /command >}}
97-
98-
### Load an existing Cloud Pod
99-
100-
To load the Cloud Pod, you can run the following command:
101-
102-
{{< command >}}
103-
$ localstack pod load '<pod-name>'
104-
{{< /command >}}

src/content/docs/snowflake/changelog.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,51 @@
22
title: Changelog
33
description: Changelog for the latest releases of the LocalStack for Snowflake.
44
template: doc
5-
nav:
6-
label:
75
---
86

9-
{{< preview-notice >}}
7+
### 1.0.0
8+
- Add support for `SHOW/ALTER FUNCTION`
9+
- Fix incompatibilities with GO driver and SnowSQL client
10+
- Add support for `SHOW INDEXES`
11+
- Improve timestamp string support in `TO_TIMESTAMP`
12+
- Fix casting values to array
13+
- Cast `MERGE INTO/UPDATE` commands arguments to target type
14+
- Make `TO_BOOLEAN` work with all boolean strings
15+
- Enhance parity for parsing URLs with whitespaces in `PUT` commands
16+
- Enhance and add support for metadata columns in parquet format
17+
- Enhance CRUD support for external volumes
18+
- Add support for `EXECUTE TASK`
19+
- Fix identifier parsing in stages and file formats
20+
- Enhance `SHOW TABLES` feature parity
21+
- Handle `DATE` and `TIME` functions
22+
- Add initial Iceberg support
23+
- Enhance parity for GRANT statements and DB permissions
24+
- Add initial support for password-less auth using RSA key
25+
- Enhance parity for queries over staged JSON files
26+
- Add initial support for Catalog Integrations
27+
- Support prepared statements in ODBC driver
28+
- Enhance decimals parity
29+
- Add initial support for granting `APPLICATION ROLE`
30+
- Enhance parity for SQL procedures with SF-native statements
31+
- Add support for lateral column references on `SELECT`
32+
- Fix `SHOW TABLE` with schema scope for Flyway
33+
- Decode field delimiters passed as hex or octal values
34+
- Remove modifiers from binary columns
35+
- Fix permissions to clone default database
36+
- Add support for numeric paramstyle
37+
- Enhance support for `CASE` expressions in `BEGIN..END` blocks
38+
- Refreshed UI
39+
- Enhance parity for `DESCRIBE DATABASE` queries
40+
- Enable local deployment of Streamlit Native Apps
41+
- Enhance parity for materialized view queries
42+
- Enhance parity for `SHOW DYNAMIC TABLES`
43+
- Fix handling of `IF EXISTS` statements within transactions
44+
- Enhance support for `BEGIN` code blocks with multiple command statements
45+
- Enhance logic for native apps and permission grants
46+
- Enhance parity for Native Apps that contain streamlit apps
47+
- Add auto-conversion of strings to `ARRAY/OBJECT` types
48+
- Add support for Polaris catalog
49+
1050

1151
### 0.3.0
1252
- Add support for multi-account setups
@@ -297,4 +337,4 @@ label:
297337
- Add `snowpipe`/streaming APIs
298338

299339
### 0.1.0
300-
- Initial release of the extension
340+
- Initial release of the extension
Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
---
2+
title: "Feature Coverage"
3+
description: Overview of the implemented Snowflake features in LocalStack
4+
template: doc
5+
---
6+
7+
## Resource Types and Operations
8+
9+
This page provides a list of Snowflake query features (resource types and operations) that are supported in the LocalStack emulator.
10+
The content will be updated as additional query features and functions are implemented.
11+
12+
### Applications
13+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
14+
|----|----|----|----|----|----|
15+
|**APPLICATION**||||||
16+
17+
### Application Packages
18+
| |ALTER|CREATE|DROP|SHOW|
19+
|----|----|----|----|----|
20+
|**APPLICATION PACKAGE**|||||
21+
22+
### Catalog Integration
23+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
24+
|----|----|----|----|----|----|
25+
|**CATALOG INTEGRATION**||||||
26+
27+
### Databases
28+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|UNDROP|USE|
29+
|----|----|----|----|----|----|----|----|
30+
|**DATABASE**||||||||
31+
32+
### Dynamic Tables
33+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|UNDROP|
34+
|----|----|----|----|----|----|----|
35+
|**DYNAMIC TABLE**|||||||
36+
37+
### External Tables
38+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
39+
|----|----|----|----|----|----|
40+
|**EXTERNAL TABLE**||||||
41+
42+
### External Volumes
43+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|UNDROP|
44+
|----|----|----|----|----|----|----|
45+
|**EXTERNAL VOLUME**|||||||
46+
47+
### File Formats
48+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
49+
|----|----|----|----|----|----|
50+
|**FILE FORMAT**||||||
51+
52+
### Functions
53+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
54+
|----|----|----|----|----|----|
55+
|**FUNCTION**||||||
56+
57+
### Hybrid Tables
58+
| |CREATE|SHOW|
59+
|----|----|----|
60+
|**HYBRID TABLE**|||
61+
62+
### Iceberg Tables
63+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|UNDROP|
64+
|----|----|----|----|----|----|----|
65+
|**ICEBERG TABLE**|||||||
66+
67+
### Indexes
68+
| |CREATE|DROP|SHOW|
69+
|----|----|----|----|
70+
|**INDEX**||||
71+
72+
### Materialized Views
73+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|TRUNCATE|
74+
|----|----|----|----|----|----|----|
75+
|**MATERIALIZED VIEW**|||||||
76+
77+
### Pipes
78+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
79+
|----|----|----|----|----|----|
80+
|**PIPE**||||||
81+
82+
### Procedures
83+
| |ALTER|CALL|CALL WITH|CREATE|DESCRIBE|DROP|SHOW|
84+
|----|----|----|----|----|----|----|----|
85+
|**PROCEDURE**||||||||
86+
87+
### Roles
88+
| |ALTER|CREATE|DROP|GRANT|REVOKE|SHOW|USE|
89+
|----|----|----|----|----|----|----|----|
90+
|**ROLE**||||||||
91+
92+
### Row Access Policies
93+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
94+
|----|----|----|----|----|----|
95+
|**ROW ACCESS POLICY**||||||
96+
97+
### Schemas
98+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|UNDROP|USE|
99+
|----|----|----|----|----|----|----|----|
100+
|**SCHEMA**||||||||
101+
102+
### Sequences
103+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
104+
|----|----|----|----|----|----|
105+
|**SEQUENCE**||||||
106+
107+
### Shares
108+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
109+
|----|----|----|----|----|----|
110+
|**SHARE**||||||
111+
112+
### Stages
113+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
114+
|----|----|----|----|----|----|
115+
|**STAGE**||||||
116+
117+
### Storage Integrations
118+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
119+
|----|----|----|----|----|----|
120+
|**STORAGE INTEGRATION**||||||
121+
122+
### Streams
123+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
124+
|----|----|----|----|----|----|
125+
|**STREAM**||||||
126+
127+
### Streamlits
128+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
129+
|----|----|----|----|----|----|
130+
|**STREAMLIT**||||||
131+
132+
### Tables
133+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|TRUNCATE|UNDROP|
134+
|----|----|----|----|----|----|----|----|
135+
|**TABLE**||||||||
136+
137+
### Tags
138+
| |ALTER|CREATE|DROP|SHOW|UNDROP|
139+
|----|----|----|----|----|----|
140+
|**TAG**||||||
141+
142+
### Tasks
143+
| |ALTER|CREATE|DESCRIBE|DROP|EXECUTE|SHOW|
144+
|----|----|----|----|----|----|----|
145+
|**TASK**|||||||
146+
147+
### Users
148+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
149+
|----|----|----|----|----|----|
150+
|**USER**||||||
151+
152+
### Views
153+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|
154+
|----|----|----|----|----|----|
155+
|**VIEW**||||||
156+
157+
### Warehouses
158+
| |ALTER|CREATE|DESCRIBE|DROP|SHOW|USE|
159+
|----|----|----|----|----|----|----|
160+
|**WAREHOUSE**|||||||
File renamed without changes.

0 commit comments

Comments
 (0)