CHORE: Create devcontainer for repo by saurabh500 · Pull Request #147 · microsoft/mssql-python

Saurabh Singh (saurabh500) · 2025-07-19T06:41:55Z

Devcontainer: Production-Ready Setup for mssql-python Development

Summary

Refactored the devcontainer with battle-tested improvements from local development use. This provides a complete, zero-config development environment for GitHub Codespaces and local devcontainers.

What's New

🏗️ Build & Setup

Auto-builds C++ extension during container setup (fails fast if broken)
Added unixodbc-dev package - fixes sql.h not found compilation errors
Disabled CMake auto-configure to prevent duplicate/conflicting builds
Moved Python package installation from Dockerfile to post-create for faster image rebuilds

🖥️ ARM64 Support

Detects architecture automatically
Uses Azure SQL Edge on ARM64 (Apple Silicon, ARM Codespaces)
Uses SQL Server 2025 on x86_64

🔌 SQL Server Auto-Setup

Starts SQL Server container via Docker-in-Docker
Generates random secure SA password
Sets DB_CONNECTION_STRING environment variable (persisted to /etc/environment, .bashrc, .zshrc)
Non-fatal if Docker fails - devcontainer still works for builds/tests against remote servers

⚡ Developer Experience

Shell aliases work in both bash and zsh:
- build - Rebuild C++ extension
- test - Run pytest
Clean completion message with quick-start commands

Quick Start

Open in Codespaces / "Reopen in Container"
Wait for setup (~4-5 mins)
python main.py - test connection
test - run all tests

Testing

Tested on macOS ARM64 (Apple Silicon)
Tested in GitHub Codespaces

Fixes#146

…n of virtual environment

Saurabh Singh (saurabh500) · 2025-07-19T06:43:02Z

@microsoft-github-policy-service agree company="Microsoft"

Copilot

Pull Request Overview

This pull request establishes a comprehensive Docker-based development environment for the MSSQL Python Driver project using VS Code devcontainer technology. The setup enables developers to quickly spin up a consistent development environment with all necessary dependencies pre-configured.

Creates a complete devcontainer configuration with Python 3.10, Microsoft ODBC drivers, and development tools
Implements automated environment setup through post-creation scripts and Docker configuration
Adds Docker build optimization through comprehensive file exclusion patterns

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 13 comments.

File	Description
`.dockerignore`	Excludes build artifacts, caches, and IDE files from Docker context
`.devcontainer/Dockerfile`	Defines container with Python 3.10, MSSQL drivers, and development tools
`.devcontainer/devcontainer.json`	Configures VS Code settings, extensions, and container features
`.devcontainer/post-create.sh`	Automates post-container setup including dependencies and virtual environment

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Gaurav Sharma (bewithgaurav)

some refactoring & optimization comments

David Levy (dlevy-msft-sql) · 2026-01-19T22:37:38Z

Saurabh Singh (@saurabh500) bumping this because it would be nice to have. Are we close on this PR or is it better to start fresh since it has been a while?

github-actions · 2026-01-19T22:49:26Z

📊 Code Coverage Report

🔥 Diff Coverage 100%	🎯 Overall Coverage 76%	📈 Total Lines Covered:`5472` out of `7137` 📁 Project:`mssql-python`

Diff Coverage

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

No lines with coverage information in this diff.

📋 Files Needing Attention

📉 Files with overall lowest coverage (click to expand)

mssql_python.pybind.logger_bridge.hpp: 58.8%
mssql_python.pybind.logger_bridge.cpp: 59.2%
mssql_python.row.py: 66.2%
mssql_python.pybind.ddbc_bindings.cpp: 69.3%
mssql_python.pybind.ddbc_bindings.h: 69.7%
mssql_python.pybind.connection.connection.cpp: 75.3%
mssql_python.ddbc_bindings.py: 79.6%
mssql_python.pybind.connection.connection_pool.cpp: 79.6%
mssql_python.connection.py: 84.1%
mssql_python.cursor.py: 84.7%

🔗 Quick Links

⚙️ Build Summary	📋 Coverage Details
View Azure DevOps Build	Browse Full Coverage Report

Gaurav Sharma (bewithgaurav) · 2026-02-04T09:04:29Z

I've been using an ubuntu devcontainer for mssql-python since some time now, and have some more improvements to this that we can add here
I'll resolve the comments and add some modifications to this so we can merge this off

cc: Saurabh Singh (@saurabh500)

…, ARM64 support - Add unixodbc-dev package for ODBC headers (fixes sql.h not found) - Move Python package installation from Dockerfile to post-create.sh - Add ARM64 support: use Azure SQL Edge instead of SQL Server 2025 - Make SQL Server container startup non-fatal (optional) - Fix false success reporting when build fails - Disable CMake auto-configure to prevent duplicate builds - Generate random SA password and store connection string

Saurabh Singh (saurabh500) · 2026-02-04T09:40:44Z

Gaurav Sharma (@bewithgaurav) all yours. I haven't had the bandwidth to pick this up.
Since you have been active in this area, you will do better at driving this.

- Add aliases for both bash and zsh - Persist DB_CONNECTION_STRING to /etc/environment and shell rc files - Improve completion message with quick start commands

