This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
documentation:support_for_database_platforms:snowflake [2022/08/16 11:54] konstantin |
documentation:support_for_database_platforms:snowflake [2025/01/07 14:01] (current) konstantin |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Snowflake Support in OHDSI tools ====== | ====== Snowflake Support in OHDSI tools ====== | ||
- | This page has a list of branches in repositories to be merged into the corresponding ‘master’ branches and officially released in the upcoming future (targeting ATLAS/WebAPI 2.12 release in **August / September 2022**) | + | The Snowflake is officially supported by OHDSI tools since September 2022 and starting with ATLAS/WebAPI 2.12 release. |
- | + | ||
- | To enable Snowflake support before the official release across all repositories, please build the environment utilizing the branches listed below. After all components are released they can use the officially released versions of each particular component or then whole stack as the dependencies should be properly referenced: | + | |
- | + | ||
- | * [[https://github.com/odysseusinc/CommonDataModel/tree/snowflake|OMOP CDM]] - Snowflake OMOP CDM DDL scripts can be found there | + | |
- | * [[https://github.com/odysseusinc/DatabaseConnector/tree/snowflake|DatabaseConnector]] - an R package to connect to a Snowflake database | + | |
- | * [[https://github.com/odysseusinc/SQLRender/tree/snowflake|SqlRender]] - an R package to translate OHDSI SQL to the Snowflake dialect | + | |
- | * [[https://github.com/OHDSI/Achilles/tree/snowflake|Achilles]] - an R package which provides descriptive statistics for a Snowflake OMOP CDM database | + | |
- | * ARACHNE Commons (a common component used by ATLAS/WebAPI and ARACHNE to share common code) | + | |
- | * [[https://github.com/OHDSI/ArachneCommons/tree/snowflake_webapi|ArachneCommons]] - for WebAPI/ATLAS, this is the primary dependency | + | |
- | * [[https://github.com/OHDSI/ArachneCommons/tree/snowflake|ArachneCommons]] - for ARACHNE Execution Engine | + | |
- | * [[https://github.com/OHDSI/ArachneExecutionEngine/tree/snowflake|ARACHNE Execution Engine]] - an application used to execute SQL and R code provided by ATLAS/WebAPI (Patient Level Prediction (PLP), Population Level Effect Estimation (PLE) analyses or ARACHNE Data Node | + | |
- | * [[https://github.com/OHDSI/WebAPI/tree/snowflake|WebAPI]] - a centralized API to perform analytical work on Snowflake OMOP CDM databases | + | |
- | * [[https://github.com/OHDSI/Atlas/tree/snowflake|ATLAS]] - a web application helps researchers to analyze Snowflake OMOP CDM data and make decisions based on the analyses results | + | |
- | + | ||
- | ===== Known Limitations ===== | + | |
- | + | ||
- | [[https://ohdsi.github.io/DatabaseConnectorJars/|DatabaseConnectorJars]] will be updated with the new dialect support information when the DatabaseConnector branch is officially released with the corresponding dialect | + | |
- | + | ||
- | ===== Component Dependencies ===== | + | |
- | + | ||
- | The dependencies between components are displayed on the diagram below, so if a use case requires a top-level component (like ATLAS) the related down-level components should be available in their infrastructure | + | |
- | + | ||
- | {{:documentation:support_for_database_platforms:new-dialect-support.png?700|}} | + | |
===== Connection Example ===== | ===== Connection Example ===== | ||
Line 37: | Line 14: | ||
library(remotes) | library(remotes) | ||
- | # Install DatabaseConnector and SqlRender from branches | + | # Install DatabaseConnector and SqlRender |
- | install_github("ohdsi/DatabaseConnector", ref="snowflake") | + | install_github("ohdsi/DatabaseConnector") |
- | install_github("ohdsi/SqlRender", ref="snowflake") | + | install_github("ohdsi/SqlRender") |
connectionDetails <- DatabaseConnector::createConnectionDetails( | connectionDetails <- DatabaseConnector::createConnectionDetails( | ||
Line 46: | Line 23: | ||
password = "My_password", | password = "My_password", | ||
pathToDriver = "/path/to/driver", | pathToDriver = "/path/to/driver", | ||
- | connectionString = "jdbc:snowflake://my-snowflake-url.snowflakecomputing.com?warehous=My_Warehouse&db=My_Database" | + | connectionString = "jdbc:snowflake://my-snowflake-url.snowflakecomputing.com?warehouse=My_Warehouse&db=My_Database" |
) | ) | ||