dataframe-jdbc/org.jetbrains.kotlinx.dataframe.io

Package-level declarations

Types

class DbConnectionConfig(val url: String, val user: String = "", val password: String = "", val readOnly: Boolean = true)

Represents the configuration for an internally managed JDBC database connection.

DefaultReadJdbcMethod

internal class DefaultReadJdbcMethod(path: String?) : AbstractDefaultReadMethod

Jdbc

class ~~Jdbc~~ : SupportedCodeGenerationFormat, SupportedDataFrameFormat

SqlValidation

enum class SqlValidation : Enum<SqlValidation>

Controls how SQL queries are validated before execution.

Properties

databaseCodeGenReader

val CodeGenerator.Companion.~~databaseCodeGenReader~~: (url: URL, name: String) -> CodeGenerationReadResult

READ_ONLY_ALLOWED_FIRST_TOKENS

internal val READ_ONLY_ALLOWED_FIRST_TOKENS: Set<String>

Top-level SQL keywords that represent read-oriented statements. Only queries starting with one of these tokens are accepted in SqlValidation.ReadOnly mode.

TABLE_NAME_VALID_PATTERN

internal const val TABLE_NAME_VALID_PATTERN: String

A regular expression defining the valid pattern for SQL table names.

Functions

buildCodeForDB

fun ~~buildCodeForDB~~(url: URL, name: String): Code

fetchAndConvertDataFromResultSet

internal fun fetchAndConvertDataFromResultSet(dbType: DbType, tableColumns: List<TableColumnMetadata>, rs: ResultSet, limit: Int?, inferNullability: Boolean): AnyFrame

Fetches and converts data from a ResultSet into a DataFrame.

getExpectedJdbcTypes

internal fun getExpectedJdbcTypes(dbType: DbType, tableColumns: List<TableColumnMetadata>): List<KType>

getPreprocessedValueTypes

internal fun getPreprocessedValueTypes(dbType: DbType, tableColumns: List<TableColumnMetadata>, expectedJdbcTypes: List<KType>): List<KType>

getTableColumnsMetadata

internal fun getTableColumnsMetadata(resultSet: ResultSet, dbType: DbType): List<TableColumnMetadata>

getTargetColumnSchemas

internal fun getTargetColumnSchemas(dbType: DbType, tableColumns: List<TableColumnMetadata>, preprocessedValueTypes: List<KType>): List<ColumnSchema?>

isSqlQuery

internal fun isSqlQuery(sqlQueryOrTableName: String): Boolean

isSqlTableName

internal fun isSqlTableName(sqlQueryOrTableName: String): Boolean

isValidSqlQuery

internal fun isValidSqlQuery(sqlQuery: String): Boolean

Validates that sqlQuery is a read-only query when SqlValidation.ReadOnly is requested.

isValidTableName

internal fun isValidTableName(tableName: String): Boolean

Validates that tableName is a safe SQL identifier.

readAllSqlTables

fun DataFrameSchema.Companion.readAllSqlTables(connection: Connection, dbType: DbType? = null): Map<String, DataFrameSchema>

Retrieves the schemas of all non-system tables in the database using the provided database connection.

fun DataFrameSchema.Companion.readAllSqlTables(dataSource: DataSource, dbType: DbType? = null): Map<String, DataFrameSchema>

Retrieves the schemas of all non-system tables in the database using the provided DataSource.

fun DataFrameSchema.Companion.readAllSqlTables(dbConfig: DbConnectionConfig, dbType: DbType? = null): Map<String, DataFrameSchema>

Retrieves the schemas of all non-system tables in the database using the provided database configuration.

fun DataFrame.Companion.readAllSqlTables(connection: Connection, catalogue: String? = null, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, configureStatement: (PreparedStatement) -> Unit = {}): Map<String, AnyFrame>

fun DataFrame.Companion.readAllSqlTables(dataSource: DataSource, catalogue: String? = null, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, configureStatement: (PreparedStatement) -> Unit = {}): Map<String, AnyFrame>

Reads all non-system tables from a database and returns them as a map of SQL tables and corresponding DataFrames.

fun DataFrame.Companion.readAllSqlTables(dbConfig: DbConnectionConfig, catalogue: String? = null, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, configureStatement: (PreparedStatement) -> Unit = {}): Map<String, AnyFrame>

Reads all non-system tables from a database and returns them as a map of SQL tables and corresponding DataFrames using the provided database configuration and limit.

readDataFrame

fun ResultSet.readDataFrame(dbType: DbType, limit: Int? = null, inferNullability: Boolean = true): AnyFrame

fun ResultSet.readDataFrame(connection: Connection, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null): AnyFrame

Reads the data from a ResultSet and converts it into a DataFrame.

fun Connection.readDataFrame(sqlQueryOrTableName: String, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, validation: SqlValidation = SqlValidation.None, configureStatement: (PreparedStatement) -> Unit = {}): AnyFrame

