Package ch.njol.skript.variables

Class SQLStorage

java.lang.Object
ch.njol.skript.variables.VariablesStorage
ch.njol.skript.variables.SQLStorage
All Implemented Interfaces:
Closeable
Direct Known Subclasses:
MySQLStorage, SQLiteStorage
public abstract class SQLStorage extends VariablesStorage
TODO create a metadata table to store some properties (e.g. Skript version, Yggdrasil version) -- but what if some variables cannot be converted? move them to a different table? TODO create my own database connector or find a better one

  • Field Details

  • Constructor Details

    • SQLStorage

      public SQLStorage(String name, String createTableQuery)
      Creates a SQLStorage with a create table query.
      Parameters:
      name - The name to be sent through this constructor when newInstance creates this class.
      createTableQuery - The create table query to send to the SQL engine.

  • Method Details

    • getTableName

      public String getTableName()

    • setTableName

      public void setTableName(String tableName)

    • initialize

      @Nullable public abstract @Nullable lib.PatPeter.SQLibrary.Database initialize(SectionNode config)
      Initializes an SQL database with the user provided configuration section for loading the database.
      Parameters:
      config - The configuration from the config.sk that defines this database.
      Returns:
      A Database implementation from SQLibrary.

    • getFormattedCreateQuery

      @Nullable public @Nullable String getFormattedCreateQuery()
      Retrieve the create query with the tableName in it
      Returns:
      the create query with the tableName in it (%s -> tableName)

    • load_i

      protected boolean load_i(SectionNode n)
      Doesn't lock the database for reading (it's not used anywhere else, and locking while loading will interfere with loaded variables being deleted by Variables.variableLoaded(String, Object, VariablesStorage)).
      Specified by:
      load_i in class VariablesStorage
      Returns:
      Whether the database could be loaded successfully, i.e. whether the config is correct and all variables could be loaded.

    • allLoaded

      protected void allLoaded()
      Description copied from class: VariablesStorage
      Called after all storages have been loaded, and variables have been redistributed if settings have changed. This should commit the first transaction (which is not empty if variables have been moved from another database to this one or vice versa), and start repeating transactions if applicable.
      Specified by:
      allLoaded in class VariablesStorage

    • getFile

      protected File getFile(String file)
      Description copied from class: VariablesStorage
      Gets the file needed for this variable storage from the given file name.

      Will only be called if VariablesStorage.requiresFile() is true.

      Specified by:
      getFile in class VariablesStorage
      Parameters:
      file - the given file name.
      Returns:
      the File object.

    • connect

      protected boolean connect()
      Description copied from class: VariablesStorage
      (Re)connects to the database.

      Not called on the first connect: do this in VariablesStorage.load_i(SectionNode). An error should be printed by this method prior to returning false.

      Specified by:
      connect in class VariablesStorage
      Returns:
      whether the connection could be re-established.

    • disconnect

      protected void disconnect()
      Description copied from class: VariablesStorage
      Disconnects from the database.
      Specified by:
      disconnect in class VariablesStorage

    • save

      protected boolean save(String name, @Nullable @Nullable String type, @Nullable @org.jetbrains.annotations.Nullable byte[] value)
      Description copied from class: VariablesStorage
      Saves a variable.

      This is called from the main thread while variables are transferred between databases, and from the VariablesStorage.writeThread afterwards.

      type and value are both null iff this call is to delete the variable.

      Specified by:
      save in class VariablesStorage
      Parameters:
      name - the name of the variable.
      type - the type of the variable.
      value - the serialized value of the variable.
      Returns:
      Whether the variable was saved.

    • close

      public void close()
      Description copied from class: VariablesStorage
      Called when Skript gets disabled.

      The default implementation will wait for all variables to be saved before setting VariablesStorage.closed to true and stopping the write thread.

      Therefore, make sure to call super.close() if this method is overridden.

      Specified by:
      close in interface Closeable
      Overrides:
      close in class VariablesStorage

    • checkDatabase

      protected void checkDatabase()