net.risingworld.api.database

Interface WorldDatabase

public interface WorldDatabase

Provides access to the current world database.

Method Summary

Modifier and Type	Method and Description
void	execute(java.lang.String sql) Executes the given SQL statement, for example a CREATE or DELETE statement.
java.sql.ResultSet	executeQuery(java.lang.String sql) Executes the given SQL statement and returns a ResultSet object.
void	executeUpdate(java.lang.String sql) Executes the given SQL statement, which may be an INSERT, UPDATE or DELETE statement.
Chunk	getChunkFromDb(int cx, int cy, int cz) Gets a chunk from the database.
ChunkLOD	getChunkLODFromDb(int cx, int cz) Gets an LOD chunk from the database.
java.lang.String	getDatabaseName() Gets the database name.
java.lang.String	getPath() Gets the path to the database (when using MySQL, this function gets the IP and port of the MySQL server).
DatabaseType	getType() Gets the database type.
java.lang.String	getWorldInfo(java.lang.String key) Gets a value from the WorldInfos table.
void	saveChunkLODToDb(ChunkLOD chunkLOD) Saves a ChunkLOD to the database.
void	saveChunkToDb(Chunk chunk) Saves a Chunk to the database.
void	setWorldInfo(java.lang.String key, java.lang.String value) Sets a key/value in the WorldInfos table.

Method Detail

getType

DatabaseType getType()

Gets the database type.

Returns:

the database type, SQLite (default) or MySQL

Example:

1	WorldDatabase worldDB = getWorldDatabase();
2
3	if(worldDB.getType() == DatabaseType.SQLite){
4	System.out.println("World uses an SQLite database");
5	}
6	else if(worldDB.getType() == DatabaseType.MySQL){
7	System.out.println("World uses a MySQL database");
8	}

getPath

java.lang.String getPath()

Gets the path to the database (when using MySQL, this function gets the IP and port of the MySQL server).

Returns:

the path to the database (SQLite), or IP and port (MySQL).

getDatabaseName

java.lang.String getDatabaseName()

Gets the database name.

Returns:

the database name.

getWorldInfo

java.lang.String getWorldInfo(java.lang.String key)

Gets a value from the WorldInfos table.
Valid keys (tbc): Gamemode, Seed, Version, Worldtype, Caves, Vegetations, OreAmount, DisabledNPCs, Creationdate, Spawnposition, Spawnrotation, Time, Spawninventory

Parameters:

key - the key.

Returns:

the value which belongs to the according key.

setWorldInfo

void setWorldInfo(java.lang.String key,
                  java.lang.String value)

Sets a key/value in the WorldInfos table. This function can also be used to create new keys in the table. Be careful that this may interfere with future updates of the game!

Please note: In order to synchronize any commits to the database, this statement may be executed with a minor delay (usually just a few ticks)

Parameters:

key - the key you want to set.

value - the according value.

getChunkFromDb

Chunk getChunkFromDb(int cx,
                     int cy,
                     int cz)

Gets a chunk from the database. The result is stored in a Chunk object. Note that this function always reads the chunk from the database, if there is a cached version of the same chunk in the memory, it is not taken into account.

Parameters:

cx - the x chunk offset.

cy - the y chunk offset.

cz - the z chunk offset.

Returns:

a Chunk object which represents the chunk.

saveChunkToDb

void saveChunkToDb(Chunk chunk)

Saves a Chunk to the database.

Parameters:

chunk - the chunk you want to save.

getChunkLODFromDb

ChunkLOD getChunkLODFromDb(int cx,
                           int cz)

Gets an LOD chunk from the database. The result is stored in a ChunkLOD object. Note that this function always reads the LOD chunk from the database, if there is a cached version of the same LOD chunk in the memory, it is not taken into account.

Parameters:

cx - the x chunk offset.

cz - the z chunk offset.

Returns:

a ChunkLOD object which represents the LOD chunk.

saveChunkLODToDb

void saveChunkLODToDb(ChunkLOD chunkLOD)

Saves a ChunkLOD to the database.

Parameters:

chunkLOD - the LOD chunk you want to save.

execute

void execute(java.lang.String sql)

Executes the given SQL statement, for example a CREATE or DELETE statement.

Please note: In order to synchronize any commits to the database, this statement may be executed with a minor delay (usually just a few ticks)

Parameters:

sql - the SQL statement.

Example: Create a new table in world database

1	WorldDatabase db = getWorldDatabase();
2	//Creates a new table "MyTable" with columns "ID" (primary, auto-incr.), "Name" (String, 64 chars) and "Value" (int)
3	db.execute("CREATE TABLE IF NOT EXISTS `MyTable` (`ID` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `Name` VARCHAR(64), `Value` INTEGER)");

executeUpdate

void executeUpdate(java.lang.String sql)

Executes the given SQL statement, which may be an INSERT, UPDATE or DELETE statement.

Please note: In order to synchronize any commits to the database, this statement may be executed with a minor delay (usually just a few ticks)

Parameters:

sql - the SQL statement, INSERT, UPDATE or DELETE.

Example: Delete a player from player database

1	WorldDatabase db = getWorldDatabase();
2	db.executeUpdate("DELETE FROM `Player` WHERE `Name` = 'Testplayer'");

executeQuery

java.sql.ResultSet executeQuery(java.lang.String sql)
                         throws java.sql.SQLException

Executes the given SQL statement and returns a ResultSet object.
Remember to close the ResultSet once you're ready.

Parameters:

sql - the SQL statement, typically a SELECT statement.

Returns:

a ResultSet object containing the data produced by the given SQL statement.

Throws:

java.sql.SQLException - If a database access error occurs.

Example: Read playerdata from database

1	WorldDatabase db = getWorldDatabase();
2	try(ResultSet result = db.executeQuery("SELECT * FROM `Player` WHERE `Name` = 'Testplayer'")){
3	if(result.next()){
4	int onlinetime = result.getInt("OnlineTime");
5	int health = result.getInt("Health");
6	int hunger = result.getInt("Hunger");
7	String position = result.getString("Position"); //Position is stored as string
8	//...
9	}
10	}
11	catch(SQLException e){
12	//SQL Exception occurred
13	}