-
Notifications
You must be signed in to change notification settings - Fork 83
Open
Description
Problem Description
There is a naming inconsistency in the database credential configuration:
- The YAML configuration file uses the key
database.user - The Database object property is named
username
This mismatch can be confusing for users and developers working with the configuration system.
Current Behavior
In load_credentials_from_file, the code reads:
database.userfrom YAML → maps toself.usernamedatabase.passwordfrom YAML → maps toself.password
Proposed Solutions
As discussed by @haiqi96, we could:
- Change the YAML format: Update the configuration file format to use
database.usernameinstead ofdatabase.userfor consistency with the object property names - Backward compatibility: Provide users with a patch file or migration tool to convert existing configurations that use
usertousername - Alternative: Support both keys during a transition period (accept either
database.userordatabase.username)
Compatibility Concerns
- Existing user configurations currently use
database.user - Any change needs to consider backward compatibility
- Migration tooling may be necessary to help users update their configurations
Context
This issue was identified during code review of PR #1152 where database credential loading was refactored.
References:
- PR: refactor(package): Standardize how configuration and credentials are passed to containers (resolves #1149). #1152
- Comment thread: refactor(package): Standardize how configuration and credentials are passed to containers (resolves #1149). #1152 (comment)
Contributors: @junhaoliao @haiqi96
Metadata
Metadata
Assignees
Labels
No labels