Skip to content

11639-db-opts-idempotency.md

Latest commit

 

History

History
45 lines (36 loc) · 2.31 KB

11639-db-opts-idempotency.md

File metadata and controls

45 lines (36 loc) · 2.31 KB

Database Settings Cleanup

With this release, we remove some legacy specialties around Database Settings and provide better Admin API endpoints for them.

Most important changes:

  1. Setting BuiltinUsers.KEY was renamed to :BuiltinUsersKey, aligned with our general naming pattern for options.
  2. Setting WorkflowsAdmin#IP_WHITELIST_KEY was renamed to :WorkflowsAdminIpWhitelist, aligned with our general naming pattern for options.
  3. Setting :TabularIngestSizeLimit no longer uses suffixes for formats and becomes a JSON-based setting instead.
  4. If set, all three settings will be migrated to their new form automatically for you (Flyway migration).
  5. You can no longer (accidentally) create or use arbitrary setting names or languages. All Admin API endpoints for settings now validate setting names and languages for existence and compliance.

As an administrator of a Dataverse instance, you can now make use of enhanced Bulk Operations on the Settings Admin API:

  1. Retrieving all settings as JSON via GET /api/admin/settings supports localized options now, too.
  2. You can replace all existing settings in an idempotent way sending JSON to PUT /api/admin/settings. This will create, update and remove settings as necessary in one atomic operation.
    The new endpoint is especially useful to admins using GitOps or other automations. It allows control over all Database Settings from a single source without risking an undefined state.

Note: Despite the validation of setting names and languages, the content of any database setting is still not being validated when using the Settings Admin API!

Updated Database Settings

The following database settings are were added to the official list within the code (to remain valid with the settings cleanup mentioned above):

  • :BagGeneratorThreads
  • :BagItHandlerEnabled
  • :BagItLocalPath
  • :BagValidatorJobPoolSize
  • :BagValidatorJobWaitInterval
  • :BagValidatorMaxErrors
  • :BuiltinUsersKey - formerly BuiltinUsers.KEY
  • :CreateDataFilesMaxErrorsToDisplay
  • :DRSArchiverConfig - a Harvard-specific setting
  • :DuraCloudContext
  • :DuraCloudHost
  • :DuraCloudPort
  • :FileCategories
  • :GoogleCloudBucket
  • :GoogleCloudProject
  • :LDNAnnounceRequiredFields
  • :LDNTarget
  • :WorkflowsAdminIpWhitelist - formerly WorkflowsAdmin#IP_WHITELIST_KEY
⚡