• Stars
    star
    972
  • Rank 46,179 (Top 1.0 %)
  • Language
    Java
  • License
    MIT License
  • Created almost 8 years ago
  • Updated 11 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The Microsoft JDBC Driver for SQL Server is a Type 4 JDBC driver that provides database connectivity with SQL Server through the standard JDBC application program interfaces (APIs).

GitHub license Maven Central Javadocs Gitter

Microsoft JDBC Driver for SQL Server

Welcome to the Microsoft JDBC Driver for SQL Server project!

The Microsoft JDBC Driver for SQL Server is a Type 4 JDBC driver that provides database connectivity through the standard JDBC application program interfaces (APIs) available in the Java Platform, Enterprise Editions. The Driver provides access to Microsoft SQL Server and Azure SQL Database from any Java application, application server, or Java-enabled applet.

Releases can be found on the GitHub Releases page, in the Microsoft JDBC Documentation, or via Maven. Starting from preview release 12.1.0, each release contains two versions of the driver. One for use with Java 8 (jre8), and one for use with version Java 11 and above (jre11).

We hope you enjoy using the Microsoft JDBC Driver for SQL Server.

Microsoft JDBC driver for SQL Server Team

Take our survey

Let us know how you think we're doing.

Status of Most Recent Builds

Azure Pipelines (Windows) Azure Pipelines (Linux) Azure Pipelines (MacOS)
Build Status Build Status Build Status

Announcements

What's coming next? We will look into adding a more comprehensive set of tests, improving our javadocs, and start developing the next set of features.

Get Started

Getting started with SQL Server and Java

Build

Prerequisites

  • Java 11+
  • Maven 3.5.0+
  • An instance of SQL Server or Azure SQL Database that you can connect to.

Build the JAR files

Maven builds automatically trigger a set of verification tests to run. For these tests to pass, you will first need to add an environment variable in your system called mssql_jdbc_test_connection_properties to provide the correct connection properties for your SQL Server or Azure SQL Database instance.

To build the jar files, you must use minimum version of Java 11 with Maven. You may choose to build JDBC 4.3 compliant jar file (for use with JRE 11 or newer JRE versions) and/or a JDBC 4.2 compliant jar file (for use with JRE 8).

  • Maven:

    1. If you have not already done so, add the environment variable mssql_jdbc_test_connection_properties in your system with the connection properties for your SQL Server or SQL DB instance.
    2. Run one of the commands below to build a JRE 11 and newer versions compatible jar or JRE 8 compatible jar in the \target directory.
      • Run mvn install -Pjre21. This creates JRE 21 compatible jar in \target directory which is JDBC 4.3 compliant (Build with JDK 21).
      • Run mvn install -Pjre17. This creates JRE 17 compatible jar in \target directory which is JDBC 4.3 compliant (Build with JDK 17+).
      • Run mvn install -Pjre11. This creates JRE 11 compatible jar in \target directory which is JDBC 4.3 compliant (Build with JDK 11+).
      • Run mvn install -Pjre8. This creates JRE 8 compatible jar in \target directory which is JDBC 4.2 compliant (Build with JDK 11+).
  • Gradle:

    1. If you have not already done so, add the environment variable mssql_jdbc_test_connection_properties in your system with the connection properties for your SQL Server or SQL DB instance.
    2. Run one of the commands below to build a JRE 11 and newer versions compatible jar or JRE 8 compatible jar in the \build\libs directory.
      • Run gradle build -PbuildProfile=jre21. This creates JRE 21 compatible jar in \build\libs directory which is JDBC 4.3 compliant (Build with JDK 21).
      • Run gradle build -PbuildProfile=jre17. This creates JRE 17 compatible jar in \build\libs directory which is JDBC 4.3 compliant (Build with JDK 17+).
      • Run gradle build -PbuildProfile=jre11. This creates JRE 11 compatible jar in \build\libs directory which is JDBC 4.3 compliant (Build with JDK 11+).
      • Run gradle build -PbuildProfile=jre8. This creates JRE 8 compatible jar in \build\libs directory which is JDBC 4.2 compliant (Build with JDK 11+).

