Skip to content

Commit 4a138a4

Browse files
sfc-gh-cgorriesfc-gh-cgorrie
committed
Initial version of native-apps-examples
0 parents  commit 4a138a4

File tree

161 files changed

+16258
-0
lines changed

Some content is hidden

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

161 files changed

+16258
-0
lines changed

‎.github/repo_meta.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
point_of_contact: snowflakedb/nade
2+
production: false

‎.gitignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.venv
2+
.env
3+
__pycache__
4+
package_modules
5+
node_modules
6+
Makefile
7+
na_spcs_python/na_spcs_python/v1/frontend.yaml
8+
na_spcs_python/na_spcs_python/v1/backend.yaml

‎LICENSE.txt‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
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.

‎README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Snowflake Native App Examples
2+
3+
**Note**: Snowflake CLI is in Public Preview (PuPr). You can find the official documentation and download links [here](https://docs.snowflake.com/en/developer-guide/snowflake-cli-v2/index).
4+
5+
This repository contains example applications built using the [Snowflake Native App](https://docs.snowflake.com/en/developer-guide/native-apps/native-apps-about) Framework. These examples have been built and are supported by Snowflake Inc., are self-contained, and can be deployed directly to your account using Snowflake CLI.
6+
7+
## Deploying example applications
8+
9+
Deploying and exploring any of the example applications available in this repository is simple. Generally speaking, the process is:
10+
11+
1. Ensure Snowflake CLI is installed and up-to-date
12+
2. Clone this repository
13+
3. Change to the example application directory of your choosing
14+
4. Execute `snow app run` from your command line to deploy the app using your default connection
15+
16+
Some applications require other account-level setup before they can be properly deployed; see the individual application directories for more detailed instructions. To manage your Snowflake CLI connections, see the [Snowflake CLI documentation](https://docs.snowflake.com/en/developer-guide/snowflake-cli-v2/connecting/connect).
17+
18+
## Available examples
19+
20+
| Application | Description |
21+
| --- | --- |
22+
| [Account Privileges](./account-privileges/) | How to add account privileges to an object reference within a native application. |
23+
| [Custom Billing Events](./custom-billing-events/) | How to bill costs from the provider side by adding a billing event to a procedure call. |
24+
| [Data Mapping](./data-mapping/) | Accompaniment to the [Data Mapping in Snowflake Native Apps using Streamlit](https://quickstarts.snowflake.com/guide/data_mapping_in_native_apps/index.html?index=..%2F..index#0) quickstart. |
25+
| [External Access Integration](./external-access-integration/) | How to create an external access integration and connect to an API within a native application. |
26+
| [Mailorder](./mailorder/) | How to implement the business operations of an imaginary mail-order business within a native application using Snowpark. |
27+
| [Object-level References](./object-level-references/) | A simple dashboard to show how to interact with the object-level references and bindings. |
28+
| [Reference Usage](./reference-usage/) | How to share a provider table with a native application whose data is replicated to any consumer in the data cloud. |
29+
| [SPCS Three-tier](./spcs-three-tier/) | A simple three-tiered web app that can be deployed in Snowpark Container Services. It queries the TPC-H 100 data set and returns the top sales clerks. |
30+
| [Tasks and Streams](./tasks-streams/) | How to execute a task and visualize changes using streams within a native application. |
31+
32+
## Contributing
33+
34+
Contributions are welcome and encouraged under the [Apache 2.0 License](./LICENSE.txt). Please feel free to open issues or pull requests.

‎account-privileges/.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
snowflake.local.yml
2+
output/
3+
**/__pycache__/
4+
**/.pytest_cache/

‎account-privileges/README.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Account Privileges
2+
3+
This Snowflake Native Application sample demonstrates how to add account privileges to an object reference within a native application.
4+
5+
## Getting Started
6+
7+
### Prepare objects in account
8+
9+
Before start, ensure there is an existing warehouse used in the current connection. You can use the following command to create a new warehouse:
10+
11+
```sql
12+
CREATE WAREHOUSE IF NOT EXISTS consumer_warehouse;
13+
```
14+
15+
Execute the [references.sql](prepare/references.sql) file as the `ACCOUNTADMIN` role. This script sets up the table, view, function and procedure that will be binded inside the application:
16+
17+
```bash
18+
snow sql -f 'prepare/references.sql'
19+
```
20+
21+
### Installation
22+
23+
Execute the following command:
24+
25+
```bash
26+
snow app run
27+
```
28+
29+
> [!CAUTION]
30+
> Note that objects with references are being created within stored procedures in [setup_script.sql](app/setup_script.sql), rather than inside user-defined functions. Because UDFs are resolved at build-time, we cannot create a UDF that uses a reference until that reference is bound.
31+
32+
### First-time setup
33+
34+
The first time you run the app (e.g. `snow app open`), you will be prompted to bind some references and add privileges before proceeding to the application's main functionality:
35+
36+
- *table_reference*: `consumer_database.consumer_schema.table_reference`.
37+
38+
- *view_reference*: You must choose `consumer_database.consumer_schema.view_reference`.
39+
40+
- *procedure_reference*: You must choose `consumer_database.consumer_schema.procedure_reference`.
41+
42+
- *function_reference*: You must choose `consumer_database.consumer_schema.function_reference`.
43+
44+
> These references and privileges are defined in [manifest.yml](app/manifest.yml).
45+
46+
Once references are set, the UI will let you proceed to the main application.
47+
48+
### Test the app
49+
50+
When you are inside the app, you will see three different buttons:
51+
52+
- *Call Udf reference*: Calls the user defined function you bound previously.
53+
54+
- *Call Procedure reference*: Calls the stored procedure previously binded in the setup.
55+
56+
- *Insert rows*: Insert a new row into the table previously binded in the setup. The dataframe is populated with the binded view.
57+
58+
### Additional Resources
59+
60+
- [Request references and object-level privileges from consumers](https://docs.snowflake.com/en/developer-guide/native-apps/requesting-refs)
61+
- [Create a user interface to request privileges and references](https://docs.snowflake.com/en/developer-guide/native-apps/requesting-ui)
62+
- [Access control privileges](https://docs.snowflake.com/en/user-guide/security-access-control-privileges)

‎account-privileges/app/manifest.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# For more information on creating manifest, go to https://docs.snowflake.com/en/developer-guide/native-apps/creating-manifest
2+
manifest_version: 1
3+
4+
version:
5+
name: Dev
6+
label: "Dev Version"
7+
comment: "Default version used for development. Override for actual deployment."
8+
9+
artifacts:
10+
setup_script: setup_script.sql
11+
default_streamlit: core.ui
12+
extension_code: true
13+
14+
references:
15+
- table_reference:
16+
label: "Table Reference"
17+
description: "A table in the consumer account that exists outside the APPLICATION object."
18+
privileges:
19+
- INSERT
20+
object_type: TABLE
21+
multi_valued: false
22+
register_callback: config.register_single_reference
23+
24+
- view_reference:
25+
label: "View Reference"
26+
description: "A view in the consumer account that exists outside the APPLICATION object."
27+
privileges:
28+
- SELECT
29+
object_type: VIEW
30+
multi_valued: false
31+
register_callback: config.register_single_reference
32+
33+
- procedure_reference:
34+
label: "Procedure Reference"
35+
description: "A procedure in the consumer account that exists outside the APPLICATION object."
36+
privileges:
37+
- USAGE
38+
object_type: PROCEDURE
39+
multi_valued: false
40+
register_callback: config.register_single_reference
41+
42+
- function_reference:
43+
label: "Function Reference"
44+
description: "A function in the consumer account that exists outside the APPLICATION object."
45+
privileges:
46+
- USAGE
47+
object_type: FUNCTION
48+
multi_valued: false
49+
register_callback: config.register_single_reference

0 commit comments

Comments
 (0)