Tasks 1, 2, 3: Update profiler, add new profiling points, expand benchmarks Phase 1: Core Infrastructure (COMPLETE) - Add performance_counter.hpp with thread-safe RAII profiling - Integrate profiling submodule into ddbc_bindings.cpp - Port run_profiler.py and profiling_results.md from old branch - Support for enable/disable/get_stats/reset via Python API Phase 2: Documentation (COMPLETE) - PROFILER_SUMMARY.md: Executive summary and quick reference - PERF_TIMER_LOCATIONS.md: All 43 timer locations with code snippets - ENHANCED_PROFILING_PLAN.md: New profiling points and benchmarks - PROFILER_UPGRADE_STATUS.md: Status tracker and phases Phase 3: Implementation (TODO) - 43 PERF_TIMER calls need to be added (documented in detail) - New profiling points for types, transactions, pool, memory - Comprehensive benchmark suite (8 new categories) Key Features: - Platform detection (Windows/Linux/macOS) - Per-function timing with min/max/avg - Granular timers for construct_rows bottleneck - Designed for Windows vs Linux performance analysis Reference PR: #147 (original profiler branch) Based on analysis showing 2.3x Linux slowdown (now 16% after optimizations)

Saurabh Singh added 2 commits July 19, 2025 06:00

Dev Container setup
a93e2ff

REFACTOR: Simplify post-create script by removing redundant activatio…
2383b7b
…n of virtual environment

CopilotAI review requested due to automatic review settings July 19, 2025 06:41

CopilotAI reviewed Jul 19, 2025
View reviewed changes

Saurabh Singh (saurabh500) changed the title ~~Create devcontainer for repo~~CHORE: Create devcontainer for repoJul 19, 2025

Saurabh Singh (saurabh500)and others added 7 commits July 18, 2025 23:44

Update .dockerignore
1f50584
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .devcontainer/Dockerfile
6f79cd2
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .dockerignore
1e4c8cc
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .dockerignore
92b1c1f
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .dockerignore
78d129f
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .devcontainer/devcontainer.json
b5e940a
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .devcontainer/devcontainer.json
306ae47
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Saurabh Singh (saurabh500) requested review from ttk (Theekshna), Gaurav Sharma (bewithgaurav), David Levy (dlevy-msft-sql), Jahnvi Thakkar (jahnvi480) and Sumit Sarabhai (sumitmsft)July 19, 2025 18:40

Saurabh Singh (saurabh500)and others added 3 commits July 19, 2025 11:41

Apply suggestions from code review
386b81b
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge branch 'main' into devcontainer
9dd343b

Merge branch 'main' into devcontainer
19f635e

Gaurav Sharma (bewithgaurav) requested changes Jul 24, 2025
View reviewed changes

Comment thread.devcontainer/Dockerfile
Comment thread.devcontainer/Dockerfile Outdated
Comment thread.devcontainer/Dockerfile
Comment thread.dockerignore
Comment thread.dockerignore

Merge branch 'main' into devcontainer
6427ac6

David Levy (dlevy-msft-sql) assigned Saurabh Singh (saurabh500)Jan 31, 2026

David Levy (dlevy-msft-sql) added enhancement New feature or request pr-size: medium Moderate update size under development labels Jan 31, 2026

CHORE: Upgrade to Python 3.14, fix duplicate ODBC, modernize settings
f534e5c

Merge branch 'main' into devcontainer
4ad071d

David Levy (dlevy-msft-sql) previously approved these changes Feb 3, 2026
View reviewed changes

Gaurav Sharma (bewithgaurav) added 2 commits February 4, 2026 14:34

Merge branch 'main' into devcontainer
651f576

Gaurav Sharma (bewithgaurav) dismissed David Levy (dlevy-msft-sql)’s stale review via 37ecdffFebruary 4, 2026 09:30

github-advanced-securityAI found potential problems Feb 4, 2026
View reviewed changes

Comment thread.devcontainer/post-create.sh Fixed

fix(devcontainer): improve shell aliases and connection string setup
33f3611
- Add aliases for both bash and zsh - Persist DB_CONNECTION_STRING to /etc/environment and shell rc files - Improve completion message with quick start commands

github-advanced-securityAI found potential problems Feb 4, 2026
View reviewed changes

Comment thread.devcontainer/post-create.sh Dismissed
Comment thread.devcontainer/post-create.sh Dismissed

David Levy (dlevy-msft-sql) approved these changes Feb 4, 2026
View reviewed changes

Jahnvi Thakkar (jahnvi480) approved these changes Feb 4, 2026
View reviewed changes

Gaurav Sharma (bewithgaurav) approved these changes Feb 4, 2026
View reviewed changes

Gaurav Sharma (bewithgaurav) merged commit f18aee3 into microsoft:mainFeb 4, 2026
25 checks passed

Uh oh!

Conversation

Saurabh Singh (saurabh500) commented Jul 19, 2025• edited by bewithgaurav Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Devcontainer: Production-Ready Setup for mssql-python Development

Summary

What's New

Quick Start

Testing

Uh oh!

Saurabh Singh (saurabh500) commented Jul 19, 2025

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Gaurav Sharma (bewithgaurav) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

David Levy (dlevy-msft-sql) commented Jan 19, 2026

Uh oh!

github-actionsBot commented Jan 19, 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

76%

Diff Coverage

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

📋 Files Needing Attention

🔗 Quick Links

Uh oh!

Gaurav Sharma (bewithgaurav) commented Feb 4, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Saurabh Singh (saurabh500) commented Feb 4, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Saurabh Singh (saurabh500) commented Jul 19, 2025•
edited by bewithgaurav
Loading

github-actionsBot commented Jan 19, 2026•
edited
Loading

Gaurav Sharma (bewithgaurav) commented Feb 4, 2026•
edited
Loading