The table type(s) (TABLE_TYPE) of ordinary tables in the SQL database, used by the readAllSqlTables functions as a filter when querying the database for all the tables it has using DatabaseMetaData.getTables.

Functions

buildDataColumn

open fun <D, P> buildDataColumn(name: String, values: List<D>, tableColumnMetadata: TableColumnMetadata, targetColumnSchema: ColumnSchema?, inferNullability: Boolean): DataColumn<P>

Builds a DataColumn from the given (preprocessed) values, adhering to targetColumnSchema.

buildSelectTableQueryWithLimit

open fun buildSelectTableQueryWithLimit(tableName: String, limit: Int?): String

Builds a SELECT query for reading from a table.

buildSqlQueryWithLimit

open fun buildSqlQueryWithLimit(sqlQuery: String, limit: Int = 1): String

Constructs a SQL query with a limit clause.

buildTableMetadata

abstract fun buildTableMetadata(tables: ResultSet): TableMetadata

Builds the table metadata based on the database type and the ResultSet from the query.

configureReadStatement

open fun configureReadStatement(statement: PreparedStatement)

Configures the provided PreparedStatement for optimized read operations.

createConnection

open fun createConnection(dbConfig: DbConnectionConfig): Connection

Creates a database connection using the provided configuration. This method is only called when working with DbConnectionConfig (internally managed connections).

getExpectedJdbcType

open fun getExpectedJdbcType(tableColumnMetadata: TableColumnMetadata): KType

Returns the type of the objects returned by getValueFromResultSet for the given column. Also called type J.

getPreprocessedValueType

open fun getPreprocessedValueType(tableColumnMetadata: TableColumnMetadata, expectedJdbcType: KType): KType

Returns the type of the objects returned by preprocessValue for the given column. Also called type D.

getTableColumnsMetadata

open fun getTableColumnsMetadata(resultSet: ResultSet): List<TableColumnMetadata>

Retrieves column metadata from a JDBC ResultSet.

getTargetColumnSchema

open fun getTargetColumnSchema(tableColumnMetadata: TableColumnMetadata, expectedValueType: KType): ColumnSchema?

Returns the target schema of the given column which buildDataColumn will adhere to. This schema corresponds to type P, in the sense that it will describe the schema of DataColumn<P>.

getValueFromResultSet

open fun <J> getValueFromResultSet(rs: ResultSet, columnIndex: Int, tableColumnMetadata: TableColumnMetadata, expectedJdbcType: KType): J

Extracts a value from the result set for the given column.

isSystemTable

abstract fun isSystemTable(tableMetadata: TableMetadata): Boolean

Checks if the given table name is a system table for the specified database type.

preprocessValue

open fun <J, D> preprocessValue(value: J, tableColumnMetadata: TableColumnMetadata, expectedJdbcType: KType, expectedPreprocessedValueType: KType): D

(Potentially) preprocesses the value for the given column before collecting it in a DataFrame DataColumn.

quoteIdentifier

open fun quoteIdentifier(name: String): String

Quotes an identifier (table or column name) according to database-specific rules.

toDataColumn

protected fun <D, P> List<D>.toDataColumn(name: String, targetColumnSchema: ColumnSchema?, inferNullability: Boolean): DataColumn<P>

Helper function to convert this list of values to a DataColumn<P>.