Files
df-research/dataframe/docs/StardustDocs/topics/dataSources/sql/MySQL.md
2026-02-08 11:20:43 -10:00

2.1 KiB
Vendored
Raw Blame History

MySQL

Connect to MySQL databases and load data into Kotlin DataFrame using JDBC — query, analyze, and transform SQL data in Kotlin. Use Kotlin DataFrame with MySQL — easily read tables and queries over JDBC into powerful data structures. Read data from MySQL into Kotlin DataFrame using JDBC configuration.

Kotlin DataFrame supports reading from MySQL database using JDBC.

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

Youll also need the official MySQL JDBC driver:

dependencies {
    implementation("com.mysql:mysql-connector-j:$version")
}
USE {
    dependencies("com.mysql:mysql-connector-j:$version")
}

The actual Maven Central driver version could be found here.

Read

DataFrame can be loaded from a database in several ways:
a user can read data from a SQL table by 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 for more details.

import org.jetbrains.kotlinx.dataframe.io.DbConnectionConfig
import org.jetbrains.kotlinx.dataframe.api.*

val url = "jdbc:mysql://localhost:3306/testDatabase"
val username = "root"
val password = "password"

val dbConfig = DbConnectionConfig(url, username, password)

val tableName = "Customer"

val df = DataFrame.readSqlTable(dbConfig, tableName)