Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/r2dbc/r2dbc-mssql

R2DBC Driver for Microsoft SQL Server using TDS (Tabular Data Stream) Protocol
https://github.com/r2dbc/r2dbc-mssql
azure-sql-server microsoft-sql-server non-blocking r2dbc reactive tds
Last synced: 11 days ago
JSON representation
R2DBC Driver for Microsoft SQL Server using TDS (Tabular Data Stream) Protocol
Host: GitHub
URL: https://github.com/r2dbc/r2dbc-mssql
Owner: r2dbc
License: apache-2.0
Created: 2018-10-19T16:04:58.000Z (about 6 years ago)
Default Branch: main
Last Pushed: 2024-10-02T09:03:54.000Z (about 1 month ago)
Last Synced: 2024-10-13T07:22:32.274Z (28 days ago)
Topics: azure-sql-server, microsoft-sql-server, non-blocking, r2dbc, reactive, tds
Language: Java
Homepage:
Size: 1.88 MB
Stars: 183
Watchers: 14
Forks: 32
Open Issues: 28
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project

README

        # Reactive Relational Database Connectivity Microsoft SQL Server Implementation [![Java CI with Maven](https://github.com/r2dbc/r2dbc-mssql/workflows/Java%20CI%20with%20Maven/badge.svg?branch=main)](https://github.com/r2dbc/r2dbc-mssql/actions?query=workflow%3A%22Java+CI+with+Maven%22+branch%3Amain) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.r2dbc/r2dbc-mssql/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.r2dbc/r2dbc-mssql)

 

This project contains the [Microsoft SQL Server][m] implementation of the [R2DBC SPI][r]. This implementation is not intended to be used directly, but rather to be used as the backing implementation for a humane client library to delegate to

[m]: https://microsoft.com/sqlserver

[r]: https://github.com/r2dbc/r2dbc-spi

This driver provides the following features:

* Complies with R2DBC 1.0

* Login with username/password with temporary SSL encryption

* Full SSL encryption support (for e.g. Azure usage).

* Transaction Control

* Simple execution of SQL batches (direct and cursored execution)

* Execution of parametrized statements (direct and cursored execution)

* Extensive type support (including `TEXT`, `VARCHAR(MAX)`, `IMAGE`, `VARBINARY(MAX)` and national variants, see below for exceptions)

* Execution of stored procedures

Next steps:

* Add support for TVP and UDTs

## Code of Conduct

