Interface LocalBootable

All Known Implementing Classes:
DefaultLocalBootable

public interface LocalBootable
An interface that is implemented by an object that boots up the database. This is provided as an interface so that we aren't dependant on the entire database when compiling the JDBC code.
Author:
Tobias Downer
  • Method Summary

    Modifier and Type
    Method
    Description
    boot(DBConfig config)
    Boots the database with the given configuration.
    boolean
    Attempts to test if the database exists or not.
    Connects this interface to the database currently running in this JVM.
    create(String username, String password, DBConfig config)
    Attempts to create a new database system with the given name, and the given username/password as the admin user for the system.
    boolean
    Returns true if there is a database currently booted in the current JVM.
  • Method Details

    • create

      DatabaseInterface create(String username, String password, DBConfig config) throws SQLException
      Attempts to create a new database system with the given name, and the given username/password as the admin user for the system. Once created, the newly created database will be booted up.
      Parameters:
      config - the configuration variables.
      Throws:
      SQLException
    • boot

      Boots the database with the given configuration.
      Parameters:
      config - the configuration variables.
      Throws:
      SQLException
    • checkExists

      boolean checkExists(DBConfig config) throws SQLException
      Attempts to test if the database exists or not. Returns true if the database exists.
      Parameters:
      config - the configuration variables.
      Throws:
      SQLException
    • isBooted

      boolean isBooted() throws SQLException
      Returns true if there is a database currently booted in the current JVM. Otherwise returns false.
      Throws:
      SQLException
    • connectToJVM

      DatabaseInterface connectToJVM() throws SQLException
      Connects this interface to the database currently running in this JVM.
      Throws:
      SQLException