Microsoft SQL Server (MS SQL)

Kotlin DataFrame supports reading from a Microsoft SQL Server (MS SQL) database using JDBC.

API reference: MsSql, readSqlTable

Requires the dataframe-jdbc module, which is included by default in the general dataframe artifact and in %use dataframe for Kotlin Notebook.

You’ll also need the official MS SQL JDBC driver:

dependencies {
    implementation("com.microsoft.sqlserver:mssql-jdbc:$version")
}

USE {
    dependencies("com.microsoft.sqlserver:mssql-jdbc:$version")
}

The actual Maven Central driver version can be found here.

Read

A DataFrame can be loaded from a database in several ways:

a user can read data from a SQL table by a given name (readSqlTable),
as a result of a user-defined SQL query (readSqlQuery), or
from a given ResultSet (readResultSet). It is also possible to load all data from non-system tables, each into a separate DataFrame (readAllSqlTables).

See Read from SQL databases for more details.

val url = "jdbc:sqlserver://localhost:1433;databaseName=testDatabase"
val username = "sa"
val password = "password"

val dbConfig = DbConnectionConfig(url, username, password)

val tableName = "Customer"

val df = DataFrame.readSqlTable(dbConfig, tableName)

30 October 2026