core/org.jetbrains.kotlinx.dataframe.annotations/JdbcOptions

JdbcOptions

annotation class JdbcOptions(val user: String = "", val password: String = "", val extractCredFromEnv: Boolean = false, val tableName: String = "", val sqlQuery: String = "")

An annotation class that represents options for JDBC connection.

Properties

extractCredFromEnv

val extractCredFromEnv: Boolean = false

Whether to extract the JDBC credentials from environment variables. Default value is false.

password

val password: String

The password for the JDBC connection. Default value is an empty string. If extractCredFromEnv is true, the password value will be interpreted as key for system environment variable.

sqlQuery

val sqlQuery: String

The SQL query to be executed in the JDBC connection. Default value is an empty string.

tableName

val tableName: String

The name of the table for the JDBC connection. Default value is an empty string.

user

val user: String

The username for the JDBC connection. Default value is an empty string. If extractCredFromEnv is true, the user value will be interpreted as key for system environment variable.