> ## Documentation Index
> Fetch the complete documentation index at: https://unstructured-53-docs-243-plugins.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Snowflake
If you're new to Unstructured, read this note first.
Before you can create a destination connector, you must first [sign up for Unstructured](https://platform.unstructured.io) and get your
Unstructured API key. After you sign up, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get the key.
To learn how, watch this 40-second [how-to video](https://www.youtube.com/watch?v=FucugLkYB6M).
After you create the destination connector, add it along with a
[source connector](/api-reference/workflow/sources/overview) to a [workflow](/api-reference/workflow/overview#workflows).
Then run the worklow as a [job](/api-reference/workflow/overview#jobs). To learn how, try out the
[hands-on Workflow Endpoint quickstart](/api-reference/workflow/overview#quickstart),
go directly to the [quickstart notebook](https://colab.research.google.com/drive/13f5C9WtUvIPjwJzxyOR3pNJ9K9vnF4ww),
or watch the two 4-minute video tutorials for the [Unstructured Python SDK](/api-reference/workflow/overview#unstructured-python-sdk).
You can also create destination connectors with the Unstructured user interface (UI).
[Learn how](/ui/destinations/overview).
If you need help, reach out to the [community](https://short.unstructured.io/pzw05l7) on Slack, or
[contact us](https://unstructured.io/contact) directly.
You are now ready to start creating a destination connector! Keep reading to learn how.
Send processed data from Unstructured to Snowflake.
The requirements are as follows.
* A Snowflake [account](https://signup.snowflake.com/) and its account identifier.
To get the identifier for the current Snowflake account:
1. Log in to [Snowsight](https://docs.snowflake.com/user-guide/ui-snowsight-homepage) with your Snowflake account.
2. In Snowsight, on the navigation menu, click your username, and then click **Account > View account details**.
3. On the **Account** tab, note the value of the **Account Identifier** field.
Alternatively, the following Snowflake query returns the current account's identifier:
```text theme={null}
SELECT CURRENT_ORGANIZATION_NAME() || '-' || CURRENT_ACCOUNT_NAME() AS "Account Identifier"
```
* The Snowflake [user's login name (not its username) and its password](https://docs.snowflake.com/user-guide/admin-user-management#creating-users) in the account.
To view the login name for a user:
1. Log in to [Snowsight](https://docs.snowflake.com/user-guide/ui-snowsight-homepage) with your Snowflake account.
2. In Snowsight, on the navigation menu, click **Admin > Users & Roles**.
3. On the **Users** tab, in the list of available users, click the name of the target user.
4. In the **About** tile, note the **Login Name** for the user.
Alternatively, the following Snowflake query returns information about the user with the username of ``, including their `login_name` value representing their login name:
```text theme={null}
SHOW USERS LIKE '';
```
* The name of the Snowflake [role](https://docs.snowflake.com/sql-reference/sql/create-role) that the user belongs to and that also has sufficient access to the Snowflake database, schema, table, and host.
* To create a database in Snowflake, the role needs to be granted `CREATE DATABASE` privilege at the current account level; and `USAGE` privilege on the warehouse that is used to create the database.
* To create a schema in a database in Snowflake, the role needs to be granted `USAGE` privilege on the database and the warehouse that is used to create the schema; and `CREATE SCHEMA` on the database.
* To create a table in a schema in Snowflake, the role needs to be granted `USAGE` privilege on the database and schema and the warehouse that is used to create the table; and `CREATE TABLE` on the schema.
* To write to a table in Snowflake, the role needs to be granted `USAGE` privilege on the database and schema and the warehouse that is used to write to the table; and `INSERT` on the table.
* To read from a table in Snowflake, the role needs to be granted `USAGE` privilege on the database and schema and the warehouse that is used to write to the table; and `SELECT` on the table.
To view a list of available roles in the current Snowflake account:
1. Log in to [Snowsight](https://docs.snowflake.com/user-guide/ui-snowsight-homepage) with your Snowflake account.
2. In Snowsight, on the navigation menu, click **Admin > Users & Roles**.
3. Click the **Roles** tab.
Alternatively, the following Snowflake query returns a list of available roles in the current account:
```text theme={null}
SHOW ROLES;
```
[Grant privileges to a role](https://docs.snowflake.com/sql-reference/sql/grant-privilege). [Learn more](https://docs.snowflake.com/user-guide/security-access-control-privileges).
* The Snowflake warehouse's [hostname and its port number](https://docs.snowflake.com/sql-reference/functions/system_allowlist) in the account.
To view a list of available warehouses in the current Snowflake account:
1. Log in to [Snowsight](https://docs.snowflake.com/user-guide/ui-snowsight-homepage) with your Snowflake account.
2. In Snowsight, on the navigation menu, click **Admin > Warehouses**. This view does not provide access to the warehouses' hostnames or port numbers. To get this information, you must run a Snowflake query.
The following Snowflake query returns a list of available warehouse types, hostnames, and port numbers in the current account. Look for the row with a `type` of `SNOWFLAKE_DEPLOYMENT`:
```text theme={null}
SELECT t.VALUE:type::VARCHAR as type,
t.VALUE:host::VARCHAR as host,
t.VALUE:port as port
FROM TABLE(FLATTEN(input => PARSE_JSON(SYSTEM$ALLOWLIST()))) AS t;
```
* The name of the Snowflake [database](https://docs.snowflake.com/sql-reference/sql/create-database) in the account.
To view a list of available databases in the current Snowflake account:
1. Log in to [Snowsight](https://docs.snowflake.com/user-guide/ui-snowsight-homepage) with your Snowflake account.
2. In Snowsight, on the navigation menu, click **Data > Databases**.
Alternatively, the following Snowflake query returns a list of available databases in the current account:
```text theme={null}
SHOW DATABASES;
```
* The name of the [schema](https://docs.snowflake.com/sql-reference/sql/create-schema) in the database.
To view a list of available schemas for a database in the current Snowflake account:
1. Log in to [Snowsight](https://docs.snowflake.com/user-guide/ui-snowsight-homepage) with your Snowflake account.
2. In Snowsight, on the navigation menu, click **Data > Databases**.
3. Expand the name of the target database.
Alternatively, the following Snowflake query returns a list of available schemas in the current account:
```text theme={null}
SHOW SCHEMAS;
```
The following Snowflake query returns a list of available schemas for the database named `` in the current account:
```text theme={null}
SHOW SCHEMAS IN DATABASE ;
```
* The name of the [table](https://docs.snowflake.com/sql-reference/sql/create-table) in the schema.
To view a list of available tables for a schema in a database in the current Snowflake account:
1. Log in to [Snowsight](https://docs.snowflake.com/user-guide/ui-snowsight-homepage) with your Snowflake account.
2. In Snowsight, on the navigation menu, click **Data > Databases**.
3. Expand the name of the database that contains the target schema.
4. Expand the name of the target schema.
5. Expand **Tables**.
Alternatively, the following Snowflake query returns a list of available tables for the schema named `` in the datbase named
`` in the current account:
```text theme={null}
SHOW TABLES IN SCHEMA .;
```
Snowflake requires the target table to have a defined schema before Unstructured can write to the table. The recommended table
schema for Unstructured is as follows:
```sql SQL theme={null}
CREATE TABLE ELEMENTS (
ID VARCHAR(36) NOT NULL DEFAULT UUID_STRING(),
RECORD_ID VARCHAR,
ELEMENT_ID VARCHAR,
TEXT VARCHAR,
EMBEDDINGS ARRAY,
TYPE VARCHAR,
SYSTEM VARCHAR,
LAYOUT_WIDTH NUMBER,
LAYOUT_HEIGHT NUMBER,
POINTS VARCHAR,
URL VARCHAR,
VERSION VARCHAR,
DATE_CREATED TIMESTAMP_TZ,
DATE_MODIFIED TIMESTAMP_TZ,
DATE_PROCESSED TIMESTAMP_TZ,
PERMISSIONS_DATA VARCHAR,
RECORD_LOCATOR VARCHAR,
CATEGORY_DEPTH NUMBER,
PARENT_ID VARCHAR,
ATTACHED_FILENAME VARCHAR,
FILETYPE VARCHAR,
LAST_MODIFIED TIMESTAMP_TZ,
FILE_DIRECTORY VARCHAR,
FILENAME VARCHAR,
LANGUAGES ARRAY,
PAGE_NUMBER VARCHAR,
LINKS VARCHAR,
PAGE_NAME VARCHAR,
LINK_URLS ARRAY,
LINK_TEXTS ARRAY,
SENT_FROM ARRAY,
SENT_TO ARRAY,
SUBJECT VARCHAR,
SECTION VARCHAR,
HEADER_FOOTER_TYPE VARCHAR,
EMPHASIZED_TEXT_CONTENTS ARRAY,
EMPHASIZED_TEXT_TAGS ARRAY,
TEXT_AS_HTML VARCHAR,
REGEX_METADATA VARCHAR,
DETECTION_CLASS_PROB NUMBER,
PRIMARY KEY (ID),
PARTITIONER_TYPE VARCHAR
);
```
* The name of the column in the table that uniquely identifies each record (for example, `RECORD_ID`).
To create a Snowflake destination connector, see the following examples.
```python Python SDK theme={null}
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateDestinationRequest
from unstructured_client.models.shared import (
CreateDestinationConnector,
DestinationConnectorType,
SnowflakeDestinationConnectorConfigInput
)
with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
response = client.destinations.create_destination(
request=CreateDestinationRequest(
create_destination_connector=CreateDestinationConnector(
name="",
type=DestinationConnectorType.SNOWFLAKE,
config=SnowflakeDestinationConnectorConfigInput(
account="",
user="",
host="",
port=,
database="",
schema="",
role="",
password="",
record_id_key="",
table_name="",
batch_size=
)
)
)
)
print(response.destination_connector_information)
```
```bash curl theme={null}
curl --request 'POST' --location \
"$UNSTRUCTURED_API_URL/destinations" \
--header 'accept: application/json' \
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
--header 'content-type: application/json' \
--data \
'{
"name": "",
"type": "snowflake",
"config": {
"account": "",
"user": "",
"host": "",
"port": ,
"database": "",
"schema": "",
"role": "",
"password": "",
"record_id_key": "",
"table_name": "",
"batch_size":
}
}'
```
Replace the preceding placeholders as follows:
* `` (*required*) - A unique name for this connector.
* `` (*required*): The target Snowflake account's identifier.
* `` (*required*): The name of the Snowflake role that the user belongs to. This role must have the appropriate access to the target Snowflake warehouse, database, schema, and table.
* `` (*required*): The target Snowflake user's login name (not their username).
* `` (*required*): The user's password.
* `` (*required*): The hostname of the target Snowflake warehouse.
* `` (*required*): The warehouse's port number. The default is `443` if not otherwise specified.
* `` (*required*): The name of the target Snowflake database.
* `` (*required*): The name of the target Snowflake schema within the database.
* ``: The name of the target Snowflake table within the database's schema. For the destination connector, the default is `elements` if not otherwise specified.
* `` (source connector only): A comma-separated list of columns to fetch from the table. By default, all columns are fetched unless otherwise specified.
* `` (*required*, source connector only): The name of the column that uniquely identifies each record in the table.
* `` (destination connector only): The name of the column that uniquely identifies each record in the table. The default is `record_id` if not otherwise specified.
* `` (*required*): The maximum number of rows to fetch for each batch. The default is `50` if not otherwise specified.