49.104    MDM 49.106    Narrative Generator   

49.105.1Migration

 

The Migration configuration category includes the following configurable options:

  • Only Dry-Run the Migration

  • Include Heavyweight Skippable Migrations

  • Migration Versions to skip

  • Database Update Mode

49.105.2Property: Only Dry-Run the Migration

 
Property Name Only Dry-Run the Migration
Property Key
Property Type BOOLEAN
Description If enabled, no migration will occur during startup, even if db.schema_update_mode is set to UPDATE. Instead, the SQL that would be executed is instead logged to the log file.
Applies to Modules
  • Audit Log Persistence
  • Cluster Manager
  • EasyShare SHL Endpoint (Public)
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
  • Transaction Log Persistence
Default Value false
Example Property
module.[MODULE_ID].config.db.migration.dry_run = false

49.105.3Property: Include Heavyweight Skippable Migrations

 
Property Name Include Heavyweight Skippable Migrations
Property Key
Property Type BOOLEAN
Description If enabled, additional migrations will run, which can take a very long time to run on large databases. These are not critical but can improve performance for some systems. Equivalent to the smileutil --enable-heavyweight-migrations flag
Applies to Modules
  • Audit Log Persistence
  • Cluster Manager
  • EasyShare SHL Endpoint (Public)
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
  • Transaction Log Persistence
Default Value false
Example Property
module.[MODULE_ID].config.db.migration.run_heavyweight_skippable_tasks = false

49.105.4Property: Migration Versions to skip

 
Property Name Migration Versions to skip
Property Key
Property Type STRING_MULTILINE
Description Versions included here will be skipped during bootup migration, or during the SmileCDR binary migrate command. Equivalent to the smileutil --skip-versions flag
Applies to Modules
  • Audit Log Persistence
  • Cluster Manager
  • EasyShare SHL Endpoint (Public)
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
  • Transaction Log Persistence
Default Value (no default)
Example Property
module.[MODULE_ID].config.db.migration.skip_versions = 

49.105.5Property: Database Update Mode

 
Property Name Database Update Mode
Property Key
Property Type ENUM
Values
  • UPDATE
  • NONE
Description Controls whether Smile CDR should attempt to update the FHIR storage database schema on startup. If the database schema is out of date, Smile CDR automatically runs migration on the FHIR storage schema at startup if the value is "UPDATE" If the value is "NONE", then Smile CDR will abort starting the FHIR storage module if its schema is out of date. When set to "NONE", you should use the "smileutil migrate" command to upgrade the database manually.
Applies to Modules
  • Audit Log Persistence
  • Cluster Manager
  • EasyShare SHL Endpoint (Public)
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
  • Transaction Log Persistence
Default Value UPDATE
Example Property
module.[MODULE_ID].config.db.schema_update_mode = UPDATE
   49.104    MDM 49.106    Narrative Generator