Resources

Documentation

API reference documentation is available in Javadocs.

This driver is documented on Microsoft Docs.

Sample Code

For samples, please see the src\sample directory.

Download the DLLs

For some features (e.g. Integrated Authentication and Distributed Transactions), you may need to use the sqljdbc_xa and mssql-jdbc_auth-<version>.<arch> DLLs. They can be found in the package that can be downloaded from Microsoft. mssql-jdbc_auth-<version>.<arch> can also be downloaded from Maven.

Download the driver

Don't want to compile anything?

We're now on the Maven Central Repository. Add the following to your POM file to get the most stable release:

<dependency>
	<groupId>com.microsoft.sqlserver</groupId>
	<artifactId>mssql-jdbc</artifactId>
	<version>12.6.0.jre11</version>
</dependency>

The driver can be downloaded from Microsoft. For driver version 12.1.0 and greater, please use the jre11 version when using Java 11 or greater, and the jre8 version when using Java 8.

To get the latest version of the driver, add the following to your POM file:

<dependency>
	<groupId>com.microsoft.sqlserver</groupId>
	<artifactId>mssql-jdbc</artifactId>
	<version>12.6.0.jre11</version>
</dependency>

Using driver as Java Module

Starting from version 7.0.0, the driver Jars (jre10 and above) will expose 'Automatic-Module' as 'com.microsoft.sqlserver.jdbc'. The supporting Jar can now be added to ModulePath to access this module.

Dependencies

This project has following dependencies:

Compile Time:

  • com.azure:azure-security-keyvault-keys : Microsoft Azure Client Library For KeyVault Keys (optional)
  • com.azure:azure-identity : Microsoft Azure Client Library For Identity (optional)
  • org.bouncycastle:bcprov-jdk18on : Bouncy Castle Provider for Always Encrypted with secure enclaves feature with JAVA 8 only (optional)
  • com.google.code.gson:gson : Gson for Always Encrypted with secure enclaves feature (optional)

Test Time:

  • junit:jar : For Unit Test cases.

Dependency Tree

One can see all dependencies including Transitive Dependency by executing following command.

mvn dependency:tree

Azure Key Vault and Azure Active Directory Authentication Dependencies

Projects that require either of the two features need to explicitly declare the dependency in their pom file.

For Example: If you are using Azure Active Directory Authentication feature then you need to declare the azure-identity dependency in your project's POM file. Please see the following snippet:

<dependency>
	<groupId>com.microsoft.sqlserver</groupId>
	<artifactId>mssql-jdbc</artifactId>
	<version>12.6.0.jre11</version>
	<scope>compile</scope>
</dependency>

<dependency>
	<groupId>com.azure</groupId>
	<artifactId>azure-identity</artifactId>
	<version>1.3.3</version>
</dependency>

For Example: If you are using Azure Key Vault feature then you need to declare the azure-identity and azure-security-keyvault-keys dependencies in your project's POM file. Please see the following snippet:

<dependency>
	<groupId>com.microsoft.sqlserver</groupId>
	<artifactId>mssql-jdbc</artifactId>
	<version>12.6.0.jre11</version>
	<scope>compile</scope>
</dependency>

<dependency>
	<groupId>com.azure</groupId>
	<artifactId>azure-identity</artifactId>
	<version>1.3.3</version>
</dependency>

<dependency>
	<groupId>com.azure</groupId>
	<artifactId>azure-security-keyvault-keys</artifactId>
	<version>4.2.8</version>
</dependency>

Please note as of the v6.2.2, the way to construct a SQLServerColumnEncryptionAzureKeyVaultProvider object has changed. Please refer to this Wiki page for more information.

'useFmtOnly' connection property Dependencies

