Top Description Inners Methods
com.mysql.cj.xdevapi

public Interface DatabaseObject

Known Direct Subinterfaces
com.mysql.cj.xdevapi.Schema, com.mysql.cj.xdevapi.Table, com.mysql.cj.xdevapi.Collection
A client-side representation of X Plugin server object, e.g. table, collection, etc.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
DatabaseObject.DbObjectStatus

Existence states of database objects.

public static enum
DatabaseObject.DbObjectType

Type of database objects.

Method Summary

Modifier and TypeMethod and Description
public DatabaseObject.DbObjectStatus

Returns:

DbObjectStatus
existsInDatabase()

Query the existence of this database object.

public String

Returns:

name
getName()

Retrieve the name of the database object represented by the Java object.

public Schema

Returns:

Schema
getSchema()

Retrieve the schema owning this database object.

public Session

Returns:

Session
getSession()

Retrieve the session owning the given schema object.

Method Detail

existsInDatabaseback to summary
public DatabaseObject.DbObjectStatus existsInDatabase()

Query the existence of this database object.

Returns:DatabaseObject.DbObjectStatus

DbObjectStatus

getNameback to summary
public String getName()

Retrieve the name of the database object represented by the Java object.

Returns:String

name

getSchemaback to summary
public Schema getSchema()

Retrieve the schema owning this database object.

Returns:Schema

Schema

getSessionback to summary
public Session getSession()

Retrieve the session owning the given schema object.

Returns:Session

Session

com.mysql.cj.xdevapi back to summary

public final Enum DatabaseObject.DbObjectStatus

extends Enum<DatabaseObject.DbObjectStatus>
Class Inheritance
Existence states of database objects.

Field Summary

Modifier and TypeField and Description
public static final DatabaseObject.DbObjectStatus
EXISTS

public static final DatabaseObject.DbObjectStatus
NOT_EXISTS

public static final DatabaseObject.DbObjectStatus
UNKNOWN

Constructor Summary

AccessConstructor and Description
private
DbObjectStatus()

Method Summary

Modifier and TypeMethod and Description
public static DatabaseObject.DbObjectStatus
valueOf(String name)

public static DatabaseObject.DbObjectStatus[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

EXISTSback to summary
public static final DatabaseObject.DbObjectStatus EXISTS
NOT_EXISTSback to summary
public static final DatabaseObject.DbObjectStatus NOT_EXISTS
UNKNOWNback to summary
public static final DatabaseObject.DbObjectStatus UNKNOWN

Constructor Detail

DbObjectStatusback to summary
private DbObjectStatus()

Method Detail

valueOfback to summary
public static DatabaseObject.DbObjectStatus valueOf(String name)
valuesback to summary
public static DatabaseObject.DbObjectStatus[] values()
com.mysql.cj.xdevapi back to summary

public final Enum DatabaseObject.DbObjectType

extends Enum<DatabaseObject.DbObjectType>
Class Inheritance
Type of database objects.

Field Summary

Modifier and TypeField and Description
public static final DatabaseObject.DbObjectType
COLLECTION

public static final DatabaseObject.DbObjectType
COLLECTION_VIEW

public static final DatabaseObject.DbObjectType
TABLE

public static final DatabaseObject.DbObjectType
VIEW

Constructor Summary

AccessConstructor and Description
private
DbObjectType()

Method Summary

Modifier and TypeMethod and Description
public static DatabaseObject.DbObjectType
valueOf(String name)

public static DatabaseObject.DbObjectType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

COLLECTIONback to summary
public static final DatabaseObject.DbObjectType COLLECTION
COLLECTION_VIEWback to summary
public static final DatabaseObject.DbObjectType COLLECTION_VIEW
TABLEback to summary
public static final DatabaseObject.DbObjectType TABLE
VIEWback to summary
public static final DatabaseObject.DbObjectType VIEW

Constructor Detail

DbObjectTypeback to summary
private DbObjectType()

Method Detail

valueOfback to summary
public static DatabaseObject.DbObjectType valueOf(String name)
valuesback to summary
public static DatabaseObject.DbObjectType[] values()