Top Description Fields Constructors Methods
com.mysql.cj.xdevapi

public Class SchemaImpl

extends Object
implements Schema
Class Inheritance
All Implemented Interfaces
com.mysql.cj.xdevapi.Schema, com.mysql.cj.xdevapi.DatabaseObject
Imports
java.util.Arrays, .List, .Set, java.util.function.Function, .Predicate, java.util.stream.Collectors, com.mysql.cj.Messages, .MysqlxSession, com.mysql.cj.exceptions.ExceptionFactory, .MysqlErrorNumbers, .WrongArgumentException, com.mysql.cj.protocol.x.XMessage, .XMessageBuilder, .XProtocolError, com.mysql.cj.result.StringValueFactory, .ValueFactory

Schema implementation.

Field Summary

Modifier and TypeField and Description
private MysqlxSession
private String
private Session
private ValueFactory<String>
private XMessageBuilder

Constructor Summary

AccessConstructor and Description
pack-priv
SchemaImpl(MysqlxSession mysqlxSession, Session session, String name)

Method Summary

Modifier and TypeMethod and Description
public Collection
createCollection(String
collection name
collectionName
)

Implements com.mysql.cj.xdevapi.Schema.createCollection.

Create a new collection.

public Collection
createCollection(String
collection name
collectionName
,
boolean
true if allowed to reuse
reuseExisting
)

Implements com.mysql.cj.xdevapi.Schema.createCollection.

Create a new collection if it does not already exist on the server.

public Collection
createCollection(String
collection name
collectionName
,
Schema.CreateCollectionOptions
reuseExisting, validation level and JSON schema options
options
)

Implements com.mysql.cj.xdevapi.Schema.createCollection.

Create a new collection.

public void
dropCollection(String
name of collection to drop
collectionName
)

Implements com.mysql.cj.xdevapi.Schema.dropCollection.

Drop the collection from this schema.

public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public DatabaseObject.DbObjectStatus
existsInDatabase()

Implements com.mysql.cj.xdevapi.DatabaseObject.existsInDatabase.

Query the existence of this database object.

public Collection
getCollection(String
collection name
collectionName
)

Implements com.mysql.cj.xdevapi.Schema.getCollection.

Retrieve a reference to the named collection.

public Collection
getCollection(String
collection name
collectionName
,
boolean
true if required to exist
requireExists
)

Implements com.mysql.cj.xdevapi.Schema.getCollection.

Retrieve a reference to the named collection hinting that an exception should be thrown if the collection is not known to the server.

public Table
getCollectionAsTable(String
collection name
collectionName
)

Implements com.mysql.cj.xdevapi.Schema.getCollectionAsTable.

Retrieve a reference to the named collection using the table API.

public List<Collection>
getCollections()

Implements com.mysql.cj.xdevapi.Schema.getCollections.

Retrieve the set of collections existing in this schema.

public List<Collection>
getCollections(String
match pattern
pattern
)

Implements com.mysql.cj.xdevapi.Schema.getCollections.

Retrieve the set of collections existing in this schema and matching the given pattern.

public String
getName()

Implements com.mysql.cj.xdevapi.DatabaseObject.getName.

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

public Schema
getSchema()

Implements com.mysql.cj.xdevapi.DatabaseObject.getSchema.

Retrieve the schema owning this database object.

public Session
getSession()

Implements com.mysql.cj.xdevapi.DatabaseObject.getSession.

Retrieve the session owning the given schema object.

public Table
getTable(String
table name
tableName
)

Implements com.mysql.cj.xdevapi.Schema.getTable.

Retrieve a reference to the named table.

public Table
getTable(String
table name
tableName
,
boolean
true if required to exist
requireExists
)

Implements com.mysql.cj.xdevapi.Schema.getTable.

Retrieve a reference to the named table hinting that an exception should be thrown if the collection is not known to the server.

public List<Table>
getTables()

Implements com.mysql.cj.xdevapi.Schema.getTables.

Retrieve the set of tables existing in this schema.

public List<Table>
getTables(String
match pattern
pattern
)

Implements com.mysql.cj.xdevapi.Schema.getTables.

Retrieve the set of tables existing in this schema and matching the given pattern.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
modifyCollection(String
collection name
collectionName
,
Schema.ModifyCollectionOptions
validation level and JSON schema options
options
)

Implements com.mysql.cj.xdevapi.Schema.modifyCollection.

Modify the schema validation of a collection.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

mysqlxSessionback to summary
private MysqlxSession mysqlxSession
nameback to summary
private String name
sessionback to summary
private Session session
svfback to summary
private ValueFactory<String> svf
xbuilderback to summary
private XMessageBuilder xbuilder

Constructor Detail

SchemaImplback to summary
pack-priv SchemaImpl(MysqlxSession mysqlxSession, Session session, String name)

Method Detail

createCollectionback to summary
public Collection createCollection(String collectionName)

Implements com.mysql.cj.xdevapi.Schema.createCollection.

Doc from com.mysql.cj.xdevapi.Schema.createCollection.

Create a new collection.

Parameters
collectionName:String

collection name

Returns:Collection

Collection

Annotations
@Override
createCollectionback to summary
public Collection createCollection(String collectionName, boolean reuseExisting)

Implements com.mysql.cj.xdevapi.Schema.createCollection.

Doc from com.mysql.cj.xdevapi.Schema.createCollection.

Create a new collection if it does not already exist on the server.

Parameters
collectionName:String

collection name

reuseExisting:boolean

true if allowed to reuse

Returns:Collection

Collection

Annotations
@Override
createCollectionback to summary
public Collection createCollection(String collectionName, Schema.CreateCollectionOptions options)

