Package fr.prodrivers.bukkit.commons.storage

Class EbeanProvider

java.lang.Object
fr.prodrivers.bukkit.commons.storage.EbeanProvider
All Implemented Interfaces:
javax.inject.Provider<io.ebean.Database>
@Singleton public class EbeanProvider extends Object implements javax.inject.Provider<io.ebean.Database>
Ebean ORM provider for Prodrivers plugins. Requires dependency injection.

Ebean is an ORM that offers JPA-compliant facilities to interact with relational databases. Previously included directly in Spigot, Prodrivers Commons now implements it following its removal from Spigot.

EbeanProvider is intended to be used with a dependency injector. It uses two providers to build a new database instance, for DataSourceConfig and DatabaseConfig. A provider for DataSourceConfig is already made available in Prodrivers Commons' public module, while plugins should offer their own provider for DatabaseConfig. Your DatabaseConfig provider should, at least, register all classes (entities, ...) that you intend to use with Ebean, using for example the setClasses method.

Important: do not use Model.save() or Model.save(Transaction) as it will use the first registered database instead of the one you fetched the bean from. This will cause issues when having multiple plugins using Ebean.

EbeanProvider is an optional part of the plugin, meaning that the result of its methods, on top of the underlying SQL database internal quirks and wrong queries, is not guaranteed to be correct. One must check for errors when retrieving the database.

  • Method Details

    • get

      public io.ebean.Database get()
      Gets a new Ebean Database instance.
      Specified by:
      get in interface javax.inject.Provider<io.ebean.Database>
      Returns:
      Database or null