Implemented custom SQL DB registration #917
Merged
+249
−73
Conversation
This file contains 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 commit introduces an optional `dbType` parameter to various JDBC read functions. It allows for specifying the database type directly, enhancing flexibility and control over query execution. This change ensures backward compatibility by defaulting to type inference when `dbType` is not provided.
This update introduces the ability to specify custom database types in the data schema generation process. The changes include the addition of a `dbTypeClassName` field and modifications to pass `DbType` to relevant functions. This enhances flexibility in handling various database types beyond the default configurations.
This update refactors the DataSchemaGenerator to use ServiceLoader for loading DbTypeProvider and removes hard-coded class loading. It also changes the annotation parameter from dbTypeClassName to dbTypeKClass for better type safety.
|
Generated sources will be updated after merging this PR. |
Jolanrensen
requested changes
Oct 14, 2024
dataframe-jdbc/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/readJdbc.kt
Outdated
Show resolved
Hide resolved
| @@ -142,12 +145,13 @@ public fun DataFrame.Companion.readSqlTable( | |||
| tableName: String, | |||
| limit: Int = DEFAULT_LIMIT, | |||
| inferNullability: Boolean = true, | |||
| dbType: DbType? = null, | |||
There was a problem hiding this comment.
While having a dbType argument here is great for building and debugging support for new DbTypes, I do feel like it's not "complete custom support" of new datatypes.
To be fully extensible, like with DataFrame.read(), I think we should support having service-registered DbTypes. Then a user should be able to do:
implementation("org.jetbrains.kotlinx.dataframe...")
implementation("com.custom.dbtype-for-df")and DataFrame.readSqlTable(MyCustomDbConnection) should work, recognizing the custom DBType that's on the classpath.
Still, it's just an idea and having this dbType argument here is still a must for when the automatic dbtype detection fails.
koperagen
reviewed
Oct 15, 2024
dataframe-jdbc/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/h2/h2Test.kt
Outdated
Show resolved
Hide resolved
koperagen
reviewed
Oct 15, 2024
dataframe-jdbc/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/h2/h2Test.kt
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces several enhancements to the
dataframe-jdbcmodule, primarily focusing on adding support for custom database types (DbType) in various methods. Additionally, it includes a minor change to make theH2class extensible.Also, this PR in the client application is based on 0.15-dev built on this branch
Enhancements to database type support:
dataframe-jdbc/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/readJdbc.kt:dbTypeparameter to multiple methods, allowing custom database type objects to be passed. This parameter defaults tonulland, if not provided, the database type is determined from the connection.Minor changes:
dataframe-jdbc/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/db/H2.kt:H2class to beopen, allowing it to be extended.For finalization, it requires