@@ -14,19 +14,19 @@ Learn how to query, read, and inspect SQL database tables using Kotlin DataFrame
1414with full schema inference and flexible JDBC setup.
1515</link-summary >
1616
17- These functions allow you to interact with an SQL database using a Kotlin DataFrame library.
17+ These functions allow you to interact with an SQL database using the Kotlin DataFrame library.
1818
1919There are two main blocks of available functionality:
2020* Methods for reading data from a database
21- * ``` readSqlTable ``` reads specific database table
22- * ``` readSqlQuery ``` executes SQL query
23- * ``` readResultSet ``` reads from created earlier ResultSet
24- * ``` readAllSqlTables ``` reads all tables (all non-system tables)
21+ * ``` DataFrame. readSqlTable() ``` reads a specific database table
22+ * ``` DataFrame. readSqlQuery() ``` executes an SQL query
23+ * ``` DataFrame. readResultSet() ``` reads from a ` ResultSet `
24+ * ``` DataFrame. readAllSqlTables() ``` reads all non-system tables
2525* Methods for reading table schemas
26- * ``` readSqlTable ``` on ` DataFrameSchema ` for specific tables
27- * ``` readSqlQuery ``` on ` DataFrameSchema ` for a specific SQL query
28- * ``` readResultSet ``` on ` DataFrameSchema ` for a ` ResultSet ` created earlier
29- * ``` readAllSqlTables ``` on ` DataFrameSchema ` for all non-system tables
26+ * ``` DataFrameSchema. readSqlTable() `` ` for specific tables
27+ * ``` DataFrameSchema. readSqlQuery() `` ` for a specific SQL query
28+ * ``` DataFrameSchema. readResultSet() ``` for a ` ResultSet `
29+ * ``` DataFrameSchema. readAllSqlTables() `` ` for all non-system tables
3030
3131> ** NOTE (Beta-4 changes):**
3232>
@@ -40,27 +40,27 @@ Also, there are a few **extension functions** available on `Connection`,
4040` ResultSet ` , ` DbConnectionConfig ` , and ` DataSource ` objects.
4141
4242* Methods for reading data from a database
43- * ``` readDataFrame ``` on ` Connection ` or ` DbConnectionConfig `
43+ * ``` readDataFrame() ``` on ` Connection ` or ` DbConnectionConfig `
4444 converts the result of an SQL query or SQL table to a ` DataFrame ` object.
45- * ``` readDataFrame ``` on ` ResultSet ` reads from created earlier ` ResultSet `
45+ * ``` readDataFrame() ``` on ` ResultSet ` reads from created earlier ` ResultSet `
4646* Methods for reading table schemas from a database
47- * ``` getDataFrameSchema ``` on ` Connection ` or ` DbConnectionConfig `
47+ * ``` getDataFrameSchema() ``` on ` Connection ` or ` DbConnectionConfig `
4848 for an SQL query result or the SQL table
49- * ``` getDataFrameSchema ``` on ` ResultSet ` for created earlier ` ResultSet `
49+ * ``` getDataFrameSchema() ``` on ` ResultSet ` for created earlier ` ResultSet `
5050
5151
5252> ** NOTE:** This is an experimental module, and for now,
5353> we only support these databases: MS SQL, MariaDB, MySQL, PostgreSQL, SQLite, and DuckDB.
5454>
55- > Moreover, since release 0.15 we support the possibility to register custom SQL database, read more in our [ guide] ( readSqlFromCustomDatabase.md ) .
55+ > Moreover, since release 0.15 we support the possibility to register a custom SQL database; read more in our [ guide] ( readSqlFromCustomDatabase.md ) .
5656>
5757> Additionally, support for JSON and date-time types is limited.
5858>
5959> Please take this into consideration when using these functions.
6060
61- ## Getting started with reading from SQL database in a Gradle Project
61+ ## Getting started with reading from an SQL database in a Gradle Project
6262
63- First, you need to add a dependency
63+ First, you need to add the dependency
6464
6565``` kotlin
6666implementation(" org.jetbrains.kotlinx:dataframe-jdbc:$dataframe_version " )
0 commit comments