Added MSSQL_DB, MSSQL_USER and MSSQL_PASSWORD variables#10307
Added MSSQL_DB, MSSQL_USER and MSSQL_PASSWORD variables#10307fterrani wants to merge 1 commit intoMicrosoftDocs:livefrom
Conversation
|
@fterrani : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit d49720d: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Can you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
bot
added
the
aq-pr-triaged
|
@fterrani : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
There was a problem hiding this comment.
Pull request overview
Adds documentation for additional SQL Server Linux container environment variables, expanding the existing environment variable reference used for container configuration scenarios.
Changes:
- Document
MSSQL_DB,MSSQL_USER, andMSSQL_PASSWORDin the environment variable table. - Describe the relationship/requirements between the new variables (DB/user/password creation on container start).
| | `MSSQL_DB` | Sets the name of a database to create on container startup. | | ||
| | `MSSQL_USER` | If `MSSQL_DB` is set, sets the name of a non-`sa` user to create on container startup. User will be granted access rights on the `MSSQL_DB` database. If this variable is used, `MSSQL_PASSWORD` must also be set. If `MSSQL_DB` is not set, this variable is ignored. | | ||
| | `MSSQL_PASSWORD` | Sets the password of the user whose name is in `MSSQL_USER`. If this variable is used, `MSSQL_USER` must also be set. If `MSSQL_DB` is not set, this variable is ignored. | |
There was a problem hiding this comment.
These new environment variables appear to be specific to the SQL Server 2025 container image (per the PR description). As written, the table reads like a general list for all versions, which could mislead readers using 2017/2019/2022 images. Consider scoping these rows to the >=sql-server-ver17 || >=sql-server-linux-ver17 moniker range, or explicitly noting they apply only to the 2025 (and later) container images.
| | `MSSQL_USER` | If `MSSQL_DB` is set, sets the name of a non-`sa` user to create on container startup. User will be granted access rights on the `MSSQL_DB` database. If this variable is used, `MSSQL_PASSWORD` must also be set. If `MSSQL_DB` is not set, this variable is ignored. | | ||
| | `MSSQL_PASSWORD` | Sets the password of the user whose name is in `MSSQL_USER`. If this variable is used, `MSSQL_USER` must also be set. If `MSSQL_DB` is not set, this variable is ignored. | |
There was a problem hiding this comment.
The MSSQL_USER description has a couple of readability/grammar issues (for example, missing an article in “User will be granted…”, and “access rights on” reads awkwardly). Consider rephrasing in present tense (for example, “The user is granted access to …”) and tightening the dependency wording to make the requirements (MSSQL_PASSWORD required when MSSQL_USER is set) easier to scan.
| | `MSSQL_USER` | If `MSSQL_DB` is set, sets the name of a non-`sa` user to create on container startup. User will be granted access rights on the `MSSQL_DB` database. If this variable is used, `MSSQL_PASSWORD` must also be set. If `MSSQL_DB` is not set, this variable is ignored. | | |
| | `MSSQL_PASSWORD` | Sets the password of the user whose name is in `MSSQL_USER`. If this variable is used, `MSSQL_USER` must also be set. If `MSSQL_DB` is not set, this variable is ignored. | | |
| | `MSSQL_USER` | If `MSSQL_DB` is set, sets the name of a non-`sa` user to create on container startup. The user is granted access to the `MSSQL_DB` database. Requires `MSSQL_PASSWORD`. If `MSSQL_DB` isn't set, this variable is ignored. | | |
| | `MSSQL_PASSWORD` | Sets the password for the user specified in `MSSQL_USER`. Requires `MSSQL_USER`. If `MSSQL_DB` isn't set, this variable is ignored. | |
| | `MSSQL_SA_PASSWORD` | Configure the `sa` password.<br /><br />The `SA_PASSWORD` environment variable is deprecated. Use `MSSQL_SA_PASSWORD` instead. | | ||
| | `MSSQL_DB` | Sets the name of a database to create on container startup. | | ||
| | `MSSQL_USER` | If `MSSQL_DB` is set, sets the name of a non-`sa` user to create on container startup. User will be granted access rights on the `MSSQL_DB` database. If this variable is used, `MSSQL_PASSWORD` must also be set. If `MSSQL_DB` is not set, this variable is ignored. | | ||
| | `MSSQL_PASSWORD` | Sets the password of the user whose name is in `MSSQL_USER`. If this variable is used, `MSSQL_USER` must also be set. If `MSSQL_DB` is not set, this variable is ignored. | |
There was a problem hiding this comment.
“Sets the password of the user whose name is in MSSQL_USER” is a bit unclear; MSSQL_USER is a variable, not a container. Consider rephrasing to “...the user specified by MSSQL_USER” for clarity and consistency with the other descriptions.
| | `MSSQL_PASSWORD` | Sets the password of the user whose name is in `MSSQL_USER`. If this variable is used, `MSSQL_USER` must also be set. If `MSSQL_DB` is not set, this variable is ignored. | | |
| | `MSSQL_PASSWORD` | Sets the password of the user specified by `MSSQL_USER`. If this variable is used, `MSSQL_USER` must also be set. If `MSSQL_DB` is not set, this variable is ignored. | |
Added
MSSQL_DB,MSSQL_USERandMSSQL_PASSWORDvariables.Descriptions were deduced from inspecting startup shell scripts and Dockerfile of image
mssql/server:2025-latest.