Skip to content

Commit 87d5c95

Browse files
data schemas plugins changes
1 parent 2e14838 commit 87d5c95

File tree

3 files changed

+22
-9
lines changed

3 files changed

+22
-9
lines changed

docs/StardustDocs/topics/FAQ.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,9 @@ and examples with beautiful [Kandy](https://kotlin.github.io/kandy) geo visualiz
174174

175175
> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated
176176
> in future releases.
177-
>
178-
> The KSP plugin is **not compatible with Kotlin 2.1 or newer**.
177+
>
178+
> The KSP plugin is **not compatible with [KSP2](https://github.com/google/ksp?tab=readme-ov-file#ksp2-is-here)**
179+
> and may **not work properly with Kotlin 2.1 or newer**.
179180
>
180181
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead
181182
> of relying on the plugins.

docs/StardustDocs/topics/schemas/Migration-From-Plugins.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ However, they are now being phased out. This section provides an overview of the
2424
> However, it is planned for deprecation, and **we do not recommend using it going forward**.
2525
> {style="warning"}
2626
27-
If you still choose to use it, make sure to disable the automatic KSP dependency
27+
If you still choose to use Gradle plugin, make sure to disable the automatic KSP plugin dependency
2828
to avoid compatibility issues with Kotlin 2.1+ by adding this line to `gradle.properties`:
2929

3030
```properties
@@ -33,12 +33,21 @@ kotlin.dataframe.add.ksp=false
3333

3434
## KSP Plugin
3535

36-
> The KSP plugin is **not compatible with Kotlin 2.1 or newer**.
37-
> It is planned for deprecation or major changes, and **we do not recommend using it at this time**.
38-
> {style="warning"}
39-
4036
- **Generation of [data schemas](schemas.md)** from data sources
4137
(files, databases, or external URLs).
4238
- You could copy already generated schemas from `build/generate/ksp` into your project sources.
4339
- To generate a `DataSchema` for a [`DataFrame`](DataFrame.md) now, use the
4440
[`generate..()` methods](DataSchemaGenerationMethods.md) instead.
41+
42+
> The KSP plugin is **not compatible with [KSP2](https://github.com/google/ksp?tab=readme-ov-file#ksp2-is-here)**
43+
> and may **not work properly with Kotlin 2.1 or newer**.
44+
> It is planned for deprecation or major changes, and **we do not recommend using it at this time**.
45+
> {style="warning"}
46+
47+
If you still choose to use the KSP plugin with Kotlin 2.1+,
48+
disable [KSP2](https://github.com/google/ksp?tab=readme-ov-file#ksp2-is-here)
49+
by adding this line to `gradle.properties`:
50+
51+
```properties
52+
ksp.useKSP2=false
53+
```

docs/StardustDocs/topics/schemas/schemas.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,11 @@ It will also **automatically update** the schema during operations that modify t
107107
108108
### Plugins
109109

110-
> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases.
111-
> The KSP plugin is currently non-functional.
110+
> The current Gradle plugin is **under consideration for deprecation** and
111+
> may be officially marked as deprecated in future releases.
112+
>
113+
> The KSP plugin is **not compatible with [KSP2](https://github.com/google/ksp?tab=readme-ov-file#ksp2-is-here)**
114+
> and may **not work properly with Kotlin 2.1 or newer**.
112115
>
113116
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugins.
114117
{style="warning"}

0 commit comments

Comments
 (0)