Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.mysql

Class Database

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,Database>

com.aoindustries.aoserv.client.CachedObject<Integer,Database>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<Database>

com.aoindustries.aoserv.client.mysql.Database

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, Dumpable, JdbcProvider, Removable, SingleTableObject<Integer,Database>

public final class Database
extends CachedObjectIntegerKey<Database>
implements Removable, Dumpable, JdbcProvider

A Database corresponds to a unique MySQL table space on one server. The database name must be unique per server and, to aid in account portability, will typically be unique across the entire system.

Author:

AO Industries, Inc.

See Also:

• DatabaseUser

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Database.CheckTableResult
static enum	Database.Engine
static final class	Database.Name	Represents a name that may be used for a Database.
static class	Database.TableStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CENTOS_7_JDBC_DOCUMENTATION_URL	The URL for MySQL JDBC documentation.
static final String	CENTOS_7_JDBC_DRIVER	The classname of the JDBC driver used for the Database.
static final String	CENTOS_JDBC_DOCUMENTATION_URL	The URL for MySQL JDBC documentation.
static final String	CENTOS_JDBC_DRIVER	The classname of the JDBC driver used for the Database.
static final Charset	DUMP_ENCODING	The character set used by the dumps.
static final Database.Name	INFORMATION_SCHEMA	MySQL.
static final Database.Name	MYSQL	The root database for a MySQL installation.
static final Database.Name	MYSQLMON	Monitoring.
static final Database.Name	PERFORMANCE_SCHEMA	MySQL.
static final String	ROCKY_9_JDBC_DOCUMENTATION_URL	The URL for MySQL JDBC documentation.
static final String	ROCKY_9_JDBC_DRIVER	The classname of the JDBC driver used for the Database.
static final Database.Name	SYS	MySQL.

Fields inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.CachedObject

table

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
Database()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
int	addMysqlServerUser(UserServer msu, boolean canSelect, boolean canInsert, boolean canUpdate, boolean canDelete, boolean canCreate, boolean canDrop, boolean canReference, boolean canIndex, boolean canAlter, boolean canCreateTempTable, boolean canLockTables, boolean canCreateView, boolean canShowView, boolean canCreateRoutine, boolean canAlterRoutine, boolean canExecute, boolean canEvent, boolean canTrigger)	Deprecated. Please call DatabaseUserTable.addMysqlDbUser(com.aoindustries.aoserv.client.mysql.Database, com.aoindustries.aoserv.client.mysql.UserServer, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) directly
List<Database.CheckTableResult>	checkTables(MysqlReplication mysqlSlave, Collection<TableName> tableNames)	Gets the table status on the master server or provided slave server.
List<Database.CheckTableResult>	checkTables(Collection<TableName> tableNames)	Gets the table status on the master server.
void	dump(boolean gzip, StreamHandler streamHandler)	Dumps the database in DUMP_ENCODING encoding into binary form, optionally gzipped.
void	dump(PrintWriter out)	Dumps the contents of this object into a PrintWriter.
void	dump(Writer out)	Dumps the database into textual representation, not gzipped.
List<CannotRemoveReason<Database>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
String	getJdbcDocumentationUrl()	Gets the URL of the JDBC documentation.
String	getJdbcDriver()	Gets the classname of the driver used to contact the server.
String	getJdbcUrl(boolean ipOnly)	Gets the URL that should be used for JDBC connections.
AlertLevel	getMaxCheckTableAlertLevel()
DatabaseUser	getMysqlDbUser(UserServer msu)
List<DatabaseUser>	getMysqlDbUsers()
Server	getMysqlServer()
int	getMysqlServer_id()
List<UserServer>	getMysqlServerUsers()
Database.Name	getName()
Package	getPackage()
Account.Name	getPackage_name()
Table.TableId	getTableId()
List<Database.TableStatus>	getTableStatus()	Gets the table status on the master server.
List<Database.TableStatus>	getTableStatus(MysqlReplication mysqlSlave)	Gets the table status on the master server or provided slave server.
void	init(ResultSet result)	Initializes this object from the raw database contents.
static boolean	isSafeName(String name)	Deprecated. Use instead
boolean	isSpecial()
static boolean	isSpecial(Database.Name name)	Special MySQL databases may not be added or removed.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

equals, getKey, getPkey, hashCode

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

Methods inherited from class com.aoindustries.aoserv.client.AoservObject

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CENTOS_JDBC_DRIVER

public static final String CENTOS_JDBC_DRIVER

The classname of the JDBC driver used for the Database.

See Also:

• Constant Field Values

CENTOS_7_JDBC_DRIVER

public static final String CENTOS_7_JDBC_DRIVER

The classname of the JDBC driver used for the Database.

See Also:

• Constant Field Values

ROCKY_9_JDBC_DRIVER

public static final String ROCKY_9_JDBC_DRIVER

The classname of the JDBC driver used for the Database.

See Also:

• Constant Field Values

CENTOS_JDBC_DOCUMENTATION_URL

public static final String CENTOS_JDBC_DOCUMENTATION_URL

The URL for MySQL JDBC documentation.

See Also:

• Constant Field Values

CENTOS_7_JDBC_DOCUMENTATION_URL

public static final String CENTOS_7_JDBC_DOCUMENTATION_URL

The URL for MySQL JDBC documentation.

See Also:

• Constant Field Values

ROCKY_9_JDBC_DOCUMENTATION_URL

public static final String ROCKY_9_JDBC_DOCUMENTATION_URL

The URL for MySQL JDBC documentation.

See Also:

• Constant Field Values

MYSQL

public static final Database.Name MYSQL

The root database for a MySQL installation.

INFORMATION_SCHEMA

public static final Database.Name INFORMATION_SCHEMA

MySQL.

PERFORMANCE_SCHEMA

public static final Database.Name PERFORMANCE_SCHEMA

MySQL.

SYS

public static final Database.Name SYS

MySQL.

MYSQLMON

public static final Database.Name MYSQLMON

Monitoring.

DUMP_ENCODING

public static final Charset DUMP_ENCODING

The character set used by the dumps.

Constructor Details

Database

@Deprecated
public Database()

Deprecated.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

isSpecial

public static boolean isSpecial(Database.Name name)

Special MySQL databases may not be added or removed.

addMysqlServerUser

@Deprecated
public int addMysqlServerUser(UserServer msu,
 boolean canSelect,
 boolean canInsert,
 boolean canUpdate,
 boolean canDelete,
 boolean canCreate,
 boolean canDrop,
 boolean canReference,
 boolean canIndex,
 boolean canAlter,
 boolean canCreateTempTable,
 boolean canLockTables,
 boolean canCreateView,
 boolean canShowView,
 boolean canCreateRoutine,
 boolean canAlterRoutine,
 boolean canExecute,
 boolean canEvent,
 boolean canTrigger)
                       throws IOException,
SQLException

Deprecated.

Please call DatabaseUserTable.addMysqlDbUser(com.aoindustries.aoserv.client.mysql.Database, com.aoindustries.aoserv.client.mysql.UserServer, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) directly

Throws:

IOException

SQLException

dump

public void dump(PrintWriter out)
          throws IOException,
SQLException

Dumps the contents of this object into a PrintWriter.

Specified by:

dump in interface Dumpable

Throws:

IOException

SQLException

See Also:

• dump(java.io.Writer)

dump

public void dump(Writer out)
          throws IOException,
SQLException

Dumps the database into textual representation, not gzipped.

Throws:

IOException

SQLException

dump

public void dump(boolean gzip,
 StreamHandler streamHandler)
          throws IOException,
SQLException

Dumps the database in DUMP_ENCODING encoding into binary form, optionally gzipped.

Throws:

IOException

SQLException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Database>

getJdbcDriver

