Create Indices on Common Data Model Tables. — CreateCDMIndices • ETLSyntheaBuilder

This function creates indices for the tables in the CDM.

CreateCDMIndices(
  connectionDetails,
  cdmSchema,
  cdmVersion,
  outputFolder = NULL,
  sqlOnly = FALSE
)

Arguments

connectionDetails: An R object of type
connectionDetails created using the function createConnectionDetails in the DatabaseConnector package.
cdmSchema: The name of the CDM database schema. Requires read and write permissions to this database. On SQL Server, this should specify both the database and the schema, so for example 'cdm_instance.dbo'.
cdmVersion: Your CDM version. Currently "5.3" and "5.4" are supported.
outputFolder: Location of the SQL scripts if sqlOnly = TRUE. Default is NULL.
sqlOnly: A boolean that determines whether to create the indices or generate a SQL scripts Default is FALSE.

This function creates the indices specified by the function CommonDataModel::writeIndex(). Supported CDM versions and db dialects are determined by CommonDataModel::listSupportedVersions() and CommonDataModel::listSupportedDialects(), respectively.