Enhance Room Plugin with Schema Export Support #160
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces the
RoomOptionsExtension
to configure schema export settings for the Android Room Convention Plugin. TheRoomOptionsExtension
allows you to fine-tune the behavior of schema export, which is essential for Room database auto migrations and version management.Changes Made
RoomOptionsExtension
to provide schema export configuration options.RoomOptions
extension.How to Use
To configure schema export, you can make use of the
roomOptions
extension in your build.gradle.kts or build.gradle files. For instance, by settingenableSchemaProvider = true
, you enable schema export. You can also specify the directory where the schema files are stored usingschemasPath
. For example:This use case would enable schema export and set the schema directory to "custom_schemas_directory." It ensures that schema files are available for Room auto migrations and version management.
For more details and the benefits of schema export, please refer to the Room documentation on Exporting Schemas.