# microsoft/mssql-rs architecture

> Architecture diagram of the GitHub repository microsoft/mssql-rs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/microsoft/mssql-rs
- Repository: https://github.com/microsoft/mssql-rs
- Video tour (about a minute): https://gitdiagram.com/microsoft/mssql-rs/video

## Overview

This workspace provides SQL Server connectivity through a shared Rust TDS protocol client and several consumer-facing drivers and integrations. A typical workflow starts in a driver or client API, establishes a connection, sends SQL or parameters over TDS, and exposes returned rows or diagnostics. The graph includes documented ODBC, Python, JavaScript, and sqlcmd capabilities as well as the Rust client. Edges are limited to README statements and source-index references; unsampled implementation details are not treated as verified calls.

Main entry points: [`mssql-tds/src/connection/tds_client.rs`](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/tds_client.rs) (TDS client), [`mssql-rs/src/client.rs`](https://github.com/microsoft/mssql-rs/blob/main/mssql-rs/src/client.rs) (Rust client API), [`mssql-tds/src/connection/transport/network_transport.rs`](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/transport/network_transport.rs) (Network transport), [`mssql-odbc/src/api/odbc_types.rs`](https://github.com/microsoft/mssql-rs/blob/main/mssql-odbc/src/api/odbc_types.rs) (ODBC API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_tds["TDS Protocol"]
  node_tds_client["TDS client<br/>[tds_client.rs]"]
  node_tds_context["Connection context<br/>[client_context.rs]"]
  node_tds_core["Core operations<br/>[core.rs]"]
  node_tds_login["Login options<br/>[login_options.rs]"]
  node_tds_transport["Network transport"]
  node_tds_tls["TLS engines"]
  node_tds_win_tls["Windows TLS<br/>[engine.rs]"]
  node_tds_tokens["Token decoding<br/>[tokens.rs]"]
  node_tds_classification["Data classification"]
end

subgraph group_rust["Rust Driver"]
  node_rust_client["Rust client API<br/>[client.rs]"]
  node_rust_query["Queries and parameters<br/>[query.rs]"]
  node_rust_rows["Rows and conversion<br/>[row.rs]"]
  node_rust_compat["Compatibility API<br/>[compat.rs]"]
end

subgraph group_odbc["ODBC Driver"]
  node_odbc_api["ODBC API<br/>[odbc_types.rs]"]
  node_odbc_connection["ODBC connections<br/>[dbc.rs]"]
  node_odbc_wire["ODBC wire state<br/>[wire.rs]"]
end

subgraph group_bindings["Language Bindings"]
  node_py_bindings["Python extension<br/>[lib.rs]"]
  node_py_pool["Connection pooling<br/>[manager.rs]"]
  node_js_bindings["Node.js bindings<br/>[lib.rs]"]
end

subgraph group_sqlcmd["sqlcmd Integration"]
  node_sqlcmd_ffi["sqlcmd C ABI<br/>[lib.rs]"]
  node_sqlcmd_ingestion["Telemetry ingestion<br/>[ingestion.rs]"]
end

node_developer(("Application developer"))
node_sqlserver[("SQL Server")]

node_developer -->|"uses API"| node_rust_client
node_developer -->|"uses API"| node_odbc_api
node_developer -->|"uses binding"| node_py_bindings
node_developer -->|"uses binding"| node_js_bindings
node_developer -->|"integrates"| node_sqlcmd_ffi
node_rust_client -->|"uses queries"| node_rust_query
node_rust_client -->|"exposes compatibility"| node_rust_compat
node_rust_query -->|"produces rows"| node_rust_rows
node_rust_client -->|"uses TDS"| node_tds_client
node_odbc_api -->|"uses handles"| node_odbc_connection
node_odbc_connection -->|"tracks wire state"| node_odbc_wire
node_odbc_api -->|"uses TDS"| node_tds_client
node_py_bindings -->|"exposes pooling"| node_py_pool
node_py_bindings -->|"provides TDS operations"| node_tds_client
node_js_bindings -->|"binds TDS"| node_tds_client
node_sqlcmd_ffi -->|"ingests telemetry"| node_sqlcmd_ingestion
node_rust_client -->|"queries"| node_sqlserver
node_odbc_api -->|"connects"| node_sqlserver
node_py_bindings -->|"performs TDS operations"| node_sqlserver
node_js_bindings -->|"connects"| node_sqlserver
node_tds_client -->|"configures connection"| node_tds_context
node_tds_client -->|"uses operations"| node_tds_core
node_tds_client -->|"configures login"| node_tds_login
node_tds_transport -->|"transports protocol"| node_tds_client
node_tds_transport -->|"decodes responses"| node_tds_tokens
node_tds_transport -.->|"selects TLS"| node_tds_tls
node_tds_transport -.->|"selects TLS"| node_tds_win_tls
node_tds_tokens -->|"parses metadata"| node_tds_classification

click node_tds_client "https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/tds_client.rs"
click node_tds_context "https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/client_context.rs"
click node_tds_core "https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/core.rs"
click node_tds_login "https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/message/login_options.rs"
click node_tds_transport "https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/transport/network_transport.rs"
click node_tds_tls "https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/transport/tls/network_framework_engine.rs"
click node_tds_win_tls "https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/transport/win_tls/engine.rs"
click node_tds_tokens "https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/token/tokens.rs"
click node_tds_classification "https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/token/data_classification.rs"
click node_rust_client "https://github.com/microsoft/mssql-rs/blob/main/mssql-rs/src/client.rs"
click node_rust_query "https://github.com/microsoft/mssql-rs/blob/main/mssql-rs/src/query.rs"
click node_rust_rows "https://github.com/microsoft/mssql-rs/blob/main/mssql-rs/src/row.rs"
click node_rust_compat "https://github.com/microsoft/mssql-rs/blob/main/mssql-rs/src/compat.rs"
click node_odbc_api "https://github.com/microsoft/mssql-rs/blob/main/mssql-odbc/src/api/odbc_types.rs"
click node_odbc_connection "https://github.com/microsoft/mssql-rs/blob/main/mssql-odbc/src/handles/dbc.rs"
click node_odbc_wire "https://github.com/microsoft/mssql-rs/blob/main/mssql-odbc/src/handles/wire.rs"
click node_py_bindings "https://github.com/microsoft/mssql-rs/blob/main/mssql-py-core/src/lib.rs"
click node_py_pool "https://github.com/microsoft/mssql-rs/blob/main/mssql-py-core/src/pool/manager.rs"
click node_js_bindings "https://github.com/microsoft/mssql-rs/blob/main/mssql-js/src/lib.rs"
click node_sqlcmd_ffi "https://github.com/microsoft/mssql-rs/blob/main/mssql-sqlcmd/src/lib.rs"
click node_sqlcmd_ingestion "https://github.com/microsoft/mssql-rs/blob/main/mssql-sqlcmd/src/ingestion.rs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_tds_client,node_tds_context,node_tds_core,node_tds_login,node_tds_transport,node_tds_tls,node_tds_win_tls,node_tds_tokens,node_tds_classification toneBlue
class node_rust_client,node_rust_query,node_rust_rows,node_rust_compat,node_sqlserver toneAmber
class node_odbc_api,node_odbc_connection,node_odbc_wire toneMint
class node_py_bindings,node_py_pool,node_js_bindings toneRose
class node_sqlcmd_ffi,node_sqlcmd_ingestion,node_developer toneIndigo
```

## Components

### TDS Protocol

- [TDS client](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/tds_client.rs): `mssql-tds/src/connection/tds_client.rs`
- [Connection context](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/client_context.rs): `mssql-tds/src/connection/client_context.rs`
- [Core operations](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/core.rs): `mssql-tds/src/core.rs`
- [Login options](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/message/login_options.rs): `mssql-tds/src/message/login_options.rs`
- [Network transport](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/transport/network_transport.rs): `mssql-tds/src/connection/transport/network_transport.rs`
- [TLS engines](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/transport/tls/network_framework_engine.rs): `mssql-tds/src/connection/transport/tls/network_framework_engine.rs`
- [Windows TLS](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/connection/transport/win_tls/engine.rs): `mssql-tds/src/connection/transport/win_tls/engine.rs`
- [Token decoding](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/token/tokens.rs): `mssql-tds/src/token/tokens.rs`
- [Data classification](https://github.com/microsoft/mssql-rs/blob/main/mssql-tds/src/token/data_classification.rs): `mssql-tds/src/token/data_classification.rs`

### Rust Driver

- [Rust client API](https://github.com/microsoft/mssql-rs/blob/main/mssql-rs/src/client.rs): `mssql-rs/src/client.rs`
- [Queries and parameters](https://github.com/microsoft/mssql-rs/blob/main/mssql-rs/src/query.rs): `mssql-rs/src/query.rs`
- [Rows and conversion](https://github.com/microsoft/mssql-rs/blob/main/mssql-rs/src/row.rs): `mssql-rs/src/row.rs`
- [Compatibility API](https://github.com/microsoft/mssql-rs/blob/main/mssql-rs/src/compat.rs): `mssql-rs/src/compat.rs`

### ODBC Driver

- [ODBC API](https://github.com/microsoft/mssql-rs/blob/main/mssql-odbc/src/api/odbc_types.rs): `mssql-odbc/src/api/odbc_types.rs`
- [ODBC connections](https://github.com/microsoft/mssql-rs/blob/main/mssql-odbc/src/handles/dbc.rs): `mssql-odbc/src/handles/dbc.rs`
- [ODBC wire state](https://github.com/microsoft/mssql-rs/blob/main/mssql-odbc/src/handles/wire.rs): `mssql-odbc/src/handles/wire.rs`

### Language Bindings

- [Python extension](https://github.com/microsoft/mssql-rs/blob/main/mssql-py-core/src/lib.rs): `mssql-py-core/src/lib.rs`
- [Connection pooling](https://github.com/microsoft/mssql-rs/blob/main/mssql-py-core/src/pool/manager.rs): `mssql-py-core/src/pool/manager.rs`
- [Node.js bindings](https://github.com/microsoft/mssql-rs/blob/main/mssql-js/src/lib.rs): `mssql-js/src/lib.rs`

### sqlcmd Integration

- [sqlcmd C ABI](https://github.com/microsoft/mssql-rs/blob/main/mssql-sqlcmd/src/lib.rs): `mssql-sqlcmd/src/lib.rs`
- [Telemetry ingestion](https://github.com/microsoft/mssql-rs/blob/main/mssql-sqlcmd/src/ingestion.rs): `mssql-sqlcmd/src/ingestion.rs`

### Other components

- **Application developer**
- **SQL Server**

## Connections

- Application developer → Rust client API: uses API (evidence: `README.md`)
- Application developer → ODBC API: uses API (evidence: `README.md`)
- Application developer → Python extension: uses binding (evidence: `README.md`)
- Application developer → Node.js bindings: uses binding (evidence: `README.md`)
- Application developer → sqlcmd C ABI: integrates (evidence: `README.md`)
- Rust client API → Queries and parameters: uses queries (evidence: `mssql-rs/src/client.rs`)
- Rust client API → Compatibility API: exposes compatibility (evidence: `mssql-rs/src/client.rs`)
- Queries and parameters → Rows and conversion: produces rows (evidence: `mssql-rs/src/query.rs`)
- Rust client API → TDS client: uses TDS (evidence: `README.md`)
- ODBC API → ODBC connections: uses handles (evidence: `mssql-odbc/src/api/odbc_types.rs`)
- ODBC connections → ODBC wire state: tracks wire state (evidence: `mssql-odbc/src/handles/mod.rs`)
- ODBC API → TDS client: uses TDS (evidence: `README.md`)
- Python extension → Connection pooling: exposes pooling (evidence: `mssql-py-core/src/lib.rs`)
- Python extension → TDS client: provides TDS operations (evidence: `README.md`)
- Node.js bindings → TDS client: binds TDS (evidence: `README.md`)
- sqlcmd C ABI → Telemetry ingestion: ingests telemetry (evidence: `mssql-sqlcmd/src/ingestion.rs`)
- Rust client API → SQL Server: queries (evidence: `README.md`)
- ODBC API → SQL Server: connects (evidence: `README.md`)
- Python extension → SQL Server: performs TDS operations (evidence: `README.md`)
- Node.js bindings → SQL Server: connects (evidence: `README.md`)
- TDS client → Connection context: configures connection (evidence: `mssql-tds/src/connection/client_context.rs`)
- TDS client → Core operations: uses operations (evidence: `mssql-tds/src/connection/client_context.rs`)
- TDS client → Login options: configures login (evidence: `mssql-tds/src/connection/client_context.rs`)
- Network transport → TDS client: transports protocol (evidence: `mssql-tds/src/connection/transport/network_transport.rs`)
- Network transport → Token decoding: decodes responses (evidence: `mssql-tds/src/connection/transport/network_transport.rs`)
- Network transport → TLS engines: selects TLS (evidence: `mssql-tds/src/connection/transport/network_transport.rs`)
- Network transport → Windows TLS: selects TLS (evidence: `mssql-tds/src/connection/transport/win_tls/engine.rs`)
- Token decoding → Data classification: parses metadata