This project is governed by the [R2DBC Code of Conduct](https://github.com/r2dbc/.github/blob/main/CODE_OF_CONDUCT.adoc). By participating, you are expected to uphold this code of conduct. Please

report unacceptable behavior to [[email protected]](mailto:[email protected]).

## Getting Started

Here is a quick teaser of how to use R2DBC MSSQL in Java:

**URL Connection Factory Discovery**

```java

ConnectionFactory connectionFactory = ConnectionFactories.get("r2dbc:mssql://:1433/");

Publisher extends Connection> connectionPublisher = connectionFactory.create();

```

**Programmatic Connection Factory Discovery**

```java

ConnectionFactoryOptions options = builder()

    .option(DRIVER, "sqlserver")

    .option(HOST, "…")

    .option(PORT, …)  // optional, defaults to 1433

    .option(USER, "…")

    .option(PASSWORD, "…")

    .option(DATABASE, "…") // optional

    .option(SSL, true) // optional, defaults to false

    .option(Option.valueOf("applicationName"), "…") // optional

    .option(Option.valueOf("preferCursoredExecution"), true/false) // optional

    .option(Option.valueOf("connectionId"), new UUID(…)) // optional

    .build();

ConnectionFactory connectionFactory = ConnectionFactories.get(options);

Publisher extends Connection> connectionPublisher = connectionFactory.create();

// Alternative: Creating a Mono using Project Reactor

Mono connectionMono = Mono.from(connectionFactory.create());

```

**Supported ConnectionFactory Discovery Options**

| Option            | Description

| ----------------- | -----------

| `ssl`             | Whether to use transport-level encryption for the entire SQL server traffic.

| `driver`          | Must be `sqlserver`.

| `host`            | Server hostname to connect to.

| `port`            | Server port to connect to. Defaults to `1433`. _(Optional)_

| `username`        | Login username.

| `password`        | Login password.

| `database`        | Initial database to select. Defaults to SQL Server user profile settings. _(Optional)_

| `applicationName` | Name of the application. Defaults to driver name and version. _(Optional)_

| `connectionId`    | Connection Id for tracing purposes. Defaults to a random Id. _(Optional)_

| `connectTimeout`  | Connection Id for tracing purposes. Defaults to 30 seconds. _(Optional)_

| `hostNameInCertificate` | Expected hostname in SSL certificate. Supports wildcards (e.g. `*.database.windows.net`). _(Optional)_

| `lockWaitTimeout` | Lock wait timeout using `SET LOCK_TIMEOUT …`. _(Optional)_

| `preferCursoredExecution` | Whether to prefer cursors  or direct execution for queries. Uses by default direct. Cursors require more round-trips but are more backpressure-friendly. Defaults to direct execution. Can be `boolean` or a `Predicate` accepting the SQL query. _(Optional)_

| `sendStringParametersAsUnicode` | Configure whether to send character data as unicode (NVARCHAR, NCHAR, NTEXT) or whether to use the database encoding, defaults to `true`. If disabled, `CharSequence` data is sent using the database-specific collation such as ASCII/MBCS instead of Unicode.

| `sslTunnel`       | Enables SSL tunnel usage when using a SSL tunnel or SSL terminator in front of SQL Server. Accepts `Function` to customize the SSL tunnel settings. SSL tunneling is not related to SQL Server's built-in SSL support. _(Optional)_

| `sslContextBuilderCustomizer`  | SSL Context customizer to configure SQL Server's built-in SSL support (`Function`) _(Optional)_

| `tcpKeepAlive`    | Enable/disable TCP KeepAlive. Disabled by default. _(Optional)_

| `tcpNoDelay`      | Enable/disable TCP NoDelay. Enabled by default. _(Optional)_

| `trustServerCertificate` | Fully trust the server certificate bypassing X.509 certificate validation. Disabled by default. _(Optional)_

| `trustStoreType`  | Type of the TrustStore. Defaults to `KeyStore.getDefaultType()`. _(Optional)_

| `trustStore`      | Path to the certificate TrustStore file. _(Optional)_

| `trustStorePassword` | Password used to check the integrity of the TrustStore data. _(Optional)_

**Programmatic Configuration**

```java

MssqlConnectionConfiguration configuration = MssqlConnectionConfiguration.builder()

    .host("…")

    .username("…")

    .password("…")

    .database("…")

    .preferCursoredExecution(…)

    .build();

MssqlConnectionFactory factory = new MssqlConnectionFactory(configuration);

Mono connectionMono = factory.create();

```

Microsoft SQL Server uses named parameters that are prefixed with `@`. The following SQL statement makes use of parameters:

```sql

INSERT INTO person (id, first_name, last_name) VALUES(@id, @firstname, @lastname)

```

Parameters are referenced without the `@` prefix when binding these:

```java

connection.createStatement("INSERT INTO person (id, first_name, last_name) VALUES(@id, @firstname, @lastname)")

            .bind("id", 1)

            .bind("firstname", "Walter")

            .bind("lastname", "White")

            .execute()

``` 

Binding also allows positional index (zero-based) references. The parameter index is derived from the parameter discovery order when parsing the query.

### Maven configuration

Artifacts can be found on [Maven Central](https://search.maven.org/search?q=r2dbc-mssql).

```xml

  io.r2dbc

  r2dbc-mssql

  ${version}

```

If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.

```xml

  io.r2dbc

  r2dbc-mssql

  ${version}.BUILD-SNAPSHOT

sonatype-nexus-snapshots

Sonatype OSS Snapshot Repository

https://oss.sonatype.org/content/repositories/snapshots

``` 

## Transaction Definitions

SQL Server supports additional options when starting a transaction. In particular, the following options can be specified:

* Isolation Level (`isolationLevel`) (reset after the transaction to previous value)

* Transaction Name (`name`)

* Transaction Log Mark (`mark`)

* Lock Wait Timeout (`lockWaitTimeout`) (reset after the transaction to `-1`)

These options can be specified upon transaction begin to start the transaction and apply options in a single command roundtrip:

```java

MssqlConnection connection= …;

        connection.beginTransaction(MssqlTransactionDefinition.from(IsolationLevel.READ_UNCOMMITTED)

        .name("my-transaction").mark("tx-log-mark")

        .lockTimeout(Duration.ofMinutes(1)));

```

See also: https://docs.microsoft.com/en-us/sql/t-sql/language-elements/begin-transaction-transact-sql

### Data Type Mapping

This reference table shows the type mapping between [Microsoft SQL Server][m] and Java data types:

| Microsoft SQL Server Type 
|:----------------------------- 
| [`bit`][sql-bit-ref] 
| [`tinyint`][sql-all-int-ref] 
| [`smallint`][sql-all-int-ref] 
| [`int`][sql-all-int-ref] 
| [`bigint`][sql-all-int-ref] 
| [`real`][sql-float-real-ref] 
| [`float`][sql-float-real-ref] 
| [`decimal`][sql-decimal-ref] 
| [`numeric`][sql-decimal-ref] 
| [`uniqueidentifier`][sql-uid-ref] 
| [`smalldatetime`][sql-smalldatetime-ref] 
| [`datetime`][sql-datetime-ref] 
| [`datetime2`][sql-datetime2-ref] 
| [`date`][sql-date-ref] 
| [`time`][sql-time-ref] 
| [`datetimeoffset`][sql-dtof-ref] 
| [`timestamp`][sql-timestamp-ref] 
| [`smallmoney`][sql-money-ref] 
| [`money`][sql-money-ref] 
| [`char`][sql-(var)char-ref] 
| [`varchar`][sql-(var)char-ref] 
| [`varcharmax`][sql-(var)char-ref] 
| [`nchar`][sql-n(var)char-ref] 
| [`nvarchar`][sql-n(var)char-ref] 
| [`nvarcharmax`][sql-n(var)char-ref] 
| [`text`][sql-(n)text-ref] 
| [`ntext`][sql-(n)text-ref] 
| [`image`][sql-(n)text-ref] 
| [`binary`][sql-binary-ref] 
| [`varbinary`][sql-binary-ref] 
| [`varbinarymax`][sql-binary-ref] 
| [`sql_variant`][sql-sql-variant-ref] 
| [`xml`][sql-xml-ref] 
| [`udt`][sql-udt-ref] 
| [`geometry`][sql-geometry-ref] 
| [`geography`][sql-geography-ref]

| Java Data Type                                                                                                                           | -------------|:----------------------------------------------------------------------------------------------------------------------------------------------| | [**`Boolean`**][java-boolean-ref], [`Byte`][java-byte-ref], [`Short`][java-short-ref], [`Integer`][java-integer-ref], [`Long`][java-long-ref], [`BigDecimal`][java-bigdecimal-ref], [`BigInteger`][java-biginteger-ref] | | [**`Byte`**][java-byte-ref], [`Boolean`][java-boolean-ref], [`Short`][java-short-ref], [`Integer`][java-integer-ref], [`Long`][java-long-ref], [`BigDecimal`][java-bigdecimal-ref], [`BigInteger`][java-biginteger-ref] | | [**`Short`**][java-short-ref], [`Boolean`][java-boolean-ref], [`Byte`][java-byte-ref], [`Integer`][java-integer-ref], [`Long`][java-long-ref], [`BigDecimal`][java-bigdecimal-ref], [`BigInteger`][java-biginteger-ref] | | [**`Integer`**][java-integer-ref], [`Boolean`][java-boolean-ref], [`Byte`][java-byte-ref], [`Short`][java-short-ref], [`Long`][java-long-ref], [`BigDecimal`][java-bigdecimal-ref], [`BigInteger`][java-biginteger-ref] | | [**`Long`**][java-long-ref], [`Boolean`][java-boolean-ref], [`Byte`][java-byte-ref], [`Short`][java-short-ref], [`Integer`][java-integer-ref], [`BigDecimal`][java-bigdecimal-ref], [`BigInteger`][java-biginteger-ref] | | [**`Float`**][java-float-ref], [`Double`][java-double-ref] | [**`Double`**][java-double-ref], [`Float`][java-float-ref] | [**`BigDecimal`**][java-bigdecimal-ref], [`BigInteger`][java-biginteger-ref] | [**`BigDecimal`**][java-bigdecimal-ref], [`BigInteger`][java-biginteger-ref] | [**`UUID`**][java-uuid-ref], [`String`][java-string-ref] | [`LocalDateTime`][java-ldt-ref] | [`LocalDateTime`][java-ldt-ref] | [`LocalDateTime`][java-ldt-ref] | [`LocalDate`][java-ld-ref] | [`LocalTime`][java-lt-ref] | [**`OffsetDateTime`**][java-odt-ref], [`ZonedDateTime`][java-zdt-ref] | [`byte[]`][java-byte-ref] | [`BigDecimal`][java-bigdecimal-ref] | [`BigDecimal`][java-bigdecimal-ref] | [`String`][java-string-ref], [`Clob`][r2dbc-clob-ref] | [`String`][java-string-ref], [`Clob`][r2dbc-clob-ref] | [`String`][java-string-ref], [`Clob`][r2dbc-clob-ref] | [`String`][java-string-ref], [`Clob`][r2dbc-clob-ref] | [`String`][java-string-ref], [`Clob`][r2dbc-clob-ref] | [`String`][java-string-ref], [`Clob`][r2dbc-clob-ref] | [`String`][java-string-ref], [`Clob`][r2dbc-clob-ref] | [`String`][java-string-ref], [`Clob`][r2dbc-clob-ref] | [**`ByteBuffer`**][java-ByteBuffer-ref], [`byte[]`][java-byte-ref], [`Blob`][r2dbc-blob-ref] | [**`ByteBuffer`**][java-ByteBuffer-ref], [`byte[]`][java-byte-ref], [`Blob`][r2dbc-blob-ref] | [**`ByteBuffer`**][java-ByteBuffer-ref], [`byte[]`][java-byte-ref], [`Blob`][r2dbc-blob-ref] | [**`ByteBuffer`**][java-ByteBuffer-ref], [`byte[]`][java-byte-ref], [`Blob`][r2dbc-blob-ref] | Not yet supported. | Not yet supported. | Not yet supported. | Not yet supported. | Not yet supported.

Types in **bold** indicate the native (default) Java type.

**Note:** BLOB (`image`, `binary`, `varbinary` and `varbinary(max)`) and CLOB (`text`, `ntext`, `varchar(max)` and `nvarchar(max)`)

values are fully materialized in the client before decoding. Make sure to account for proper memory sizing.

[sql-bit-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/bit-transact-sql?view=sql-server-2017

[sql-all-int-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/int-bigint-smallint-and-tinyint-transact-sql?view=sql-server-2017

[sql-float-real-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/float-and-real-transact-sql?view=sql-server-2017

[sql-decimal-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/decimal-and-numeric-transact-sql?view=sql-server-2017

[sql-smalldatetime-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/smalldatetime-transact-sql?view=sql-server-2017

[sql-datetime-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/datetime-transact-sql?view=sql-server-2017

[sql-datetime2-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/datetime2-transact-sql?view=sql-server-2017

[sql-date-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/date-transact-sql?view=sql-server-2017

[sql-time-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/time-transact-sql?view=sql-server-2017

[sql-timestamp-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/rowversion-transact-sql?view=sql-server-2017

[sql-uid-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/uniqueidentifier-transact-sql?view=sql-server-2017

[sql-dtof-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/datetimeoffset-transact-sql?view=sql-server-2017

[sql-money-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/money-and-smallmoney-transact-sql?view=sql-server-2017

[sql-(var)char-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/char-and-varchar-transact-sql?view=sql-server-2017

[sql-n(var)char-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/nchar-and-nvarchar-transact-sql?view=sql-server-2017

[sql-(n)text-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/ntext-text-and-image-transact-sql?view=sql-server-2017

[sql-binary-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/binary-and-varbinary-transact-sql?view=sql-server-2017

[sql-sql-variant-ref]: https://docs.microsoft.com/en-us/sql/t-sql/data-types/sql-variant-transact-sql?view=sql-server-2017

[sql-xml-ref]: https://docs.microsoft.com/en-us/sql/t-sql/xml/xml-transact-sql?view=sql-server-2017

[sql-udt-ref]: https://docs.microsoft.com/en-us/sql/relational-databases/clr-integration-database-objects-user-defined-types/clr-user-defined-types?view=sql-server-2017

[sql-geometry-ref]: https://docs.microsoft.com/en-us/sql/t-sql/spatial-geometry/spatial-types-geometry-transact-sql?view=sql-server-2017

[sql-geography-ref]: https://docs.microsoft.com/en-us/sql/t-sql/spatial-geography/spatial-types-geography?view=sql-server-2017

[r2dbc-blob-ref]: https://r2dbc.io/spec/1.0.0.RELEASE/api/io/r2dbc/spi/Blob.html

[r2dbc-clob-ref]: https://r2dbc.io/spec/1.0.0.RELEASE/api/io/r2dbc/spi/Clob.html

[java-bigdecimal-ref]: https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html

[java-biginteger-ref]: https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html

[java-boolean-ref]: https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html

[java-byte-ref]: https://docs.oracle.com/javase/8/docs/api/java/lang/Byte.html

[java-ByteBuffer-ref]: https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html

[java-double-ref]: https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html

[java-float-ref]: https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html

[java-integer-ref]: https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html

[java-long-ref]: https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html

[java-ldt-ref]: https://docs.oracle.com/javase/8/docs/api/java/time/LocalDateTime.html

[java-ld-ref]: https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html

[java-lt-ref]: https://docs.oracle.com/javase/8/docs/api/java/time/LocalTime.html

[java-odt-ref]: https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html

[java-short-ref]: https://docs.oracle.com/javase/8/docs/api/java/lang/Short.html

[java-string-ref]: https://docs.oracle.com/javase/8/docs/api/java/lang/String.html

[java-uuid-ref]: https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html

[java-zdt-ref]: https://docs.oracle.com/javase/8/docs/api/java/time/ZonedDateTime.html

## Logging

If SL4J is on the classpath, it will be used. Otherwise, there are two possible fallbacks: Console or `java.util.logging.Logger`). By default, the Console fallback is used. To use the JDK loggers, set the `reactor.logging.fallback` System property to `JDK`.

Logging facilities:

* Driver Logging (`io.r2dbc.mssql`)

* Query Logging (`io.r2dbc.mssql.QUERY` on `DEBUG` level)

* Transport Logging (`io.r2dbc.mssql.client`)

    * `DEBUG` enables `Message` exchange logging

    * `TRACE` enables traffic logging

## Getting Help

Having trouble with R2DBC? We'd love to help!

* Check the [spec documentation](https://r2dbc.io/spec/1.0.0.RELEASE/spec/html/), and [Javadoc](https://r2dbc.io/spec/1.0.0.RELEASE/api/).

* If you are upgrading, check out the [changelog](https://r2dbc.io/spec/1.0.0.RELEASE/CHANGELOG.txt) for "new and noteworthy" features.

* Ask a question - we monitor [stackoverflow.com](https://stackoverflow.com) for questions tagged with [`r2dbc`](https://stackoverflow.com/tags/r2dbc). You can also chat with the community

  on [Gitter](https://gitter.im/r2dbc/r2dbc).

* Report bugs with R2DBC MSSQL at [github.com/r2dbc/r2dbc-mssql/issues](https://github.com/r2dbc/r2dbc-mssql/issues).

## Reporting Issues

R2DBC uses GitHub as issue tracking system to record bugs and feature requests. 

If you want to raise an issue, please follow the recommendations below:

* Before you log a bug, please search the [issue tracker](https://github.com/r2dbc/r2dbc-mssql/issues) to see if someone has already reported the problem.

* If the issue doesn't already exist, [create a new issue](https://github.com/r2dbc/r2dbc-mssql/issues/new).

* Please provide as much information as possible with the issue report, we like to know the version of R2DBC MSSQL that you are using and JVM version.

* If you need to paste code, or include a stack trace use Markdown ``` escapes before and after your text.

* If possible try to create a test-case or project that replicates the issue. 

Attach a link to your code or a compressed file containing your code.

## Building from Source

You don't need to build from source to use R2DBC MSSQL (binaries in Maven Central), but if you want to try out the latest and greatest, R2DBC MSSQL can be easily built with the

[maven wrapper](https://github.com/takari/maven-wrapper). You also need JDK 1.8 and Docker to run integration tests.

```bash

 $ ./mvnw clean install

```

If you want to build with the regular `mvn` command, you will need [Maven v3.6.0 or above](https://maven.apache.org/run-maven/index.html).

_Also see [CONTRIBUTING.adoc](https://github.com/r2dbc/.github/blob/main/CONTRIBUTING.adoc) if you wish to submit pull requests. Commits require `Signed-off-by` (`git commit -s`) to ensure [Developer Certificate of Origin](https://developercertificate.org/)._

### Running JMH Benchmarks

Running the JMH benchmarks builds and runs the benchmarks without running tests.

```bash

 $ ./mvnw clean install -Pjmh

```

## Staging to Maven Central

To stage a release to Maven Central, you need to create a release tag (release version) that contains the desired state and version numbers (`mvn versions:set versions:commit -q -o -DgenerateBackupPoms=false -DnewVersion=x.y.z.(RELEASE|Mnnn|RCnnn`) and force-push it to the `release-0.x` branch. This push will trigger a Maven staging build (see `build-and-deploy-to-maven-central.sh`).

## License

R2DBC MSSQL is Open Source software released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).