diff --git a/build.gradle.kts b/build.gradle.kts index 04d35eb..919a18a 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,9 +1,7 @@ -import java.util.* - plugins { - kotlin("jvm") version "2.2.20" - kotlin("plugin.dataframe") version "2.2.20" - id("org.jetbrains.kotlinx.dataframe") version "1.0.0-Beta4" + kotlin("jvm") version "2.3.10" + kotlin("plugin.dataframe") version "2.3.10" + application } group = "org.jetbrains.kotlinx.dataframe.examples" @@ -14,11 +12,11 @@ repositories { } dependencies { - implementation ("org.jetbrains.kotlinx:dataframe:1.0.0-Beta4") - implementation ("org.jetbrains.kotlinx:kandy-lets-plot:0.8.1-dev-67") - implementation ("org.jetbrains.kotlinx:kandy-api:0.8.1-dev-67") - implementation ("org.mariadb.jdbc:mariadb-java-client:3.5.4") - implementation ("org.hsqldb:hsqldb:2.7.4") + implementation("org.jetbrains.kotlinx:dataframe:1.0.0-dev-9593") + implementation("org.jetbrains.kotlinx:kandy-lets-plot:0.8.3-dev-94") + implementation("org.jetbrains.kotlinx:kandy-api:0.8.3-dev-94") + implementation("org.mariadb.jdbc:mariadb-java-client:3.5.4") + implementation("org.hsqldb:hsqldb:2.7.4") testImplementation(kotlin("test")) } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 249e583..61285a6 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index d30212c..37f78a6 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..adff685 --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..c4bdd3a --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,93 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/src/main/kotlin/Example_3_API_Demonstration.kt b/src/main/kotlin/Example_3_API_Demonstration.kt index 6605294..73f1371 100644 --- a/src/main/kotlin/Example_3_API_Demonstration.kt +++ b/src/main/kotlin/Example_3_API_Demonstration.kt @@ -1,20 +1,16 @@ package org.jetbrains.kotlinx.dataframe.examples.jdbc -import java.sql.DriverManager -import java.util.Properties import org.jetbrains.kotlinx.dataframe.DataFrame import org.jetbrains.kotlinx.dataframe.annotations.DataSchema -import org.jetbrains.kotlinx.dataframe.api.cast -import org.jetbrains.kotlinx.dataframe.api.describe -import org.jetbrains.kotlinx.dataframe.api.filter -import org.jetbrains.kotlinx.dataframe.api.generateInterfaces -import org.jetbrains.kotlinx.dataframe.api.print +import org.jetbrains.kotlinx.dataframe.api.* import org.jetbrains.kotlinx.dataframe.io.db.MySql import org.jetbrains.kotlinx.dataframe.io.readAllSqlTables import org.jetbrains.kotlinx.dataframe.io.readResultSet import org.jetbrains.kotlinx.dataframe.io.readSqlQuery import org.jetbrains.kotlinx.dataframe.io.readSqlTable import org.jetbrains.kotlinx.dataframe.schema.DataFrameSchema +import java.sql.DriverManager +import java.util.* @DataSchema interface TarantinoFilms { diff --git a/src/main/kotlin/customdb/Example_1_Simple_Example.kt b/src/main/kotlin/customdb/Example_1_Simple_Example.kt index de07e1f..902c6f1 100644 --- a/src/main/kotlin/customdb/Example_1_Simple_Example.kt +++ b/src/main/kotlin/customdb/Example_1_Simple_Example.kt @@ -1,23 +1,35 @@ package org.jetbrains.kotlinx.dataframe.examples.jdbc.customdb +import kotlinx.datetime.LocalDate import org.jetbrains.kotlinx.dataframe.annotations.DataSchema -import org.jetbrains.kotlinx.dataframe.api.* +import org.jetbrains.kotlinx.dataframe.api.cast +import org.jetbrains.kotlinx.dataframe.api.filter +import org.jetbrains.kotlinx.dataframe.api.print +import org.jetbrains.kotlinx.dataframe.api.renameToCamelCase import org.jetbrains.kotlinx.dataframe.io.readDataFrame import java.sql.DriverManager -import java.util.* @DataSchema interface Orders { val id: Int val item: String val price: Double - val orderDate: java.util.Date + val orderDate: LocalDate } -//https://www.tutorialspoint.com/hsqldb/hsqldb_quick_guide.htm -// CMD> java -classpath lib/hsqldb.jar org.hsqldb.server.Server --database.0 file:hsqldb/demodb --dbname.0 testdb + +/** + * Following https://www.tutorialspoint.com/hsqldb/hsqldb_quick_guide.htm: + * + * Run `CMD> java -classpath lib/hsqldb.jar org.hsqldb.server.Server --database.0 file:hsqldb/demodb --dbname.0 testdb` + * + * Use `url = `[URL] to connect to the running server. + * + * Alternatively, use `url = `[URL_IN_MEMORY] to connect to an in-memory database for testing purposes. + */ fun main() { - DriverManager.getConnection(URL, USER_NAME, PASSWORD).use { con -> + val url = URL + DriverManager.getConnection(url, USER_NAME, PASSWORD).use { con -> createAndPopulateTable(con) val df = con @@ -25,7 +37,7 @@ fun main() { .renameToCamelCase() .cast(verify = true) - // df.filter { it.price > 800 }.print() + df.filter { it.price > 800 }.print() removeTable(con) } diff --git a/src/main/kotlin/customdb/HSQLDB.kt b/src/main/kotlin/customdb/HSQLDB.kt index c108512..352ac35 100644 --- a/src/main/kotlin/customdb/HSQLDB.kt +++ b/src/main/kotlin/customdb/HSQLDB.kt @@ -1,45 +1,103 @@ package org.jetbrains.kotlinx.dataframe.examples.jdbc.customdb +import kotlinx.datetime.LocalDate +import kotlinx.datetime.toKotlinLocalDate +import org.jetbrains.kotlinx.dataframe.DataColumn +import org.jetbrains.kotlinx.dataframe.examples.jdbc.customdb.HSQLDB.getPreprocessedValueType +import org.jetbrains.kotlinx.dataframe.examples.jdbc.customdb.HSQLDB.preprocessValue import org.jetbrains.kotlinx.dataframe.io.db.DbType import org.jetbrains.kotlinx.dataframe.io.db.TableColumnMetadata import org.jetbrains.kotlinx.dataframe.io.db.TableMetadata -import org.jetbrains.kotlinx.dataframe.schema.ColumnSchema import java.sql.ResultSet -import java.util.Locale +import java.sql.Types import kotlin.reflect.KType +import kotlin.reflect.full.isSubtypeOf +import kotlin.reflect.full.withNullability +import kotlin.reflect.typeOf +import java.sql.Date as SqlDate /** * Represents the HSQLDB database type. * - * This class provides methods to convert data from a ResultSet to the appropriate type for HSQLDB, - * and to generate the corresponding column schema. + * This object provides all functions to read data from a HSQLDB [ResultSet], + * preprocess the values, and build [columns][DataColumn]. */ -public object HSQLDB : DbType("hsqldb") { - override val driverClassName: String - get() = "org.hsqldb.jdbcDriver" +object HSQLDB : DbType("hsqldb") { - override fun convertSqlTypeToColumnSchemaValue(tableColumnMetadata: TableColumnMetadata): ColumnSchema? { - return null + /** The JDBC driver class name. */ + override val driverClassName: String = "org.hsqldb.jdbcDriver" + + /** + * This function should return the correct type of the value returned by [ResultSet.getObject] from JDBC + * for the column with the given [tableColumnMetadata]. + * [DbType] has a good default type-map, but your database type might deviate. + * + * Supplying these types helps you and DataFrame to correctly interpret and handle data from the database. + */ + override fun getExpectedJdbcType(tableColumnMetadata: TableColumnMetadata): KType = + when (tableColumnMetadata.jdbcType) { + // For example, here we say that we expect .getObject() to return a Java SQL Date + // when the given JDBC SQL type is DATE + Types.DATE -> typeOf().withNullability(tableColumnMetadata.isNullable) + + // TODO this list is likely incomplete for HSQLDB + + // Else, we follow the default behavior + else -> super.getExpectedJdbcType(tableColumnMetadata) + } + + /** + * If you want to preprocess certain values before creating a [DataColumn], you can override this function. + * [DbType] already has a few types of values being preprocessed, but you can customize this behavior. + * + * This function just specifies the type-behavior, [preprocessValue] actually does the preprocessing. + */ + override fun getPreprocessedValueType( + tableColumnMetadata: TableColumnMetadata, + expectedJdbcType: KType + ): KType = + when { + // Let's say we want to convert java.sql.Date to kotlinx.datetime.LocalDate (taking nullability into account) + expectedJdbcType.isSubtypeOf(typeOf()) -> + typeOf().withNullability(tableColumnMetadata.isNullable) + + // Else, we follow the default behavior + else -> + super.getPreprocessedValueType(tableColumnMetadata, expectedJdbcType) + } + + /** + * This function actually preprocesses the values returned by [ResultSet.getObject], following the + * [getPreprocessedValueType] type-behavior. + */ + override fun preprocessValue( + value: J, + tableColumnMetadata: TableColumnMetadata, + expectedJdbcType: KType, + expectedPreprocessedValueType: KType + ): D = when { + // Here we actually perform the conversion from java.sql.Date to kotlinx.datetime.LocalDate + expectedJdbcType.isSubtypeOf(typeOf()) -> + (value as SqlDate?)?.toLocalDate()?.toKotlinLocalDate() as D + + // Else, we follow the default behavior + else -> + super.preprocessValue(value, tableColumnMetadata, expectedJdbcType, expectedPreprocessedValueType) } override fun isSystemTable(tableMetadata: TableMetadata): Boolean { - val locale = Locale.getDefault() - fun String?.containsWithLowercase(substr: String) = this?.lowercase(locale)?.contains(substr) == true - val schemaName = tableMetadata.schemaName - val name = tableMetadata.name - return schemaName.containsWithLowercase("information_schema") || - schemaName.containsWithLowercase("system") || - name.containsWithLowercase("system_") + val schemaName = tableMetadata.schemaName.orEmpty().lowercase() + val name = tableMetadata.name.lowercase() + + return "information_schema" in schemaName || + "system" in schemaName || + "system_" in name } override fun buildTableMetadata(tables: ResultSet): TableMetadata = TableMetadata( - tables.getString("TABLE_NAME"), - tables.getString("TABLE_SCHEM"), - tables.getString("TABLE_CAT"), + name = tables.getString("TABLE_NAME"), + schemaName = tables.getString("TABLE_SCHEM"), + catalogue = tables.getString("TABLE_CAT"), ) - - override fun convertSqlTypeToKType(tableColumnMetadata: TableColumnMetadata): KType? { - return null - } } diff --git a/src/main/kotlin/customdb/hsqldbUtils.kt b/src/main/kotlin/customdb/hsqldbUtils.kt index 4e1e663..e85a73c 100644 --- a/src/main/kotlin/customdb/hsqldbUtils.kt +++ b/src/main/kotlin/customdb/hsqldbUtils.kt @@ -3,6 +3,7 @@ package org.jetbrains.kotlinx.dataframe.examples.jdbc.customdb import java.sql.Connection const val URL = "jdbc:hsqldb:hsql://localhost/testdb" +const val URL_IN_MEMORY = "jdbc:hsqldb:hsql:mem:testdb" const val USER_NAME = "SA" const val PASSWORD = "" @@ -13,7 +14,7 @@ fun removeTable(con: Connection): Int { } fun createAndPopulateTable(con: Connection) { - var stmt = con.createStatement() + val stmt = con.createStatement() stmt.executeUpdate( """CREATE TABLE IF NOT EXISTS orders ( id INT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,