Ship mssql-odbc driver artifacts with product filenames by gargsaumya · Pull Request #397 · microsoft/mssql-rs

gargsaumya · 2026-08-27T10:37:35Z

Description

Ship the Rust ODBC driver with the exact product basename mssql-odbc across all supported platforms, architectures, build profiles, and Linux flavors.

The shipped artifacts are:

Windows: mssql-odbc.dll
Linux: mssql-odbc.so
macOS: mssql-odbc.dylib

Cargo retains the valid internal library target name mssqlodbc. Platform finalization scripts copy Cargo's canonical output to the product filename before e2e registration or artifact publication. Linux SONAME, macOS install name, and SQL_DRIVER_NAME report the shipped filename.

Microsoft msodbcsql18 package and DLL references used by parity tests remain unchanged.

Related 问题

https://sqlclientdrivers.visualstudio.com/DefaultCollection/mssql-rs/_workitems/edit/47676

Validation

cargo build --release -p mssql-odbc --frozen
Windows debug and release finalizers produce byte-identical mssql-odbc.dll artifacts
cargo nextest run -p mssql-odbc --frozen (873 passed, 1 skipped)
All changed shell and PowerShell scripts pass syntax validation
Generic Linux artifacts exclude Cargo's private filename and publish mssql-odbc.so

Checklist

Copilot

Pull request overview

Renames the Rust ODBC driver artifact basename to mssqlodbc across builds, runtime reporting, tests, documentation, and CI.

Changes:

Renames platform-specific shared libraries and linker metadata.
Updates e2e and pipeline artifact paths.
Updates SQL_DRIVER_NAME, tracing filters, and documentation.

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`scripts/dockerentry/odbc-e2e-rhel.sh`	Updates staged library documentation.
`scripts/dockerentry/odbc-e2e-deb.sh`	Updates staged library documentation.
`scripts/dockerentry/odbc-e2e-azlinux3.sh`	Updates staged library documentation.
`scripts/dockerentry/odbc-e2e-alpine.sh`	Updates staged library documentation.
`scripts/dockerentry/alpine-odbc-build.sh`	Updates build artifact documentation.
`mssql-odbc/tests/e2e/run_e2e.sh`	Resolves renamed Unix artifacts and tracing target.
`mssql-odbc/tests/e2e/run_e2e.ps1`	Resolves the renamed Windows DLL.
`mssql-odbc/tests/e2e/README.md`	Documents renamed e2e artifacts.
`mssql-odbc/tests/e2e/build_e2e.sh`	Stages renamed Unix artifacts.
`mssql-odbc/src/api/get_info.rs`	Reports renamed platform driver files.
`mssql-odbc/src/api/exports.rs`	Updates shared-library documentation.
`mssql-odbc/README.md`	Documents new artifact names and metadata.
`mssql-odbc/plan.md`	Updates planned binary outputs.
`mssql-odbc/Cargo.toml`	Renames the library target.
`mssql-odbc/build.rs`	Renames SONAME and install name metadata.
`.pipeline/templates/test-mssql-python-odbc-template.yml`	Uses the renamed swap-test artifact.
`.pipeline/scripts/swap-mssql-python-odbc-driver.sh`	Updates replacement-driver guidance.
`.pipeline/scripts/containerized-odbc-swap-build.sh`	Stages the renamed swap artifact.
`.pipeline/scripts/containerized-odbc-build.sh`	Updates build artifact documentation.
`.pipeline/scripts/containerized-odbc-build-glibc228.sh`	Updates glibc build documentation.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

github-actions · 2026-08-27T14:07:00Z

📊 Code Coverage Report

🔥 Diff Coverage 100%	🎯 Overall Coverage 92.6%	📦 Project: `mssql-tds + mssql-odbc + mssql-py-core` ℹ️ Note: diff coverage is reported, not enforced.

Diff Coverage

Diff: main...HEAD, staged and unstaged changes

mssql-odbc/src/api/get_info.rs (100%)

Summary

Total: 7 lines
Missing: 0 lines
Coverage: 100%

🔗 Quick Links

View Azure DevOps Build · Coverage Report

David Engel (David-Engel)

Reviewed at 8df33793. I checked the PR out locally, traced every consumer of the old filenames (.pipeline, scripts/dockerentry, tests/e2e, build.rs, get_info.rs), and read the prior threads before writing this.

Summary

Renames the shipped ODBC driver to mssql-odbc.{dll,so,dylib} by keeping Cargo's internal lib target and adding finalize-artifact.{sh,ps1} that copy Cargo's output to the product name before staging or registration. SONAME, install name, SQL_DRIVER_NAME, and docs all follow. No stragglers left behind — the remaining msodbcsql18 references are all the reference driver, which is correct. ADO validation is green, including the cross-repo mssql-python swap suite that actually loads the renamed .so, which is the strongest signal here. Copilot's earlier finding about the vacuous driver_name_writes_wide_string test is genuinely fixed: the test now asserts against hardcoded literals, so reverting the rename breaks it.

No blocking findings. Four suggestions inline, plus notes below.

Notes (no action needed)

The failing coverage-report GitHub check is not this PR. The same workflow failed or was cancelled on two other branches in the same window, and this PR's earlier run succeeded and posted 100% diff / 92.5% overall.
cp leaves both filenames in target/, so cargo llvm-cov picks up the copy as an extra object file. That is already the steady state (Cargo hardlinks the cdylib into both deps/ and the profile root) and the CI coverage numbers held, so no concern.
Dropping the lib prefix on Linux is unconventional but reads as deliberate: unixODBC loads by absolute path from odbcinst.ini, and it removes the old SONAME collision with a genuinely loaded libmsodbcsql-18.4.so.1.1.

