Data schemas docs #1339
Data schemas docs #1339
Conversation
AndreiKingsley
commented
Jul 22, 2025
AndreiKingsley
commented
- closes #1297
| See [](extensionPropertiesApi.md) for more information. | ||
|
|
||
|
|
||
| ## Schemas retrieving |
There was a problem hiding this comment.
*Schema Retrieving
or *Retrieving Schemas
|
|
||
| Defining a data schema manually can be difficult, especially for dataframes with many columns or deeply nested structures, and may lead to mistakes in column names or types. Kotlin DataFrame provides several methods for generating data schemas. | ||
|
|
||
| * [**`generate..()` methods**](DataSchemaGenerationMethods.md) are extensions for [`DataFrame`](DataFrame.md) that generate a code string representing its `DataSchema`. |
There was a problem hiding this comment.
also extensions for DataFrameSchema, might be relevant
There was a problem hiding this comment.
What do you mean?
There was a problem hiding this comment.
you can call df.generateDataClasses() but also, if you have just the schema, like from JDBC, you can call schema.generateDataClasses()
| ### Plugins | ||
|
|
||
| > The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases. | ||
| > The KSP plugin is currently non-functional. |
There was a problem hiding this comment.
no it isn't. It should still work, but, it's also gonna be deprecated, otherwise we'd need to migrate to KSP2
There was a problem hiding this comment.
Well, it's true for Kotlin 2.1+, but we don't want users to use for now, so I'd write it like it is.
There was a problem hiding this comment.
I'm not sure if we use them, but check the DocumentationUrls.kt in the project whenever we rename documentation md files. This does change the url, namely.
There was a problem hiding this comment.
Ok. But only changing file names affects URL, moving in other folder doesn't.
|
|
||
| ## KSP Plugin | ||
|
|
||
| > The KSP plugin is **not compatible with Kotlin 2.1 or newer**. |
There was a problem hiding this comment.
Is that true?
They just need to add ksp.useKSP2=false afaik. I don't know how long KSP will support KSP1, but while they do, KSP will work fine. DataFrame targets Kotlin 2.2 and it works fine after all ;)
There was a problem hiding this comment.
(We even provide an error from the gradle plugin when they try to use KSP2 and tell them how to solve it :) )
There was a problem hiding this comment.
Agree with @Jolanrensen here, unfortunately we need to communicate this problem
# Conflicts: # docs/StardustDocs/topics/schemas/DataSchemaGenerationMethods.md