fun DataSource.readDataFrame(sqlQueryOrTableName: String, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, validation: SqlValidation = SqlValidation.None, configureStatement: (PreparedStatement) -> Unit = {}): AnyFrame

fun DbConnectionConfig.readDataFrame(sqlQueryOrTableName: String, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, validation: SqlValidation = SqlValidation.None, configureStatement: (PreparedStatement) -> Unit = {}): AnyFrame

Converts the result of an SQL query or SQL table (by name) to the DataFrame.

readDataFrameSchema

fun ResultSet.readDataFrameSchema(dbType: DbType): DataFrameSchema

Retrieves the schema from ResultSet.

fun Connection.readDataFrameSchema(sqlQueryOrTableName: String, dbType: DbType? = null): DataFrameSchema

fun DbConnectionConfig.readDataFrameSchema(sqlQueryOrTableName: String, dbType: DbType? = null): DataFrameSchema

Retrieves the schema of an SQL query result or the SQL table using the provided database configuration.

fun DataSource.readDataFrameSchema(sqlQueryOrTableName: String, dbType: DbType? = null): DataFrameSchema

Retrieves the schema of an SQL query result or the SQL table using the provided DataSource.

readResultSet

fun DataFrameSchema.Companion.readResultSet(resultSet: ResultSet, dbType: DbType): DataFrameSchema

Retrieves the schema from ResultSet.

fun DataFrame.Companion.readResultSet(resultSet: ResultSet, dbType: DbType, limit: Int? = null, inferNullability: Boolean = true): AnyFrame

fun DataFrame.Companion.readResultSet(resultSet: ResultSet, connection: Connection, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null): AnyFrame

Reads the data from a ResultSet and converts it into a DataFrame.

readSqlQuery

fun DataFrameSchema.Companion.readSqlQuery(connection: Connection, sqlQuery: String, dbType: DbType? = null): DataFrameSchema

Retrieves the schema of an SQL query result using the provided database connection.

fun DataFrameSchema.Companion.readSqlQuery(dataSource: DataSource, sqlQuery: String, dbType: DbType? = null): DataFrameSchema

Retrieves the schema of an SQL query result using the provided DataSource.

fun DataFrameSchema.Companion.readSqlQuery(dbConfig: DbConnectionConfig, sqlQuery: String, dbType: DbType? = null): DataFrameSchema

Retrieves the schema of an SQL query result using the provided database configuration.

fun DataFrame.Companion.readSqlQuery(connection: Connection, sqlQuery: String, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, validation: SqlValidation = SqlValidation.None, configureStatement: (PreparedStatement) -> Unit = {}): AnyFrame

fun DataFrame.Companion.readSqlQuery(dataSource: DataSource, sqlQuery: String, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, validation: SqlValidation = SqlValidation.None, configureStatement: (PreparedStatement) -> Unit = {}): AnyFrame

fun DataFrame.Companion.readSqlQuery(dbConfig: DbConnectionConfig, sqlQuery: String, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, validation: SqlValidation = SqlValidation.None, configureStatement: (PreparedStatement) -> Unit = {}): AnyFrame

Converts the result of an SQL query to the DataFrame.

readSqlTable

fun DataFrameSchema.Companion.readSqlTable(connection: Connection, tableName: String, dbType: DbType? = null): DataFrameSchema

Retrieves the schema for an SQL table using the provided database connection.

fun DataFrameSchema.Companion.readSqlTable(dataSource: DataSource, tableName: String, dbType: DbType? = null): DataFrameSchema

Retrieves the schema for an SQL table using the provided DataSource.

fun DataFrameSchema.Companion.readSqlTable(dbConfig: DbConnectionConfig, tableName: String, dbType: DbType? = null): DataFrameSchema

Retrieves the schema for an SQL table using the provided database configuration.

fun DataFrame.Companion.readSqlTable(connection: Connection, tableName: String, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, configureStatement: (PreparedStatement) -> Unit = {}): AnyFrame

fun DataFrame.Companion.readSqlTable(dataSource: DataSource, tableName: String, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, configureStatement: (PreparedStatement) -> Unit = {}): AnyFrame

fun DataFrame.Companion.readSqlTable(dbConfig: DbConnectionConfig, tableName: String, limit: Int? = null, inferNullability: Boolean = true, dbType: DbType? = null, configureStatement: (PreparedStatement) -> Unit = {}): AnyFrame

Reads data from an SQL table and converts it into a DataFrame.

stripSqlNoise

internal fun stripSqlNoise(sql: String): String

Strips string literals and comments from a SQL string, replacing them with a single space.

validateLimit

internal fun validateLimit(limit: Int?)

Validates the provided limit to ensure it is either null or a positive integer. Throws an IllegalArgumentException if the limit is negative or zero.

withReadOnlyConnection

internal inline fun <T> withReadOnlyConnection(dbConfig: DbConnectionConfig, dbType: DbType? = null, block: (Connection) -> T): T

Executes the given block with a managed JDBC connection created from DbConnectionConfig.