Implements com.mysql.cj.xdevapi.Schema.createCollection.

Doc from com.mysql.cj.xdevapi.Schema.createCollection.

Create a new collection.

Parameters
collectionName:String

collection name

options:Schema.CreateCollectionOptions

reuseExisting, validation level and JSON schema options

Returns:Collection

Collection

Annotations
@Override
dropCollectionback to summary
public void dropCollection(String collectionName)

Implements com.mysql.cj.xdevapi.Schema.dropCollection.

Doc from com.mysql.cj.xdevapi.Schema.dropCollection.

Drop the collection from this schema.

Parameters
collectionName:String

name of collection to drop

Annotations
@Override
equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
existsInDatabaseback to summary
public DatabaseObject.DbObjectStatus existsInDatabase()

Implements com.mysql.cj.xdevapi.DatabaseObject.existsInDatabase.

Doc from com.mysql.cj.xdevapi.DatabaseObject.existsInDatabase.

Query the existence of this database object.

Returns:DatabaseObject.DbObjectStatus

DbObjectStatus

Annotations
@Override
getCollectionback to summary
public Collection getCollection(String collectionName)

Implements com.mysql.cj.xdevapi.Schema.getCollection.

Doc from com.mysql.cj.xdevapi.Schema.getCollection.

Retrieve a reference to the named collection.

Parameters
collectionName:String

collection name

Returns:Collection

Collection

Annotations
@Override
getCollectionback to summary
public Collection getCollection(String collectionName, boolean requireExists)

Implements com.mysql.cj.xdevapi.Schema.getCollection.

Doc from com.mysql.cj.xdevapi.Schema.getCollection.

Retrieve a reference to the named collection hinting that an exception should be thrown if the collection is not known to the server.

Parameters
collectionName:String

collection name

requireExists:boolean

true if required to exist

Returns:Collection

Collection

Annotations
@Override
getCollectionAsTableback to summary
public Table getCollectionAsTable(String collectionName)

Implements com.mysql.cj.xdevapi.Schema.getCollectionAsTable.

Doc from com.mysql.cj.xdevapi.Schema.getCollectionAsTable.

Retrieve a reference to the named collection using the table API.

Parameters
collectionName:String

collection name

Returns:Table

Table

Annotations
@Override
getCollectionsback to summary
public List<Collection> getCollections()

Implements com.mysql.cj.xdevapi.Schema.getCollections.

Doc from com.mysql.cj.xdevapi.Schema.getCollections.

Retrieve the set of collections existing in this schema.

Returns:List<Collection>

list of Collection objects

Annotations
@Override
getCollectionsback to summary
public List<Collection> getCollections(String pattern)

Implements com.mysql.cj.xdevapi.Schema.getCollections.

Doc from com.mysql.cj.xdevapi.Schema.getCollections.

Retrieve the set of collections existing in this schema and matching the given pattern.

Parameters
pattern:String

match pattern

Returns:List<Collection>

list of Collection objects

Annotations
@Override
getNameback to summary
public String getName()

Implements com.mysql.cj.xdevapi.DatabaseObject.getName.

Doc from com.mysql.cj.xdevapi.DatabaseObject.getName.

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

Returns:String

name

Annotations
@Override
getSchemaback to summary
public Schema getSchema()

Implements com.mysql.cj.xdevapi.DatabaseObject.getSchema.

Doc from com.mysql.cj.xdevapi.DatabaseObject.getSchema.

Retrieve the schema owning this database object.

Returns:Schema

Schema

Annotations
@Override
getSessionback to summary
public Session getSession()

Implements com.mysql.cj.xdevapi.DatabaseObject.getSession.

Doc from com.mysql.cj.xdevapi.DatabaseObject.getSession.

Retrieve the session owning the given schema object.

Returns:Session

Session

Annotations
@Override
getTableback to summary
public Table getTable(String tableName)

Implements com.mysql.cj.xdevapi.Schema.getTable.

Doc from com.mysql.cj.xdevapi.Schema.getTable.

Retrieve a reference to the named table.

Parameters
tableName:String

table name

Returns:Table

Table

Annotations
@Override
getTableback to summary
public Table getTable(String tableName, boolean requireExists)

Implements com.mysql.cj.xdevapi.Schema.getTable.

Doc from com.mysql.cj.xdevapi.Schema.getTable.

Retrieve a reference to the named table hinting that an exception should be thrown if the collection is not known to the server.

Parameters
tableName:String

table name

requireExists:boolean

true if required to exist

Returns:Table

Table

Annotations
@Override
getTablesback to summary
public List<Table> getTables()

Implements com.mysql.cj.xdevapi.Schema.getTables.

Doc from com.mysql.cj.xdevapi.Schema.getTables.

Retrieve the set of tables existing in this schema.

Returns:List<Table>

list of Table objects

Annotations
@Override
getTablesback to summary
public List<Table> getTables(String pattern)

Implements com.mysql.cj.xdevapi.Schema.getTables.

Doc from com.mysql.cj.xdevapi.Schema.getTables.

Retrieve the set of tables existing in this schema and matching the given pattern.

Parameters
pattern:String

match pattern

Returns:List<Table>

list of Table objects

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
modifyCollectionback to summary
public void modifyCollection(String collectionName, Schema.ModifyCollectionOptions options)

Implements com.mysql.cj.xdevapi.Schema.modifyCollection.

Doc from com.mysql.cj.xdevapi.Schema.modifyCollection.

Modify the schema validation of a collection.

Parameters
collectionName:String

collection name

options:Schema.ModifyCollectionOptions

validation level and JSON schema options

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override