When setting 'useFmtOnly' property to 'true' for establishing a connection or creating a prepared statement, antlr-runtime dependency is required to be added in your project's POM file. Please see the following snippet:

<dependency>
	<groupId>com.microsoft.sqlserver</groupId>
	<artifactId>mssql-jdbc</artifactId>
	<version>12.6.0.jre11</version>
</dependency>

<dependency>
	<groupId>org.antlr</groupId>
	<artifactId>antlr4-runtime</artifactId>
	<version>4.9.2</version>
</dependency>

Guidelines for Creating Pull Requests

We love contributions from the community. To help improve the quality of our code, we encourage you to use the mssql-jdbc_formatter.xml formatter provided on all pull requests.

Thank you!

Guidelines for Reporting Issues

We appreciate you taking the time to test the driver, provide feedback and report any issues. It would be extremely helpful if you:

  • Report each issue as a new issue (but check first if it's already been reported)
  • Try to be detailed in your report. Useful information for good bug reports include:
    • What you are seeing and what the expected behavior is
    • Which jar file?
    • Environment details: e.g. Java version, client operating system?
    • Table schema (for some issues the data types make a big difference!)
    • Any other relevant information you want to share
  • Try to include a Java sample demonstrating the isolated problem.

Thank you!

Reporting security issues and security bugs

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) [email protected]. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

Release roadmap and standards

Our goal is to release regular updates which improve the driver and bring new features to users. Stable, production quality releases happen twice a year, targeting the first and third quarters of the calendar year. They are tested against a comprehensive matrix of supported operating systems, Java versions, and SQL Server versions. Stable releases are accompanied by additional localized packages, which are available on the Microsoft website.

Preview releases happen approximately monthly between stable releases. This gives users an opportunity to try out new features and provide feedback on them before they go into stable releases. Preview releases also include frequent bug fixes for customers to verify without having to wait for a stable release. Preview releases are only available in English. While they are tested, preview releases do not necessarily go through the same rigorous, full test matrix and review process as stable releases.

You can see what is going into a future release by monitoring Milestones in the repository.

Version conventions

Starting with 6.0, stable versions have an even minor version. For example, 6.0, 6.2, 6.4, 7.0, 7.2, 7.4, 8.2, 8.4, 9.2, 9.4, 10.2, 11.2, 12.2, 12.4, 12.6. Preview versions have an odd minor version. For example, 6.1, 6.3, 6.5, 7.1, 7.3, 8.1, 9.1, 10.1, 11.1, 12.1, 12.3, 12.5, and so on.

Contributors

Special thanks to everyone who has contributed to the project.

Up-to-date list of contributors: https://github.com/Microsoft/mssql-jdbc/graphs/contributors

Here are our Top 15 contributors from the community:

  • pierresouchay (Pierre Souchay)
  • marschall (Philippe Marschall)
  • JamieMagee (Jamie Magee)
  • sehrope (Sehrope Sarkuni)
  • gordthompson (Gord Thompson)
  • simon04 (Simon Legner)
  • gstojsic
  • cosmofrit
  • mmimica (Milan Mimica)
  • harawata (Iwao AVE!)
  • rPraml (Roland Praml)
  • laeubi (Christoph Laubrich)
  • worldtiki (Daniel Albuquerque)
  • shayaantx
  • mnhubspot

License

The Microsoft JDBC Driver for SQL Server is licensed under the MIT license. See the LICENSE file for more details.

Code of conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

More Repositories

1

vscode

Visual Studio Code
TypeScript
157,226
star
2

PowerToys

Windows system utilities to maximize productivity
C#
107,200
star
3

TypeScript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TypeScript
98,425
star
4

terminal

The new Windows Terminal and the original Windows console host, all in the same place!
C++
94,001
star
5

Web-Dev-For-Beginners

24 Lessons, 12 Weeks, Get Started as a Web Developer
JavaScript
82,315
star
6

ML-For-Beginners

12 weeks, 26 lessons, 52 quizzes, classic Machine Learning for all
HTML
68,404
star
7

