wehub-resource-sync
e04ed9c211
CF: Deploy Dev Docs / deploy (push) Has been cancelled
Sync Labels / build (push) Has been cancelled
tests / unit tests (macos-latest) (push) Has been cancelled
tests / unit tests (windows-latest) (push) Has been cancelled
tests / unit tests (ubuntu-latest) (push) Has been cancelled
62 lines
2.2 KiB
Markdown
62 lines
2.2 KiB
Markdown
---
|
|
title: "Snowflake Source"
|
|
linkTitle: "Source"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
Snowflake is a cloud-based data platform.
|
|
no_list: true
|
|
---
|
|
|
|
## About
|
|
|
|
[Snowflake][sf-docs] is a cloud data platform that provides a data warehouse-as-a-service designed for the cloud.
|
|
|
|
[sf-docs]: https://docs.snowflake.com/
|
|
|
|
|
|
|
|
## Available Tools
|
|
|
|
{{< list-tools >}}
|
|
|
|
## Requirements
|
|
|
|
### Database User
|
|
|
|
This source only uses standard authentication. You will need to create a
|
|
Snowflake user to login to the database with.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: source
|
|
name: my-sf-source
|
|
type: snowflake
|
|
account: ${SNOWFLAKE_ACCOUNT}
|
|
user: ${SNOWFLAKE_USER}
|
|
password: ${SNOWFLAKE_PASSWORD}
|
|
database: ${SNOWFLAKE_DATABASE}
|
|
schema: ${SNOWFLAKE_SCHEMA}
|
|
warehouse: ${SNOWFLAKE_WAREHOUSE}
|
|
role: ${SNOWFLAKE_ROLE}
|
|
```
|
|
|
|
{{< notice tip >}}
|
|
Use environment variable replacement with the format ${ENV_NAME}
|
|
instead of hardcoding your secrets into the configuration file.
|
|
{{< /notice >}}
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-----------|:--------:|:------------:|------------------------------------------------------------------------|
|
|
| type | string | true | Must be "snowflake". |
|
|
| account | string | true | Your Snowflake account identifier. |
|
|
| user | string | true | Name of the Snowflake user to connect as (e.g. "my-sf-user"). |
|
|
| password | string | true | Password of the Snowflake user (e.g. "my-password"). |
|
|
| database | string | true | Name of the Snowflake database to connect to (e.g. "my_db"). |
|
|
| schema | string | true | Name of the schema to use (e.g. "my_schema"). |
|
|
| warehouse | string | false | The virtual warehouse to use. Defaults to "COMPUTE_WH". |
|
|
| role | string | false | The security role to use. Defaults to "ACCOUNTADMIN". |
|
|
| timeout | integer | false | The connection timeout in seconds. Defaults to 60. | |