Skip to content

aviate: Update doc to reflect default migration aviate config #608

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.

Sign up for GitHub

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
sbrossie merged 1 commit into from
Apr 16, 2025
Merged

aviate: Update doc to reflect default migration aviate config #608

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions userguide/aviate/how-to-install-the-aviate-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,17 @@ Replace `<token>` with your cloudsmith token. Replace `<version>` with the plugi

*Step 2 - Create Plugin Database Tables*

In order to create the plugin tables, run the https://docs.killbill.io/latest/aviate-mysql-ddl.sql[Aviate MySQL DDL] or https://docs.killbill.io/latest/aviate-postgresql-ddl.sql[Aviate PostgreSQL DDL] depending on your database.

Alternatively, you can let Flyway handle the database table creation for you. For this you need to ensure that KB is started with the following property:
The aviate plugin has configured to run the database migrations by default. This behavior can be disabled by setting the following property to `false`:

[source, bash]
----
com.killbill.billing.plugin.aviate.enableMigrations=true
com.killbill.billing.plugin.aviate.enableMigrations=false
----

When this property has been set to false, latest schema can be installed manually from the following links - depending on your database engine:
* https://docs.killbill.io/latest/aviate-mysql-ddl.sql[Aviate MySQL DDL]
* https://docs.killbill.io/latest/aviate-postgresql-ddl.sql[Aviate PostgreSQL DDL]

Refer to the https://docs.killbill.io/latest/userguide_configuration.html[__Kill Bill Configuration Guide__] to know more about setting configuration properties.

*Step 3 - Start the Plugin*
Expand Down
Loading