playwright

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript
64,013
star
8

generative-ai-for-beginners

18 Lessons, Get Started Building with Generative AI 🔗 https://microsoft.github.io/generative-ai-for-beginners/
Jupyter Notebook
57,196
star
9

monaco-editor

A browser based code editor
JavaScript
35,437
star
10

AI-For-Beginners

12 Weeks, 24 Lessons, AI for All!
Jupyter Notebook
33,331
star
11

MS-DOS

The original sources of MS-DOS 1.25, 2.0, and 4.0 for reference purposes
Assembly
28,654
star
12

autogen

A programming framework for agentic AI. Discord: https://aka.ms/autogen-dc. Roadmap: https://aka.ms/autogen-roadmap
Jupyter Notebook
28,601
star
13

calculator

Windows Calculator: A simple yet powerful calculator that ships with Windows
C++
27,371
star
14

Data-Science-For-Beginners

10 Weeks, 20 Lessons, Data Science for All!
Jupyter Notebook
27,299
star
15

DeepSpeed

DeepSpeed is a deep learning optimization library that makes distributed training and inference easy, efficient, and effective.
Python
26,923
star
16

cascadia-code

This is a fun, new monospaced font that includes programming ligatures and is designed to enhance the modern look and feel of the Windows Terminal.
Python
25,098
star
17

JARVIS

JARVIS, a system to connect LLMs with ML community. Paper: https://arxiv.org/pdf/2303.17580.pdf
Python
23,217
star
18

api-guidelines

Microsoft REST API Guidelines
22,486
star
19

winget-cli

WinGet is the Windows Package Manager. This project includes a CLI (Command Line Interface), PowerShell modules, and a COM (Component Object Model) API (Application Programming Interface).
C++
20,495
star
20

vcpkg

C++ Library Manager for Windows, Linux, and MacOS
CMake
19,600
star
21

unilm

Large-scale Self-supervised Pre-training Across Tasks, Languages, and Modalities
Python
19,204
star
22

fluentui

Fluent UI web represents a collection of utilities, React components, and web components for building web applications.
TypeScript
18,098
star
23

semantic-kernel

Integrate cutting-edge LLM technology quickly and easily into your apps
C#
17,792
star
24

CNTK

Microsoft Cognitive Toolkit (CNTK), an open source deep-learning toolkit
C++
17,412
star
25

WSL

Issues found on WSL
PowerShell
17,022
star
26

LightGBM

A fast, distributed, high performance gradient boosting (GBT, GBDT, GBRT, GBM or MART) framework based on decision tree algorithms, used for ranking, classification and many other machine learning tasks.
C++
16,155
star
27

react-native-windows

A framework for building native Windows apps with React.
C++
16,120
star
28

recommenders

Best Practices on Recommendation Systems
Python
16,075
star
29

AirSim

Open source simulator for autonomous vehicles built on Unreal Engine / Unity, from Microsoft AI & Research
C++
16,070
star
30

IoT-For-Beginners

12 Weeks, 24 Lessons, IoT for All!
C++
15,013
star
31

qlib

Qlib is an AI-oriented quantitative investment platform that aims to realize the potential, empower research, and create value using AI technologies in quantitative investment, from exploring ideas to implementing productions. Qlib supports diverse machine learning modeling paradigms. including supervised learning, market dynamics modeling, and RL.
Python
14,573
star
32

dotnet

This repo is the official home of .NET on GitHub. It's a great starting point to find many .NET OSS projects from Microsoft and the community, including many that are part of the .NET Foundation.
HTML
14,256
star
33

Bringing-Old-Photos-Back-to-Life

Bringing Old Photo Back to Life (CVPR 2020 oral)
Python
14,132
star
34

ai-edu

AI education materials for Chinese students, teachers and IT professionals.
HTML
13,297
star
35

nni

An open source AutoML toolkit for automate machine learning lifecycle, including feature engineering, neural architecture search, model compression and hyper-parameter tuning.
Python
13,084
star
36

