Skip to content

Setup docs #1357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Explore [**documentation**](https://kotlin.github.io/dataframe) for details.
You could find the following articles there:

* [Guides and Examples](https://kotlin.github.io/dataframe/guides-and-examples.html)
* [Get started with Kotlin DataFrame](https://kotlin.github.io/dataframe/gettingstarted.html)
* [Get started with Kotlin DataFrame](https://kotlin.github.io/dataframe/setup.html)
* [Working with Data Schemas](https://kotlin.github.io/dataframe/schemas.html)
* [Setup compiler plugin in Gradle project](https://kotlin.github.io/dataframe/compiler-plugin.html)
* [Full list of all supported operations](https://kotlin.github.io/dataframe/operations.html)
Expand All @@ -61,7 +61,7 @@ Check out this [notebook with new features](examples/notebooks/feature_overviews
## Setup

> For more detailed instructions on how to get started with Kotlin DataFrame, refer to the
> [Getting Started](https://kotlin.github.io/dataframe/gettingstarted.html).
> [Getting Started](https://kotlin.github.io/dataframe/setup.html).

### Kotlin Notebook

Expand Down
13 changes: 7 additions & 6 deletions docs/StardustDocs/d.tree
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
</toc-element>
</toc-element>

<toc-element topic="gettingStarted.md" accepts-web-file-names="installation.html">
<toc-element topic="gettingStartedKotlinNotebook.md"/>
<toc-element topic="gettingStartedGradle.md"/>
<toc-element topic="gettingStartedJupyterNotebook.md"/>
<toc-element topic="gettingStartedDatalore.md"/>
<toc-element topic="gettingStartedGradleAdvanced.md"/>
<toc-element topic="Setup.md" accepts-web-file-names="gettingstarted">
<toc-element topic="SetupKotlinNotebook.md" accepts-web-file-names="gettingstartedkotlinnotebook.html"/>
<toc-element topic="SetupGradle.md" accepts-web-file-names="gettingstartedgradle.html"/>
<toc-element topic="SetupJupyter.md" accepts-web-file-names="gettingstartedjupyternotebook.html"/>
<toc-element topic="SetupDatalore.md" accepts-web-file-names="gettingstarteddatalore.html"/>
<toc-element topic="SetupAndroid.md" accepts-web-file-names="gettingstartedgradleadvanced.html"/>
<toc-element topic="Modules.md"/>
</toc-element>
<toc-element topic="concepts.md" accepts-web-file-names="overview.html">
Expand Down Expand Up @@ -209,4 +209,5 @@
<toc-element topic="Support.md"/>
<toc-element topic="FAQ.md"/>
<toc-element topic="Migration-From-Plugins.md"/>
<toc-element topic="SetupCustomGradle.md"/>
</instance-profile>
Binary file removed docs/StardustDocs/images/datalore-1.png
Binary file not shown.
Binary file removed docs/StardustDocs/images/datalore-1_dark.png
Binary file not shown.
Binary file removed docs/StardustDocs/images/datalore-2.png
Binary file not shown.
Binary file removed docs/StardustDocs/images/datalore-2_dark.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/StardustDocs/topics/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To stay updated on progress, subscribe to the
Yes — Kotlin DataFrame can be used in Android projects.

There is no dedicated Android artifact yet, but you can include the standard **JVM artifact**
by setting up a [custom Gradle configuration](gettingStartedGradleAdvanced.md).
by setting up a [custom Gradle configuration](SetupAndroid.md).

## How to start with Kotlin DataFrame ?

Expand All @@ -41,7 +41,7 @@ to explore various use cases and deepen your understanding of Kotlin DataFrame.

For the best experience, Kotlin DataFrame is most effective in an interactive environment.

- **[Kotlin Notebook](gettingStartedKotlinNotebook.md)** is ideal for exploring Kotlin DataFrame.
- **[Kotlin Notebook](SetupKotlinNotebook.md)** is ideal for exploring Kotlin DataFrame.
Everything works out of the box — interactivity, rich rendering of DataFrames and plots.
You can instantly see the results of each operation, view the contents of your DataFrames after every transformation,
inspect individual rows and columns, and explore data step-by-step in a live and interactive way.
Expand Down Expand Up @@ -109,7 +109,7 @@ in a **type-safe** and **name-safe** way.

They are generated automatically when working with Kotlin DataFrame in:

- [Kotlin Notebook](gettingStartedKotlinNotebook.md), where extension properties are generated
- [Kotlin Notebook](SetupKotlinNotebook.md), where extension properties are generated
after each cell execution.
- A Kotlin project in [IntelliJ IDEA](https://www.jetbrains.com/idea/) with the
[](Compiler-Plugin.md) enabled, where the properties are generated at compile time.
Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/Home.topic
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

<primary>
<title>First steps</title>
<a href="gettingStartedKotlinNotebook.md"/>
<a href="SetupKotlinNotebook.md"/>
<a href="concepts.md"/>
<a href="operations.md"/>
<a href="read.md">Reading from files: CSV, JSON, ApacheArrow</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/collectionsInterop.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ val df2 = df.add("c") { a + b }
<tip>

To enable extension properties generation, you should use the [DataFrame plugin](schemasGradle.md)
for Gradle or the [Kotlin Jupyter kernel](gettingStartedJupyterNotebook.md)
for Gradle or the [Kotlin Jupyter kernel](SetupJupyter.md)

</tip>

Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSources/ApacheArrow.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Kotlin DataFrame supports reading from and writing to Apache Arrow files.

Requires the [`dataframe-arrow` module](Modules.md#dataframe-arrow), which is included by
default in the general [`dataframe`](Modules.md#dataframe-general) artifact
and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.

> Make sure to follow the
> [Apache Arrow Java compatibility guide](https://arrow.apache.org/docs/java/install.html#java-compatibility)
Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSources/CSV-TSV.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Kotlin DataFrame supports reading from and writing to CSV and TSV files.

Requires the [`dataframe-csv` module](Modules.md#dataframe-csv),
which is included by default in the general [`dataframe`](Modules.md#dataframe-general)
artifact and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
artifact and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.

## Read

Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSources/Excel.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Kotlin DataFrame supports reading from and writing to Excel files in both `.xls`

Requires the [`dataframe-excel` module](Modules.md#dataframe-excel),
which is included by default in the general [`dataframe`](Modules.md#dataframe-general)
artifact and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
artifact and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.

## Read

Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSources/JSON.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Kotlin DataFrame supports reading from and writing to JSON files.

Requires the [`dataframe-json` module](Modules.md#dataframe-json),
which is included by default in the general [`dataframe`](Modules.md#dataframe-general)
artifact and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe)
artifact and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe)
for Kotlin Notebook.

> Kotlin DataFrame is suitable only for working with table-like structured JSON —
Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSources/sql/H2.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Kotlin DataFrame supports reading from an [H2](https://www.h2database.com/html/m

Requires the [`dataframe-jdbc` module](Modules.md#dataframe-jdbc),
which is included by default in the general [`dataframe` artifact](Modules.md#dataframe-general)
and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.

You’ll also need [the official H2 JDBC driver](https://www.h2database.com/html/main.html):

Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSources/sql/MariaDB.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Kotlin DataFrame supports reading from [MariaDB](https://mariadb.org) database u

Requires the [`dataframe-jdbc` module](Modules.md#dataframe-jdbc),
which is included by default in the general [`dataframe` artifact](Modules.md#dataframe-general)
and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.

You’ll also need [the official MariaDB JDBC driver](https://mariadb.com/docs/connectors/mariadb-connector-j):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ database using JDBC.

Requires the [`dataframe-jdbc` module](Modules.md#dataframe-jdbc),
which is included by default in the general [`dataframe` artifact](Modules.md#dataframe-general)
and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.

You’ll also need
[the official MS SQL JDBC driver](https://learn.microsoft.com/en-us/sql/connect/jdbc/download-microsoft-jdbc-driver-for-sql-server?view=sql-server-ver17):
Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSources/sql/MySQL.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Kotlin DataFrame supports reading from [MySQL](https://www.mysql.com) database u

Requires the [`dataframe-jdbc` module](Modules.md#dataframe-jdbc),
which is included by default in the general [`dataframe` artifact](Modules.md#dataframe-general)
and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.

You’ll also need [the official MySQL JDBC driver](https://dev.mysql.com/downloads/connector/j/):

Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSources/sql/PostgreSQL.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Kotlin DataFrame supports reading from [PostgreSQL](https://www.postgresql.org)

Requires the [`dataframe-jdbc` module](Modules.md#dataframe-jdbc),
which is included by default in the general [`dataframe` artifact](Modules.md#dataframe-general)
and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.

You’ll also need [the official PostgreSQL JDBC driver](https://jdbc.postgresql.org):

Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSources/sql/SQL.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Kotlin DataFrame supports reading from SQL databases using JDBC.

Requires the [`dataframe-jdbc` module](Modules.md#dataframe-jdbc),
which is included by default in the general [`dataframe` artifact](Modules.md#dataframe-general)
and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
You’ll also need a JDBC driver for the specific database.

## Supported databases
Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/dataSources/sql/SQLite.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Kotlin DataFrame supports reading from [SQLite](https://www.sqlite.org) database

Requires the [`dataframe-jdbc` module](Modules.md#dataframe-jdbc),
which is included by default in the general [`dataframe` artifact](Modules.md#dataframe-general)
and in [`%use dataframe`](gettingStartedKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.
and in [`%use dataframe`](SetupKotlinNotebook.md#integrate-kotlin-dataframe) for Kotlin Notebook.

You’ll also need [SQLite JDBC driver](https://github.com/xerial/sqlite-jdbc):

Expand Down
4 changes: 2 additions & 2 deletions docs/StardustDocs/topics/extensionPropertiesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ with the name and type of properties inferred from the name and type of the corr
It also works for all types of hierarchical dataframes.

> The behavior of data schema generation differs between the
> [Compiler Plugin](Compiler-Plugin.md) and [Kotlin Notebook](gettingStartedKotlinNotebook.md).
> [Compiler Plugin](Compiler-Plugin.md) and [Kotlin Notebook](SetupKotlinNotebook.md).
>
> * In **Kotlin Notebook**, a schema is generated **only after cell execution** for
> `DataFrame` variables defined within that cell.
Expand All @@ -29,7 +29,7 @@ which is a [**column group**](DataColumn.md#columngroup) containing two nested
[value columns](DataColumn.md#valuecolumn) —
`age` of type `Int`, and `height` of type `Double`.

<table>
<table width="705">
<thead>
<tr>
<th>name</th>
Expand Down
87 changes: 0 additions & 87 deletions docs/StardustDocs/topics/gettingStarted/gettingStarted.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/StardustDocs/topics/gettingStarted/gettingStartedDatalore.md

This file was deleted.

Loading