df-research/dataframe/docs/StardustDocs/topics/schemas/Migration-From-Plugins.md

Migration from Gradle/KSP Plugin

Gradle and KSP plugins were useful tools in earlier versions of Kotlin DataFrame.
However, they are now being phased out. This section provides an overview of their current state and migration guidance.

Gradle Plugin

Do not confuse this with the compiler plugin, which is a Kotlin compiler plugin and has a different plugin ID.
{style="note"}

1. Generation of data schemas from data sources
   (files, databases, or external URLs).

   • You could copy already generated schemas from build/generate into your project sources.
   • To generate a DataSchema for a DataFrame now, use the generate..() methods.

2. Generation of extension properties from data schemas
   This is now handled by the compiler plugin, which:

   • Generates extension properties for declared data schemas.
   • Automatically updates the schema and regenerates properties after structural DataFrame operations.

The Gradle plugin still works and may be helpful for generating schemas from data sources.
However, it is planned for deprecation, and we do not recommend using it going forward.
{style="warning"}

If you still choose to use Gradle plugin, make sure to disable the automatic KSP plugin dependency to avoid compatibility issues with Kotlin 2.1+ by adding this line to gradle.properties:

kotlin.dataframe.add.ksp=false

KSP Plugin

• Generation of data schemas from data sources
  (files, databases, or external URLs).
  • You could copy already generated schemas from build/generate/ksp into your project sources.
  • To generate a DataSchema for a DataFrame now, use the
    generate..() methods instead.

The KSP plugin is not compatible with KSP2 and may not work properly with Kotlin 2.1 or newer.
It is planned for deprecation or major changes, and we do not recommend using it at this time.
{style="warning"}

If you still choose to use the KSP plugin with Kotlin 2.1+, disable KSP2 by adding this line to gradle.properties:

ksp.useKSP2=false