Skip to content

[docs] Update SQL Server REPL docs for direct sqlcmd invocation and wrapper scripts - #1822

Draft
aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20704-37108974618-1-256a055678ce5620
Draft

aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20704-37108974618-1-256a055678ce5620

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#20704
@mitchdenny

Target branch: Targeting release/17.0 based on the source PR milestone 17.0 (exact match).

Why

PR #20704 fixed the SQL Server dashboard REPL failing to launch on Windows (CRLF-corrupted embedded shell script) by invoking /opt/mssql-tools18/bin/sqlcmd directly instead of probing for a client inside a shell script. This is a breaking change for AppHosts pinned to older SQL Server images that only ship /opt/mssql-tools/bin/sqlcmd — they must now opt in explicitly via the new SqlServerReplCommand.Version17 constant. The PR also adds a public SqlServerReplOptions/SqlServerReplCommand API surface and documents a wrapper-script pattern for running work before/after the interactive session.

Triggered signals: container_image_tags_file_changed, integration_readme_changed, new_public_type, pr_body_has_user_facing_section, pr_label_breaking_change.

What changed

Updated src/frontend/src/content/docs/integrations/databases/sql-server/sql-server-host.mdx:

  • Open an interactive REPL: replaced the old "supports both tools18 and tools17" wording with the new direct-invocation behavior (matches SqlServerContainerImageTags.cs and the updated README).
  • New: Select the client executable: documents SqlServerReplOptions.Command, the SqlServerReplCommand.Version17/Version18 constants, and a custom executable path override, with a :::note[Breaking change] callout describing the impact for older pinned images.
  • New: Run a wrapper script: documents the Dockerfile + shell wrapper pattern for running pre/post-session work, including the SQLCMDPASSWORD environment variable and exit-code preservation guidance, copied from the PR's README changes.

All new code samples use synced Tabs/TabItem blocks with syncKey='aspire-lang' (TypeScript first), consistent with the rest of the page.

Files modified

  • src/frontend/src/content/docs/integrations/databases/sql-server/sql-server-host.mdx (updated existing page — no new pages created)

Generated by PR Documentation Check for #20704 · copilot · auto · 74.7 AIC · ⌖ 17.5 AIC · ⊞ 20.3K · ◷

…apper scripts

Documents changes from microsoft/aspire#20704: the REPL now invokes
/opt/mssql-tools18/bin/sqlcmd directly instead of probing for a client,
adds SqlServerReplOptions/SqlServerReplCommand to select Version17 for
older images or a custom executable path, and supports wrapper scripts
that run work before/after the interactive session.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Oct 3, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1822. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1822 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants