me.piggypiglet.framework.mysql.utils

Class MySQLUtils

java.lang.Object

me.piggypiglet.framework.mysql.utils.MySQLUtils

public final class MySQLUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MySQLUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.concurrent.CompletableFuture<java.lang.Boolean>	create(java.lang.String table, java.util.Map<java.lang.String,java.lang.Object> values) Create a row in a table.
static java.util.concurrent.CompletableFuture<java.lang.Boolean>	exists(java.lang.String table, java.util.Map<java.lang.String,java.lang.Object> location) Check if a row exists at a specific location
static java.util.concurrent.CompletableFuture<co.aikar.idb.DbRow>	getRow(java.lang.String table, java.util.Map<java.lang.String,java.lang.Object> location) Get a row from a location
static java.util.concurrent.CompletableFuture<java.util.List<co.aikar.idb.DbRow>>	getRows(java.lang.String table) Get all rows in a table
static java.util.concurrent.CompletableFuture<java.lang.Boolean>	isReady() See whether MySQL is ready for operation
static java.util.concurrent.CompletableFuture<java.lang.Boolean>	remove(java.lang.String table, java.util.Map<java.lang.String,java.lang.Object> location) Remove a specific row at a location
static java.util.concurrent.CompletableFuture<java.lang.Boolean>	set(java.lang.String table, java.util.Map<java.lang.String,java.lang.Object> location, java.util.Map<java.lang.String,java.lang.Object> replace) Edit a pre-existing row in a table with new values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MySQLUtils

public MySQLUtils()

Method Detail

isReady

public static java.util.concurrent.CompletableFuture<java.lang.Boolean> isReady()

See whether MySQL is ready for operation

Returns:

CompletableFuture of current mysql status

create

public static java.util.concurrent.CompletableFuture<java.lang.Boolean> create(java.lang.String table,
                                                                               java.util.Map<java.lang.String,java.lang.Object> values)

Create a row in a table.

Parameters:

table - Table name

values - Row values

Returns:

CompletableFuture of whether the operation was succeeded.

set

public static java.util.concurrent.CompletableFuture<java.lang.Boolean> set(java.lang.String table,
                                                                            java.util.Map<java.lang.String,java.lang.Object> location,
                                                                            java.util.Map<java.lang.String,java.lang.Object> replace)

Edit a pre-existing row in a table with new values

Parameters:

table - Table name

location - Location of the row

replace - Column names and their values to replace

Returns:

boolean of whether the operation was successful

getRow

public static java.util.concurrent.CompletableFuture<co.aikar.idb.DbRow> getRow(java.lang.String table,
                                                                                java.util.Map<java.lang.String,java.lang.Object> location)

Get a row from a location

Parameters:

table - Table name

location - Location of the row

Returns:

CompletableFuture of DbRow

getRows

public static java.util.concurrent.CompletableFuture<java.util.List<co.aikar.idb.DbRow>> getRows(java.lang.String table)

Get all rows in a table

Parameters:

table - Table name

Returns:

CompletableFuture of list of DbRows

remove

public static java.util.concurrent.CompletableFuture<java.lang.Boolean> remove(java.lang.String table,
                                                                               java.util.Map<java.lang.String,java.lang.Object> location)

Remove a specific row at a location

Parameters:

table - Table name

location - Location of row to remove

Returns:

CompletableFuture of whether the operation was successful

exists

public static java.util.concurrent.CompletableFuture<java.lang.Boolean> exists(java.lang.String table,
                                                                               java.util.Map<java.lang.String,java.lang.Object> location)

Check if a row exists at a specific location

Parameters:

table - Table name

location - Location of the row

Returns:

CompletableFuture of whether the row exists or not