Package com.mckoi.database.control
Class DBController
java.lang.Object
com.mckoi.database.control.DBController
An object that provides methods for creating and controlling database
systems in the current JVM.
- Author:
- Tobias Downer
-
Method Summary
Modifier and TypeMethodDescriptioncreateDatabase
(DBConfig config, String admin_user, String admin_pass) Creates a database in the local JVM (and filesystem) given the configuration in DBConfig and returns a DBSystem object.boolean
databaseExists
(DBConfig config) Returns true if a Mckoi database exists in the given directory of the file system, otherwise returns false if the path doesn't contain a database.static DBController
Returns the static controller for this JVM.startDatabase
(DBConfig config) Starts a database in the local JVM given the configuration in DBConfig and returns a DBSystem object.
-
Method Details
-
databaseExists
Returns true if a Mckoi database exists in the given directory of the file system, otherwise returns false if the path doesn't contain a database.The path string must be formatted using Unix '/' deliminators as directory separators.
- Parameters:
config
- the configuration of the database to check the existence of.- Returns:
- true if a database exists at the given path, false otherwise.
-
createDatabase
Creates a database in the local JVM (and filesystem) given the configuration in DBConfig and returns a DBSystem object. When this method returns, the database created will be up and running providing there was no failure during the database creation process.A failure might happen because the database path does not exist.
- Parameters:
admin_user
- the username of the administrator for the new database.admin_pass
- the password of the administrator for the new database.config
- the configuration of the database to create and start in the local JVM.- Returns:
- the DBSystem object used to access the database created.
-
startDatabase
Starts a database in the local JVM given the configuration in DBConfig and returns a DBSystem object. When this method returns, the database will be up and running providing there was no failure to initialize the database.A failure might happen if the database does not exist in the path given in the configuration.
- Parameters:
config
- the configuration of the database to start in the local JVM.- Returns:
- the DBSystem object used to access the database started.
-
getDefault
Returns the static controller for this JVM.
-