pyright

Static Type Checker for Python
Python
12,424
star
37

guidance

A guidance language for controlling large language models.
Jupyter Notebook
11,777
star
38

TypeScript-Node-Starter

A reference example for TypeScript and Node with a detailed README describing how to use the two together.
SCSS
11,282
star
39

Swin-Transformer

This is an official implementation for "Swin Transformer: Hierarchical Vision Transformer using Shifted Windows".
Python
11,187
star
40

TypeScript-React-Starter

A starter template for TypeScript and React with a detailed README describing how to use the two together.
TypeScript
11,081
star
41

frontend-bootcamp

Frontend Workshop from HTML/CSS/JS to TypeScript/React/Redux
TypeScript
10,795
star
42

windows-rs

Rust for Windows
Rust
10,135
star
43

language-server-protocol

Defines a common protocol for language servers.
HTML
10,093
star
44

onnxruntime

ONNX Runtime: cross-platform, high performance ML inferencing and training accelerator
C++
9,837
star
45

wslg

Enabling the Windows Subsystem for Linux to include support for Wayland and X server related scenarios
C++
9,803
star
46

sql-server-samples

Azure Data SQL Samples - Official Microsoft GitHub Repository containing code samples for SQL Server, Azure SQL, Azure Synapse, and Azure SQL Edge
9,713
star
47

mimalloc

mimalloc is a compact general purpose allocator with excellent performance.
C
9,505
star
48

computervision-recipes

Best Practices, code samples, and documentation for Computer Vision.
Jupyter Notebook
9,264
star
49

napajs

Napa.js: a multi-threaded JavaScript runtime
C++
9,256
star
50

Windows-universal-samples

API samples for the Universal Windows Platform.
JavaScript
9,253
star
51

fast

The adaptive interface system for modern web experiences.
TypeScript
9,167
star
52

LoRA

Code for loralib, an implementation of "LoRA: Low-Rank Adaptation of Large Language Models"
Python
9,145
star
53

vscode-tips-and-tricks

Collection of helpful tips and tricks for VS Code.
9,038
star
54

playwright-python

Python version of the Playwright testing and automation library.
Python
8,990
star
55

STL

MSVC's implementation of the C++ Standard Library.
C++
8,978
star
56

fluentui-emoji

A collection of familiar, friendly, and modern emoji from Microsoft
Python
8,843
star
57

react-native-code-push

React Native module for CodePush
C
8,643
star
58

vscode-extension-samples

Sample code illustrating the VS Code extension API.
TypeScript
8,350
star
59

reactxp

Library for cross-platform app development.
TypeScript
8,294
star
60

inshellisense

IDE style command line auto complete
TypeScript
8,233
star
61

reverse-proxy

A toolkit for developing high-performance HTTP reverse proxy applications.
C#
8,190
star
62

WSL2-Linux-Kernel

The source for the Linux kernel used in Windows Subsystem for Linux 2 (WSL2)
C
7,815
star
63

ailab

Experience, Learn and Code the latest breakthrough innovations with Microsoft AI
C#
7,664
star
64

c9-python-getting-started

Sample code for Channel 9 Python for Beginners course
Jupyter Notebook
7,642
star
65

cpprestsdk

The C++ REST SDK is a Microsoft project for cloud-based client-server communication in native code using a modern asynchronous C++ API design. This project aims to help C++ developers connect to and interact with services.
C++
7,573
star
66

botframework-sdk

Bot Framework provides the most comprehensive experience for building conversation applications.
JavaScript
7,422
star
67

azuredatastudio

Azure Data Studio is a data management and development tool with connectivity to popular cloud and on-premises databases. Azure Data Studio supports Windows, macOS, and Linux, with immediate capability to connect to Azure SQL and SQL Server. Browse the extension library for more database support options including MySQL, PostreSQL, and MongoDB.
TypeScript
7,182
star
68

winget-pkgs

