Refactored DataFrame JDBC API plus DataSource handling #1487
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| package org.jetbrains.kotlinx.dataframe.io | ||
|
|
||
| /** | ||
| * Represents the configuration for an internally managed JDBC database connection. | ||
| * | ||
| * This class defines connection parameters used by the library to create a `Connection` | ||
| * when the user does not provide one explicitly. | ||
| * It is designed for safe, read-only access by default. | ||
| * | ||
| * @property url The JDBC URL of the database, e.g., `"jdbc:postgresql://localhost:5432/mydb"`. | ||
| * Must follow the standard format: `jdbc:subprotocol:subname`. | ||
| * | ||
| * @property user The username used for authentication. | ||
| * Optional, default is an empty string. | ||
| * | ||
| * @property password The password used for authentication. | ||
| * Optional, default is an empty string. | ||
| * | ||
| * @property readOnly If `true` (default), the library will create the connection in read-only mode. | ||
| * This enables the following behavior: | ||
| * - `Connection.setReadOnly(true)` | ||
| * - `Connection.setAutoCommit(false)` | ||
| * - automatic `rollback()` at the end of execution | ||
| * | ||
| * If `false`, the connection will be created with JDBC defaults (usually read-write), | ||
| * but the library will still reject any queries that appear to modify data | ||
| * (e.g. contain `INSERT`, `UPDATE`, `DELETE`, etc.). | ||
| * | ||
| * Note: Connections created using this configuration are managed entirely by the library. | ||
| * Users do not have access to the underlying `Connection` instance and cannot commit or close it manually. | ||
| * | ||
| * ### Examples: | ||
| * | ||
| * ```kotlin | ||
| * // Safe read-only connection (default) | ||
| * val config = DbConnectionConfig("jdbc:sqlite::memory:") | ||
| * val df = DataFrame.readSqlQuery(config, "SELECT * FROM books") | ||
| * | ||
| * // Use default JDBC connection settings (still protected against mutations) | ||
| * val config = DbConnectionConfig( | ||
| * url = "jdbc:sqlite::memory:", | ||
| * readOnly = false | ||
| * ) | ||
| * ``` | ||
| */ | ||
| public data class DbConnectionConfig( | ||
| val url: String, | ||
| val user: String = "", | ||
| val password: String = "", | ||
| val readOnly: Boolean = true, | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| package org.jetbrains.kotlinx.dataframe.io.db | ||
|
|
||
| /** | ||
| * Represents a column in a database table to keep all required meta-information. | ||
| * | ||
| * @property [name] the name of the column. | ||
| * @property [sqlTypeName] the SQL data type of the column. | ||
| * @property [jdbcType] the JDBC data type of the column produced from [java.sql.Types]. | ||
| * @property [size] the size of the column. | ||
| * @property [javaClassName] the class name in Java. | ||
| * @property [isNullable] true if column could contain nulls. | ||
| */ | ||
| public data class TableColumnMetadata( | ||
zaleslaw marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| val name: String, | ||
| val sqlTypeName: String, | ||
| val jdbcType: Int, | ||
| val size: Int, | ||
| val javaClassName: String, | ||
| val isNullable: Boolean = false, | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| package org.jetbrains.kotlinx.dataframe.io.db | ||
|
|
||
| /** | ||
| * Represents a table metadata to store information about a database table, | ||
| * including its name, schema name, and catalogue name. | ||
| * | ||
| * NOTE: we need to extract both, [schemaName] and [catalogue] | ||
| * because the different databases have different implementations of metadata. | ||
| * | ||
| * @property [name] the name of the table. | ||
| * @property [schemaName] the name of the schema the table belongs to (optional). | ||
| * @property [catalogue] the name of the catalogue the table belongs to (optional). | ||
| */ | ||
| public data class TableMetadata(val name: String, val schemaName: String?, val catalogue: String?) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.