Skip to contents

DbConfigBlock R6 Class

Source: R/Ulysses.R
DbConfigBlock.Rd

Represents a database configuration block for connecting to a specific database. Encapsulates database connection parameters and naming conventions used during study execution.

Details

DbConfigBlock manages configuration for a single database connection within the Ulysses framework. This includes CDM schema specifications, cohort table references, and database labeling. Used to manage multiple database connections within a study.

Active Fields

  • configBlockName: Unique identifier for this config block (read/write)

  • cdmDatabaseSchema: Schema name containing the CDM (read/write)

  • cohortTable: Table name for study cohorts (read/write)

  • databaseName: Database identifier (read/write, defaults to configBlockName)

  • databaseLabel: Human-readable database label (read/write)

Methods

  • initialize(): Create and configure a new DbConfigBlock instance

  • writeBlockSection(): Generate formatted configuration block text

Active bindings

configBlockName

Unique identifier for this configuration block. Can be read or set with validation.

cdmDatabaseSchema

Schema name containing the CDM data. Can be read or set with validation.

cohortTable

Table name for study cohorts. Can be read or set with validation.

databaseName

Database identifier. Can be read or set with validation. Defaults to configBlockName.

databaseLabel

Human-readable database label for display. Can be read or set with validation.

dbServer

Database server name for secrets.yml lookup. Can be read or set with validation. Defaults to configBlockName.

workDatabaseSchema

Working schema for writing temporary tables. Per-block setting (not study-level).

tempEmulationSchema

Schema for emulating temporary tables (Oracle/Snowflake). Per-block setting.

Methods

Public methods

Method new()

Initialize a new DbConfigBlock instance with database configuration.

Usage

DbConfigBlock$new(
  configBlockName,
  cdmDatabaseSchema,
  cohortTable,
  databaseName = NULL,
  databaseLabel = NULL,
  dbServer = NULL,
  workDatabaseSchema = NULL,
  tempEmulationSchema = NULL
)

Arguments

configBlockName

Character string. Unique identifier for this configuration block.

cdmDatabaseSchema

Character string. Schema containing CDM data.

cohortTable

Character string. Table name for study cohorts.

databaseName

Character string. Optional database identifier (defaults to configBlockName).

databaseLabel

Character string. Optional human-readable database label (defaults to databaseName).

dbServer

Character string. Optional database server name for secrets.yml lookup (defaults to configBlockName).

workDatabaseSchema

Character string. Optional working schema for temp tables (per-block).

tempEmulationSchema

Character string. Optional temp table emulation schema (per-block).

Returns

Invisibly returns self.

Method writeBlockSection()

Generate a formatted configuration block section for the config file.

Usage

DbConfigBlock$writeBlockSection()

Details

Extracts all fields from the block's own private data, including workDatabaseSchema and tempEmulationSchema which are set per-block (not at the study level).

Returns

Character string with formatted configuration block.

Method clone()

The objects of this class are cloneable with this method.

Usage

DbConfigBlock$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.