2021-09-22 19:39:44 +00:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
< meta name = "generator" content = "pandoc" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=EDGE" / >
< title > Indices, Primary Keys and Foreign Key Constraints< / title >
2022-04-07 14:57:51 +00:00
< script src = "site_libs/header-attrs-2.13/header-attrs.js" > < / script >
2022-01-13 18:59:03 +00:00
< script src = "site_libs/jquery-3.6.0/jquery-3.6.0.min.js" > < / script >
2021-09-22 19:39:44 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< link href = "site_libs/bootstrap-3.3.5/css/cosmo.min.css" rel = "stylesheet" / >
< script src = "site_libs/bootstrap-3.3.5/js/bootstrap.min.js" > < / script >
< script src = "site_libs/bootstrap-3.3.5/shim/html5shiv.min.js" > < / script >
< script src = "site_libs/bootstrap-3.3.5/shim/respond.min.js" > < / script >
2022-01-13 18:59:03 +00:00
< style > h 1 { f o n t - s i z e : 3 4 p x ; }
h1.title {font-size: 38px;}
h2 {font-size: 30px;}
h3 {font-size: 24px;}
h4 {font-size: 18px;}
h5 {font-size: 16px;}
h6 {font-size: 12px;}
code {color: inherit; background-color: rgba(0, 0, 0, 0.04);}
pre:not([class]) { background-color: white }< / style >
2021-09-22 19:39:44 +00:00
< script src = "site_libs/jqueryui-1.11.4/jquery-ui.min.js" > < / script >
< link href = "site_libs/tocify-1.9.1/jquery.tocify.css" rel = "stylesheet" / >
< script src = "site_libs/tocify-1.9.1/jquery.tocify.js" > < / script >
< script src = "site_libs/navigation-1.1/tabsets.js" > < / script >
< link href = "site_libs/highlightjs-9.12.0/default.css" rel = "stylesheet" / >
< script src = "site_libs/highlightjs-9.12.0/highlight.js" > < / script >
< link href = "site_libs/font-awesome-5.1.0/css/all.css" rel = "stylesheet" / >
< link href = "site_libs/font-awesome-5.1.0/css/v4-shims.css" rel = "stylesheet" / >
< link rel = 'shortcut icon' type = 'image/x-icon' href = 'favicon.ico' / >
< style type = "text/css" >
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
< / style >
< style type = "text/css" > code { white-space : pre ; } < / style >
< script type = "text/javascript" >
if (window.hljs) {
hljs.configure({languages: []});
hljs.initHighlightingOnLoad();
if (document.readyState & & document.readyState === "complete") {
window.setTimeout(function() { hljs.initHighlighting(); }, 0);
}
}
< / script >
2022-04-07 14:57:51 +00:00
2021-09-22 19:39:44 +00:00
< link rel = "stylesheet" href = "style.css" type = "text/css" / >
< style type = "text/css" >
.main-container {
max-width: 940px;
margin-left: auto;
margin-right: auto;
}
img {
max-width:100%;
}
.tabbed-pane {
padding-top: 12px;
}
.html-widget {
margin-bottom: 20px;
}
button.code-folding-btn:focus {
outline: none;
}
summary {
display: list-item;
}
2022-04-07 14:57:51 +00:00
details > summary > p:only-child {
display: inline;
}
2022-01-13 18:59:03 +00:00
pre code {
padding: 0;
}
2021-09-22 19:39:44 +00:00
< / style >
< style type = "text/css" >
.dropdown-submenu {
position: relative;
}
.dropdown-submenu>.dropdown-menu {
top: 0;
left: 100%;
margin-top: -6px;
margin-left: -1px;
border-radius: 0 6px 6px 6px;
}
.dropdown-submenu:hover>.dropdown-menu {
display: block;
}
.dropdown-submenu>a:after {
display: block;
content: " ";
float: right;
width: 0;
height: 0;
border-color: transparent;
border-style: solid;
border-width: 5px 0 5px 5px;
border-left-color: #cccccc;
margin-top: 5px;
margin-right: -10px;
}
.dropdown-submenu:hover>a:after {
2022-01-13 18:59:03 +00:00
border-left-color: #adb5bd;
2021-09-22 19:39:44 +00:00
}
.dropdown-submenu.pull-left {
float: none;
}
.dropdown-submenu.pull-left>.dropdown-menu {
left: -100%;
margin-left: 10px;
border-radius: 6px 0 6px 6px;
}
< / style >
2022-01-13 18:59:03 +00:00
< script type = "text/javascript" >
2021-09-22 19:39:44 +00:00
// manage active state of menu based on current page
$(document).ready(function () {
// active menu anchor
href = window.location.pathname
href = href.substr(href.lastIndexOf('/') + 1)
if (href === "")
href = "index.html";
var menuAnchor = $('a[href="' + href + '"]');
// mark it active
2022-01-13 18:59:03 +00:00
menuAnchor.tab('show');
2021-09-22 19:39:44 +00:00
// if it's got a parent navbar menu mark it active as well
menuAnchor.closest('li.dropdown').addClass('active');
2022-01-13 18:59:03 +00:00
// Navbar adjustments
var navHeight = $(".navbar").first().height() + 15;
var style = document.createElement('style');
var pt = "padding-top: " + navHeight + "px; ";
var mt = "margin-top: -" + navHeight + "px; ";
var css = "";
// offset scroll position for anchor links (for fixed navbar)
for (var i = 1; i < = 6; i++) {
css += ".section h" + i + "{ " + pt + mt + "}\n";
}
style.innerHTML = "body {" + pt + "padding-bottom: 40px; }\n" + css;
document.head.appendChild(style);
2021-09-22 19:39:44 +00:00
});
< / script >
<!-- tabsets -->
< style type = "text/css" >
.tabset-dropdown > .nav-tabs {
display: inline-table;
max-height: 500px;
min-height: 44px;
overflow-y: auto;
border: 1px solid #ddd;
border-radius: 4px;
}
.tabset-dropdown > .nav-tabs > li.active:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li.active:before {
content: " ";
border: none;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs > li.active {
display: block;
}
.tabset-dropdown > .nav-tabs > li > a,
.tabset-dropdown > .nav-tabs > li > a:focus,
.tabset-dropdown > .nav-tabs > li > a:hover {
border: none;
display: inline-block;
border-radius: 4px;
background-color: transparent;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li {
display: block;
float: none;
}
.tabset-dropdown > .nav-tabs > li {
display: none;
}
< / style >
<!-- code folding -->
< style type = "text/css" >
#TOC {
margin: 25px 0px 20px 0px;
}
@media (max-width: 768px) {
#TOC {
position: relative;
width: 100%;
}
}
@media print {
.toc-content {
/* see https://github.com/w3c/csswg-drafts/issues/4434 */
float: right;
}
}
.toc-content {
padding-left: 30px;
padding-right: 40px;
}
div.main-container {
max-width: 1200px;
}
div.tocify {
width: 20%;
max-width: 260px;
max-height: 85%;
}
@media (min-width: 768px) and (max-width: 991px) {
div.tocify {
width: 25%;
}
}
@media (max-width: 767px) {
div.tocify {
width: 100%;
max-width: none;
}
}
.tocify ul, .tocify li {
line-height: 20px;
}
.tocify-subheader .tocify-item {
font-size: 0.90em;
}
.tocify .list-group-item {
border-radius: 0px;
}
< / style >
< / head >
< body >
< div class = "container-fluid main-container" >
<!-- setup 3col/9col grid for toc_float and main content -->
2022-01-13 18:59:03 +00:00
< div class = "row" >
2021-09-22 19:39:44 +00:00
< div class = "col-xs-12 col-sm-4 col-md-3" >
< div id = "TOC" class = "tocify" >
< / div >
< / div >
< div class = "toc-content col-xs-12 col-sm-8 col-md-9" >
< div class = "navbar navbar-default navbar-fixed-top" role = "navigation" >
< div class = "container" >
< div class = "navbar-header" >
2022-04-07 14:57:51 +00:00
< button type = "button" class = "navbar-toggle collapsed" data-toggle = "collapse" data-bs-toggle = "collapse" data-target = "#navbar" data-bs-target = "#navbar" >
2021-09-22 19:39:44 +00:00
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "navbar-brand" href = "index.html" > < div > < img src = "ohdsi16x16.png" > < / img > OMOP Common Data Model < / div > < / a >
< / div >
< div id = "navbar" class = "navbar-collapse collapse" >
< ul class = "nav navbar-nav" >
< li >
< a href = "index.html" >
2022-01-13 18:59:03 +00:00
< span class = "fa fa-home" > < / span >
2021-09-22 19:39:44 +00:00
< / a >
< / li >
< li class = "dropdown" >
2022-04-07 14:57:51 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" role = "button" data-bs-toggle = "dropdown" aria-expanded = "false" >
2022-01-13 18:59:03 +00:00
< span class = "fa fa-landmark" > < / span >
2021-09-22 19:39:44 +00:00
Background
< span class = "caret" > < / span >
< / a >
< ul class = "dropdown-menu" role = "menu" >
< li >
< a href = "background.html" > Model Background< / a >
< / li >
< li >
< a href = "cdmRefreshProcess.html" > CDM Refresh Process< / a >
< / li >
< li >
< a href = "vocabulary.html" > How the Vocabulary is Built< / a >
< / li >
< / ul >
< / li >
< li class = "dropdown" >
2022-04-07 14:57:51 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" role = "button" data-bs-toggle = "dropdown" aria-expanded = "false" >
2022-01-13 18:59:03 +00:00
< span class = "fa fa-list-alt" > < / span >
2021-09-22 19:39:44 +00:00
Conventions
< span class = "caret" > < / span >
< / a >
< ul class = "dropdown-menu" role = "menu" >
< li >
< a href = "dataModelConventions.html" > General Conventions< / a >
< / li >
< li >
< a href = "ehrObsPeriods.html" > Observation Periods for EHR Data< / a >
< / li >
< li >
< a href = "cdmPrivacy.html" > Patient Privacy and OMOP< / a >
< / li >
< / ul >
< / li >
< li class = "dropdown" >
2022-04-07 14:57:51 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" role = "button" data-bs-toggle = "dropdown" aria-expanded = "false" >
2022-01-13 18:59:03 +00:00
< span class = "fa fa-history" > < / span >
2021-09-22 19:39:44 +00:00
CDM Versions
< span class = "caret" > < / span >
< / a >
< ul class = "dropdown-menu" role = "menu" >
< li >
< a href = "cdm30.html" > CDM v3.0< / a >
< / li >
< li >
< a href = "cdm60.html" > CDM v6.0< / a >
< / li >
< li >
< a href = "cdm53.html" > CDM v5.3< / a >
< / li >
< li class = "dropdown-submenu" >
2022-04-07 14:57:51 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" role = "button" data-bs-toggle = "dropdown" aria-expanded = "false" > NEW CDM v5.4< / a >
2021-09-22 19:39:44 +00:00
< ul class = "dropdown-menu" role = "menu" >
< li >
< a href = "cdm54.html" > CDM v5.4< / a >
< / li >
< li >
< a href = "cdm54Changes.html" > Changes from CDM v5.3< / a >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "dropdown" >
2022-04-07 14:57:51 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" role = "button" data-bs-toggle = "dropdown" aria-expanded = "false" >
2022-01-13 18:59:03 +00:00
< span class = "fa fa-plus-square" > < / span >
2021-09-22 19:39:44 +00:00
Proposals
< span class = "caret" > < / span >
< / a >
< ul class = "dropdown-menu" role = "menu" >
< li >
< a href = "https://github.com/OHDSI/CommonDataModel/issues?q=is%3Aopen+is%3Aissue+label%3AProposal" > Under Review< / a >
< / li >
< li class = "dropdown-submenu" >
2022-04-07 14:57:51 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" role = "button" data-bs-toggle = "dropdown" aria-expanded = "false" > Accepted< / a >
2021-09-22 19:39:44 +00:00
< ul class = "dropdown-menu" role = "menu" >
< li >
< a href = "https://github.com/OHDSI/CommonDataModel/issues/252" > Region_concept_id< / a >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "dropdown" >
2022-04-07 14:57:51 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" role = "button" data-bs-toggle = "dropdown" aria-expanded = "false" >
2022-01-13 18:59:03 +00:00
< span class = "fa fa-question" > < / span >
2021-09-22 19:39:44 +00:00
How to
< span class = "caret" > < / span >
< / a >
< ul class = "dropdown-menu" role = "menu" >
< li >
< a href = "download.html" > Download the DDL< / a >
< / li >
< li >
< a href = "cdmRPackage.html" > Use the CDM R Package< / a >
< / li >
< li >
< a href = "drug_dose.html" > Calculate Drug Dose< / a >
< / li >
< / ul >
< / li >
< li class = "dropdown" >
2022-04-07 14:57:51 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" role = "button" data-bs-toggle = "dropdown" aria-expanded = "false" >
2022-01-13 18:59:03 +00:00
< span class = "fa fa-life-ring" > < / span >
2021-09-22 19:39:44 +00:00
Support
< span class = "caret" > < / span >
< / a >
< ul class = "dropdown-menu" role = "menu" >
< li >
< a href = "faq.html" > FAQ< / a >
< / li >
< li >
< a href = "sqlScripts.html" > SQL Scripts< / a >
< / li >
< li >
< a href = "contribute.html" > Ask a Question< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "nav navbar-nav navbar-right" >
< li >
< a href = "https://github.com/OHDSI/CommonDataModel" >
2022-01-13 18:59:03 +00:00
< span class = "fa fa-github" > < / span >
2021-09-22 19:39:44 +00:00
< / a >
< / li >
< / ul >
< / div > <!-- /.nav - collapse -->
< / div > <!-- /.container -->
< / div > <!-- /.navbar -->
2022-01-13 18:59:03 +00:00
< div id = "header" >
2021-09-22 19:39:44 +00:00
< h1 class = "title toc-ignore" > Indices, Primary Keys and Foreign Key Constraints< / h1 >
< / div >
< div id = "overview" class = "section level2" >
< h2 > Overview< / h2 >
< p > Database indices improve the performance of queries against a database by organizing the data in a way that increase query execution.< / p >
< p > This article was written to provide guidance on the setting of indices, primary and foreign keys for data that has been transformed into the Observational Medical Outcome Partnership (OMOP) Common Data Model (CDM). The community that supports the design and development of the OHDSI/CommonDataModel Github repository is a diverse collaborative of healthcare and technical profesisonals whom have limited data base adminstrative (DBA) experience. As a result, the comments below should be interpreted as suggestions and recommendations to help increase performance. Your teams needs may call for a modified configuration.< / p >
< / div >
< div id = "general-recommendations" class = "section level2" >
< h2 > General Recommendations< / h2 >
< p > Should your database of choice support indexing, the OMOP CDM Working Group recommends< / p >
< ul >
< li > Indexing on all columns containing an "_id" (e.g. < / li >
< li > Indexing on primary and foreign keys< / li >
< / ul >
< p > For all databases, regardless of custom indice support, primary and foreign keys should be set. This is a step towards ensuring data integrity. Information on what table level attributes should be set as primary and foreign keys can be found within the *_Field_Level.csv file(s) located in the < a href = "https://github.com/OHDSI/CommonDataModel/tree/v5.4/inst/csv" > INST/CSV directory< / a > < / p >
< / div >
< div id = "database-support" class = "section level2" >
< h2 > Database support< / h2 >
< p > The OHDSI/CommonDataModel package leverages OHDSI/SQLRender and as a result is only capable of supporting sources that are supported by OHDSI/SQLRender. The following databases are currently supported.< / p >
< div id = "microsoft-sql-server" class = "section level3" >
< h3 > Microsoft SQL Server< / h3 >
< / div >
< div id = "oracle" class = "section level3" >
< h3 > Oracle< / h3 >
< / div >
< div id = "postgresql" class = "section level3" >
< h3 > PostgreSQL< / h3 >
< / div >
< div id = "amazon-redshift" class = "section level3" >
< h3 > Amazon Redshift< / h3 >
< p > On AWS Redshift it is important to ensure that your data is properly distributed and sorted across nodes. Compression on certain columns may also help. The designed DDL does set DISTKEYS in an effort to optimize performance. This configuration can be seen within the < a href = "https://github.com/OHDSI/CommonDataModel/blob/v5.4/ddl/5.4/redshift/OMOPCDM_redshift_5.4_ddl.sql" > Redshift-specific DDL< / a > .< / p >
< / div >
< div id = "impala" class = "section level3" >
< h3 > Impala< / h3 >
< / div >
< div id = "ibm-netezza" class = "section level3" >
< h3 > IBM Netezza< / h3 >
< / div >
< div id = "google-bigquery" class = "section level3" >
< h3 > Google BigQuery< / h3 >
< p > Google BigQuery does not require manual optimization and/or sizing. Google BigQuery does massive parallel full table scans and intensive caching, all under the hood. < a href = "https://forums.ohdsi.org/t/iso-best-practices-of-cdm-indexing/10939/2" > Reference< / a > < / p >
< / div >
< div id = "microsoft-parallel-data-warehouse-pdw" class = "section level3" >
< h3 > Microsoft Parallel Data Warehouse (PDW)< / h3 >
< / div >
< div id = "sqlite" class = "section level3" >
< h3 > SQLite< / h3 >
< / div >
< div id = "databricks" class = "section level3" >
< h3 > Databricks< / h3 >
< p > This database type is not yet supported but is actively being worked on by a number of collaborators. For more informtion, please contact Ajit Londhe of Amgen.< / p >
< / div >
< / div >
< div id = "references" class = "section level2" >
< h2 > References< / h2 >
< p > < a href = "https://forums.ohdsi.org/t/iso-best-practices-of-cdm-indexing/10939/2" > ISO Best Practices of CDM Indexing< / a > < / p >
< / div >
< / div >
< / div >
< / div >
< script >
// add bootstrap table styles to pandoc tables
function bootstrapStylePandocTables() {
$('tr.odd').parent('tbody').parent('table').addClass('table table-condensed');
}
$(document).ready(function () {
bootstrapStylePandocTables();
});
< / script >
<!-- tabsets -->
< script >
$(document).ready(function () {
window.buildTabsets("TOC");
});
$(document).ready(function () {
$('.tabset-dropdown > .nav-tabs > li').click(function () {
2022-01-13 18:59:03 +00:00
$(this).parent().toggleClass('nav-tabs-open');
2021-09-22 19:39:44 +00:00
});
});
< / script >
<!-- code folding -->
< script >
$(document).ready(function () {
2022-01-13 18:59:03 +00:00
// temporarily add toc-ignore selector to headers for the consistency with Pandoc
$('.unlisted.unnumbered').addClass('toc-ignore')
2021-09-22 19:39:44 +00:00
// move toc-ignore selectors from section div to header
$('div.section.toc-ignore')
.removeClass('toc-ignore')
.children('h1,h2,h3,h4,h5').addClass('toc-ignore');
// establish options
var options = {
selectors: "h1,h2,h3,h4,h5",
theme: "bootstrap3",
context: '.toc-content',
hashGenerator: function (text) {
return text.replace(/[.\\/?& !#< >]/g, '').replace(/\s/g, '_');
},
ignoreSelector: ".toc-ignore",
scrollTo: 0
};
options.showAndHide = true;
options.smoothScroll = true;
// tocify
var toc = $("#TOC").tocify(options).data("toc-tocify");
});
< / script >
<!-- dynamically load mathjax for compatibility with self - contained -->
< script >
(function () {
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
document.getElementsByTagName("head")[0].appendChild(script);
})();
< / script >
< / body >
< / html >
