From 670b145b1edd068663c3e0a3e8f5762934ef803c Mon Sep 17 00:00:00 2001 From: Ville Brofeldt <33317356+villebro@users.noreply.github.com> Date: Sat, 21 Jul 2018 01:19:18 +0300 Subject: [PATCH] Add Snowflake connection string instructions (#5443) --- docs/installation.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/installation.rst b/docs/installation.rst index fc8d075cc98..2ea52002b8e 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -370,6 +370,24 @@ You can also use `PyAthena` library _(See more details at https://github.com/laughingman7743/PyAthena#sqlalchemy.)_ +Snowflake +--------- + +The connection string for Snowflake looks like this :: + + snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse} + +The schema is not necessary in the connection string, as it is defined per table/query. +The role and warehouse can be omitted if defaults are defined for the user, i.e. + + snowflake://{user}:{password}@{account}.{region}/{database} + +Make sure the user has privileges to access and use all required +databases/schemas/tables/views/warehouses, as the Snowflake SQLAlchemy engine does +not test for user rights during engine creation. + +_(See more details at https://github.com/snowflakedb/snowflake-sqlalchemy.)_ + Caching -------