df-research/dataframe/docs/StardustDocs/topics/dataSources/sql/PostgreSQL.md

PostgreSQL

Work with PostgreSQL databases in Kotlin — read tables and queries into DataFrames using JDBC. Use Kotlin DataFrame to query and transform PostgreSQL data directly via JDBC. Read PostgreSQL data into Kotlin DataFrame with JDBC support.

Kotlin DataFrame supports reading from PostgreSQL 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.

You’ll also need the official PostgreSQL JDBC driver:

dependencies {
    implementation("org.postgresql:postgresql:$version")
}

USE {
    dependencies("org.postgresql:postgresql:$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

val url = "jdbc:postgresql://localhost:5432/testDatabase"
val username = "postgres"
val password = "password"

val dbConfig = DbConnectionConfig(url, username, password)

val tableName = "Customer"

val df = DataFrame.readSqlTable(dbConfig, tableName)