public String getJdbcDriver()
                     throws SQLException,
IOException

Description copied from interface: JdbcProvider

Gets the classname of the driver used to contact the server.

Specified by:

getJdbcDriver in interface JdbcProvider

Throws:

SQLException

IOException

getJdbcUrl

public String getJdbcUrl(boolean ipOnly)
                  throws SQLException,
IOException

Description copied from interface: JdbcProvider

Gets the URL that should be used for JDBC connections.

Specified by:

getJdbcUrl in interface JdbcProvider

Throws:

SQLException

IOException

getJdbcDocumentationUrl

public String getJdbcDocumentationUrl()
                               throws SQLException,
IOException

Description copied from interface: JdbcProvider

Gets the URL of the JDBC documentation.

Specified by:

getJdbcDocumentationUrl in interface JdbcProvider

Throws:

SQLException

IOException

getMysqlDbUser

public DatabaseUser getMysqlDbUser(UserServer msu)
                            throws IOException,
SQLException

Throws:

IOException

SQLException

getMysqlDbUsers

public List<DatabaseUser> getMysqlDbUsers()
                                   throws IOException,
SQLException

Throws:

IOException

SQLException

getMysqlServerUsers

public List<UserServer> getMysqlServerUsers()
                                     throws IOException,
SQLException

Throws:

IOException

SQLException

getName

public Database.Name getName()

isSpecial

public boolean isSpecial()

getPackage_name

public Account.Name getPackage_name()

getPackage

public Package getPackage()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getMysqlServer_id

public int getMysqlServer_id()

getMysqlServer

public Server getMysqlServer()
                      throws SQLException,
IOException

Throws:

SQLException

IOException

getMaxCheckTableAlertLevel

public AlertLevel getMaxCheckTableAlertLevel()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Database>

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<Integer,Database>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,Database>

Throws:

IOException

getCannotRemoveReasons

public List<CannotRemoveReason<Database>> getCannotRemoveReasons()
                                                          throws SQLException,
IOException

Description copied from interface: Removable

Lists the reasons an object may not be removed.

Specified by:

getCannotRemoveReasons in interface Removable

Returns:

an empty List<CannotRemoveReason> if this object may be removed, or a list of descriptions

Throws:

SQLException

IOException

remove

public void remove()
            throws IOException,
SQLException

Description copied from interface: Removable

Removes this object, and all dependant objects, from the system.

Specified by:

remove in interface Removable

Throws:

IOException

SQLException

toStringImpl

public String toStringImpl()

Description copied from class: AoservObject

AoservObject.toString() implementation that is allowed to throw exceptions.

Implementation Note:
This default implementation calls AoservObject.toString() on the key (from AoservObject.getKey()). When the key is null, uses the default implementation from Object.toString().

Overrides:

toStringImpl in class CachedObjectIntegerKey<Database>

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<Integer,Database>

Throws:

IOException

getTableStatus

public List<Database.TableStatus> getTableStatus()
                                          throws IOException,
SQLException

Gets the table status on the master server.

Throws:

IOException

SQLException

getTableStatus

public List<Database.TableStatus> getTableStatus(MysqlReplication mysqlSlave)
                                          throws IOException,
SQLException

Gets the table status on the master server or provided slave server.

Throws:

IOException

SQLException

checkTables

public List<Database.CheckTableResult> checkTables(Collection<TableName> tableNames)
                                            throws IOException,
SQLException

Gets the table status on the master server.

Throws:

IOException

SQLException

checkTables

public List<Database.CheckTableResult> checkTables(MysqlReplication mysqlSlave,
 Collection<TableName> tableNames)
                                            throws IOException,
SQLException

Gets the table status on the master server or provided slave server.

Throws:

IOException

SQLException

isSafeName

@Deprecated
public static boolean isSafeName(String name)

Deprecated.

Use instead

Determines if a name is safe for use as a table/column name, the name identifier should be enclosed with backticks (`).