The Microsoft community Windows Package Manager manifest repository
6,981
star
69

Windows-driver-samples

This repo contains driver samples prepared for use with Microsoft Visual Studio and the Windows Driver Kit (WDK). It contains both Universal Windows Driver and desktop-only driver samples.
C
6,756
star
70

UFO

A UI-Focused Agent for Windows OS Interaction.
Python
6,522
star
71

winfile

Original Windows File Manager (winfile) with enhancements
C
6,437
star
72

nlp-recipes

Natural Language Processing Best Practices & Examples
Python
6,340
star
73

WinObjC

Objective-C for Windows
C
6,237
star
74

SandDance

Visually explore, understand, and present your data.
TypeScript
6,091
star
75

GSL

Guidelines Support Library
C++
5,957
star
76

VFSForGit

Virtual File System for Git: Enable Git at Enterprise Scale
C#
5,952
star
77

MixedRealityToolkit-Unity

This repository is for the legacy Mixed Reality Toolkit (MRTK) v2. For the latest version of the MRTK please visit https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity
C#
5,943
star
78

vscode-go

An extension for VS Code which provides support for the Go language. We have moved to https://github.com/golang/vscode-go
TypeScript
5,928
star
79

microsoft-ui-xaml

Windows UI Library: the latest Windows 10 native controls and Fluent styles for your applications
5,861
star
80

vscode-recipes

JavaScript
5,826
star
81

MMdnn

MMdnn is a set of tools to help users inter-operate among different deep learning frameworks. E.g. model conversion and visualization. Convert models between Caffe, Keras, MXNet, Tensorflow, CNTK, PyTorch Onnx and CoreML.
Python
5,783
star
82

rushstack

Monorepo for tools developed by the Rush Stack community
TypeScript
5,727
star
83

fluentui-system-icons

Fluent System Icons are a collection of familiar, friendly and modern icons from Microsoft.
HTML
5,647
star
84

ethr

Ethr is a Comprehensive Network Measurement Tool for TCP, UDP & ICMP.
Go
5,642
star
85

FASTER

Fast persistent recoverable log and key-value store + cache, in C# and C++.
C#
5,630
star
86

vscode-docs

Public documentation for Visual Studio Code
Markdown
5,549
star
87

DirectX-Graphics-Samples

This repo contains the DirectX Graphics samples that demonstrate how to build graphics intensive applications on Windows.
C++
5,440
star
88

vscode-cpptools

Official repository for the Microsoft C/C++ extension for VS Code.
TypeScript
5,396
star
89

BosqueLanguage

The Bosque programming language is an experiment in regularized design for a machine assisted rapid and reliable software development lifecycle.
TypeScript
5,282
star
90

promptbase

All things prompt engineering
Python
5,225
star
91

DeepSpeedExamples

Example models using DeepSpeed
Python
5,092
star
92

TaskWeaver

A code-first agent framework for seamlessly planning and executing data analytics tasks.
Python
5,008
star
93

SynapseML

Simple and Distributed Machine Learning
Scala
4,999
star
94

Detours

Detours is a software package for monitoring and instrumenting API calls on Windows. It is distributed in source code form.
C++
4,979
star
95

tsyringe

Lightweight dependency injection container for JavaScript/TypeScript
TypeScript
4,935
star
96

Windows-classic-samples

This repo contains samples that demonstrate the API used in Windows classic desktop applications.
4,926
star
97

TypeScript-Handbook

Deprecated, please use the TypeScript-Website repo instead
JavaScript
4,882
star
98

sudo

It's sudo, for Windows
Rust
4,800
star
99

vscode-dev-containers

NOTE: Most of the contents of this repository have been migrated to the new devcontainers GitHub org (https://github.com/devcontainers). See https://github.com/devcontainers/template-starter and https://github.com/devcontainers/feature-starter for information on creating your own!
Shell
4,696
star
100

tsdoc

A doc comment standard for TypeScript
TypeScript
4,662
star