One process nit: the cargo btest checklist box is unchecked on a non-draft PR. The Validation section shows a scoped cargo nextest run -p mssql-odbc, which is a reasonable scope for this diff — either run the workspace suite or note that ADO covers it, so the checklist stops disagreeing with itself.

David Engel (David-Engel) · 2026-08-27T16:53:19Z


 [lib]
-name = "msodbcsql18"
+name = "mssqlodbc"


The lib target name is also the tracing target, so this silently changes the log filter from msodbcsql18=debug to mssqlodbc=debug — and EnvFilter ignores unknown targets, so anyone still passing the old value just gets no driver logs rather than an error.

name = "mssql_odbc" is equally valid (only hyphens are rejected), gives the target mssql_odbc — matching the mssql_tds convention used in the docs one line over in the README — and the finalizers just copy libmssql_odbc.so -> mssql-odbc.so instead.

Either way, this env-var change is user-visible and isn't called out in the PR description. Worth a line there.

Saurabh Singh (saurabh500) · 2026-08-27T20:59:19Z

    if [ "$VERBOSE" -eq 1 ]; then
        export MSSQL_TDS_TRACE="${MSSQL_TDS_TRACE:-true}"
-        export MSSQL_TDS_TRACE_LEVEL="${MSSQL_TDS_TRACE_LEVEL:-warn,msodbcsql18=debug}"
+        export MSSQL_TDS_TRACE_LEVEL="${MSSQL_TDS_TRACE_LEVEL:-warn,mssqlodbc=debug}"


I am wondering where mssqlodbc comes from? And why did this not have to change mssql-odbc

I'm wondering if we should just get rid of the dash in mssql-odbc and make the "official" name (library, package, file, etc) "mssqlodbc" to avoid various infra/tool objections to dash or underscore in the name.

Saurabh Singh (@saurabh500) mssqlodbc comes from Cargo’s private [lib] target name. Cargo target names cannot contain a hyphen, and Cargo derives the intermediate library filename and tracing target from that name. The finalization step then converts the Cargo artifact to the product name, so consumers and pipelines receive mssql-odbc.dll, mssql-odbc.so, or mssql-odbc.dylib.

Cargo’s restriction only applies to its private target, the finalization step can still publish the hyphenated product filenames.

Saurabh Singh (@saurabh500) , David Engel (@David-Engel) Would you prefer the official name to remain mssql-odbc, or should we standardize the library, package, files, and tracing target on mssqlodbc?

I have kept the current naming (mssql-odbc) unchanged for now.

I would like everything to be called mssql-odbc :)

If this causes scope creep for the current PR, then do a followup PR, that would be your discretion.

Ahh I didn't read David Engel (@David-Engel)'s comment. You have a point.

gargsaumya, Had a quick sync with David. It is going to be mssqlodbc

No dashes/underscore confusion.
Apologies for the to and fro. But Naming is a hard problem :)

To clarify, this is a relatively "big" change for us, internally, but should avoid future confusion for everyone else. Top level name of "mssql-odbc" becomes just "mssqlodbc", which propagates to library/target/project/binary names. We can consider renaming the mssql-odbc project folder, too. Like I said, potentially disruptive for us but sets us up for a less confusing future.

FYI - ttk (@Theekshna), agree?

FWIW +1 to uniformity, including the project (create) name.

Rename mssql-odbc driver artifacts

417186b

gargsaumya marked this pull request as ready for review August 27, 2026 11:15

gargsaumya requested a review from a team as a code owner August 27, 2026 11:15

Copilot AI balanced review requested due to automatic review settings August 27, 2026 11:15

Copilot started reviewing on behalf of gargsaumya August 27, 2026 11:15 View session

Copilot AI reviewed Aug 27, 2026

View reviewed changes

Comment thread mssql-odbc/src/api/get_info.rs Outdated

Saurabh Singh (saurabh500) reviewed Aug 27, 2026

View reviewed changes

Comment thread .pipeline/scripts/containerized-odbc-build.sh Outdated

Finalize mssql-odbc artifact names

42178bc

gargsaumya changed the title ~~Rename mssql-odbc driver artifacts~~ Ship mssql-odbc driver artifacts with product filenames Aug 27, 2026

gargsaumya marked this pull request as draft August 27, 2026 14:07

gargsaumya added 2 commits August 27, 2026 19:39

Finalize generic Linux build artifacts

6312206

Pin shipped driver names in tests

8df3379

gargsaumya marked this pull request as ready for review August 27, 2026 14:51

David Engel (David-Engel) reviewed Aug 27, 2026

View reviewed changes

Saurabh Singh (saurabh500) approved these changes Aug 27, 2026

View reviewed changes

Uh oh!

Conversation

gargsaumya commented Aug 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related 问题

Validation

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Aug 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Code Coverage Report

🔥 Diff Coverage

100%

🎯 Overall Coverage

92.6%

Diff Coverage

Diff: main...HEAD, staged and unstaged changes

Summary

🔗 Quick Links

Uh oh!

David Engel (David-Engel) left a comment

Choose a reason for hiding this comment

Summary

Notes (no action needed)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

标签

项目

Milestone

Development

Uh oh!

4 participants

gargsaumya commented Aug 27, 2026 •

edited

Loading

github-actions Bot commented Aug 27, 2026 •

edited

Loading