====== Support for database platforms ======

The OHDSI tools interact directly with the data in the OMOP Common Data Model (CDM). As such, they need to connect with the database server, and perform advanced analytics, both on the server and the client. The OHDSI tools currently support a wide range of DataBase Management Systems (DBMS), to varying degrees. Many have expressed interest in expanding the list of DBMSs even further.

===== What does it take to add support for a DBMS? =====

Adding support for a DBMS is a massive undertaking, both initially to configure the tools to work with the DBMS, but also forever after to ensure the tools keep working as they are updated and expanded. Below we attempt to list which activities are required. 

For the CDM:

  * The [[https://github.com/OHDSI/CommonDataModel|CDM DDL]] is automatically generated from a master DDL through SqlRender translation.

For OHDSI R packages:

  * [[https://github.com/OHDSI/SqlRender/blob/master/inst/csv/replacementPatterns.csv|SqlRender translation rules]]
  * [[https://github.com/OHDSI/DatabaseConnector|DatabaseConnector]] support (E.g. JDBC driver)
  * Support for each analytics package, e.g. [[https://github.com/OHDSI/Achilles|ACHILLES]] and [[https://ohdsi.github.io/MethodsLibrary/|the OHDSI Methods Library]]
  * A test database available for continuous integration


For ATLAS:

? (Note: not sure what is needed, and how far this needs to be split up. WebAPI? Specific services in WebAPI?)


===== Support matrix =====

Who supports which DBMS for which OHDSI tool? (Names are Github handles)

^                    ^ SQL Server  ^ Oracle    ^ PostgreSQL  ^ PDW       ^ RedShift  ^ Impala    ^ BigQuery  ^ Netezza  ^ Sqlite    ^ Snowflake ^ Synapse   ^ Spark      ^
^ SqlRender          | schuemie    | schuemie  | schuemie    | schuemie  | schuemie  | konstjar  | konstjar  | konstjar | schuemie  | konstjar  | konstjar  |            |
^ DatabaseConnector  | schuemie    | schuemie  | schuemie    | schuemie  | schuemie  | konstjar  | konstjar  | konstjar | schuemie  | konstjar  | konstjar  |            |
^ CI server          | leeevans    | leeevans  | leeevans    |           |           |           |           |          |           |           |           |            |
^                    |             |           |             |           |           |           |           |          |           |           |           |            |
^ ACHILLES           |             |           |             |           |           |           |           |          |           |           |           |            |
^ Methods Library    | schuemie    | schuemie  | schuemie    | schuemie  | schuemie  | konstjar  | konstjar  | konstjar | schuemie  | konstjar  | konstjar  |            |
^                    |             |           |             |           |           |           |           |          |           |           |           |            |
^ ATLAS              |             |           |             |           |           |           |           |          |           |           |           |            |


~~NOTOC~~




===== DBMS Support Notes =====

    * [[documentation:support_for_database_platforms:snowflake|Snowflake]]