Modifier and Type	Class and Description
public static class	Schema.CreateCollectionOptions Defines options to be passed to `Schema#createCollection(String, CreateCollectionOptions)`.
public static class	Schema.ModifyCollectionOptions Defines options to be passed to `Schema#modifyCollection(String, ModifyCollectionOptions)`.
public static class	Schema.Validation Validation options to be passed to `Schema#createCollection(String, CreateCollectionOptions)` or `Schema#modifyCollection(String, ModifyCollectionOptions)`.

Method Summary

Modifier and Type	Method and Description
public Collection	Returns: `Collection` createCollection(String collection name name) Create a new collection.
public Collection	Returns: `Collection` createCollection(String collection name name, boolean true if allowed to reuse reuseExisting) Create a new collection if it does not already exist on the server.
public Collection	Returns: `Collection` createCollection(String collection name collectionName, Schema.CreateCollectionOptions reuseExisting, validation level and JSON schema options options) Create a new collection.
public void	dropCollection(String name of collection to drop collectionName) Drop the collection from this schema.
public Collection	Returns: `Collection` getCollection(String collection name name) Retrieve a reference to the named collection.
public Collection	Returns: `Collection` getCollection(String collection name name, boolean true if required to exist requireExists) 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	Returns: `Table` getCollectionAsTable(String collection name name) Retrieve a reference to the named collection using the table API.
public List<Collection>	Returns: list of `Collection` objects getCollections() Retrieve the set of collections existing in this schema.
public List<Collection>	Returns: list of `Collection` objects getCollections(String match pattern pattern) Retrieve the set of collections existing in this schema and matching the given pattern.
public Table	Returns: `Table` getTable(String table name name) Retrieve a reference to the named table.
public Table	Returns: `Table` getTable(String table name tableName, boolean true if required to exist requireExists) 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>	Returns: list of `Table` objects getTables() Retrieve the set of tables existing in this schema.
public List<Table>	Returns: list of `Table` objects getTables(String match pattern pattern) Retrieve the set of tables existing in this schema and matching the given pattern.
public void	modifyCollection(String collection name collectionName, Schema.ModifyCollectionOptions validation level and JSON schema options options) Modify the schema validation of a collection.

Inherited from com.mysql.cj.xdevapi.DatabaseObject:: existsInDatabase getName getSchema getSession

Method Detail

createCollection back to summary

createCollection	back to summary
public Collection createCollection(String name) Create a new collection. Parameters name:String collection name Returns:Collection `Collection`

public Collection createCollection(String name)

Create a new collection.

Parameters

name:String: collection name

Returns:Collection

Collection

createCollection back to summary

createCollection	back to summary
public Collection createCollection(String name, boolean reuseExisting) Create a new collection if it does not already exist on the server. Parameters name:String collection name reuseExisting:boolean true if allowed to reuse Returns:Collection `Collection`

public Collection createCollection(String name, boolean reuseExisting)

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

Parameters

name:String: collection name
reuseExisting:boolean: true if allowed to reuse

Returns:Collection

Collection

createCollection back to summary

createCollection	back to summary
public Collection createCollection(String collectionName, Schema.CreateCollectionOptions options) Create a new collection. Parameters collectionName:String collection name options:Schema.CreateCollectionOptions reuseExisting, validation level and JSON schema options Returns:Collection `Collection`

public Collection createCollection(String collectionName, Schema.CreateCollectionOptions options)

Create a new collection.

Parameters

collectionName:String: collection name
options:Schema.CreateCollectionOptions: reuseExisting, validation level and JSON schema options

Returns:Collection

Collection

dropCollection	back to summary
public void dropCollection(String collectionName) Drop the collection from this schema. Parameters collectionName:String name of collection to drop

dropCollection

back to summary

public void dropCollection(String collectionName)

Drop the collection from this schema.

Parameters

collectionName:String: name of collection to drop

getCollection back to summary

getCollection	back to summary
public Collection getCollection(String name) Retrieve a reference to the named collection. Parameters name:String collection name Returns:Collection `Collection`

public Collection getCollection(String name)

Retrieve a reference to the named collection.

Parameters

name:String: collection name

Returns:Collection

Collection

getCollection back to summary

getCollection	back to summary
public Collection getCollection(String name, boolean requireExists) Retrieve a reference to the named collection hinting that an exception should be thrown if the collection is not known to the server. Parameters name:String collection name requireExists:boolean true if required to exist Returns:Collection `Collection`

public Collection getCollection(String name, boolean requireExists)

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

Parameters

name:String: collection name
requireExists:boolean: true if required to exist

Returns:Collection

Collection

getCollectionAsTable back to summary

getCollectionAsTable	back to summary
public Table getCollectionAsTable(String name) Retrieve a reference to the named collection using the table API. Parameters name:String collection name Returns:Table `Table`

public Table getCollectionAsTable(String name)

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

Parameters

name:String: collection name

Returns:Table

Table

getCollections back to summary

getCollections	back to summary
public List<Collection> getCollections() Retrieve the set of collections existing in this schema. Returns:List<Collection> list of `Collection` objects

public List<Collection> getCollections()

Retrieve the set of collections existing in this schema.

Returns:List<Collection>: list of Collection objects

getCollections back to summary

getCollections	back to summary
public List<Collection> getCollections(String pattern) 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

public List<Collection> getCollections(String pattern)

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

getTable back to summary

getTable	back to summary
public Table getTable(String name) Retrieve a reference to the named table. Parameters name:String table name Returns:Table `Table`

public Table getTable(String name)

Retrieve a reference to the named table.

Parameters

name:String: table name

Returns:Table

Table

getTable back to summary

getTable	back to summary
public Table getTable(String tableName, boolean requireExists) 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`

public Table getTable(String tableName, boolean requireExists)

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

getTables back to summary

getTables	back to summary
public List<Table> getTables() Retrieve the set of tables existing in this schema. Returns:List<Table> list of `Table` objects

public List<Table> getTables()

Retrieve the set of tables existing in this schema.

Returns:List<Table>: list of Table objects

getTables back to summary

getTables	back to summary
public List<Table> getTables(String pattern) 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

public List<Table> getTables(String pattern)

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

modifyCollection	back to summary
public void modifyCollection(String collectionName, Schema.ModifyCollectionOptions options) Modify the schema validation of a collection. Parameters collectionName:String collection name options:Schema.ModifyCollectionOptions validation level and JSON schema options

modifyCollection

back to summary

public void modifyCollection(String collectionName, Schema.ModifyCollectionOptions options)

Modify the schema validation of a collection.

Parameters

collectionName:String: collection name
options:Schema.ModifyCollectionOptions: validation level and JSON schema options

com.mysql.cj.xdevapi back to summary

public Class Schema.CreateCollectionOptions

Class Inheritance

extends Object

java.lang.Object
com.mysql.cj.xdevapi.Schema.CreateCollectionOptions

Defines options to be passed to Schema#createCollection(String, CreateCollectionOptions).

Allowed options are:

reuseExisting flag - similar to IF NOT EXISTS for CREATE TABLE
Validation object

Examples:

schema.createCollection(collName,
        new CreateCollectionOptions().setReuseExisting(false)
                .setValidation(new Validation().setLevel(ValidationLevel.STRICT)
                        .setSchema("{\"id\": \"http://json-schema.org/idx\", \"$schema\": \"http://json-schema.org/draft-06/schema#\","
                                + "\"type\": \"object\", \"properties\": {\"index\": {\"type\": \"number\"}},\"required\": [\"index\"]}")));

schema.createCollection(collName, new CreateCollectionOptions().setReuseExisting(false).setValidation(new Validation().setLevel(ValidationLevel.OFF)));

schema.createCollection(collName,
        new CreateCollectionOptions().setReuseExisting(true);

Field Summary

Modifier and Type	Field and Description
private Boolean	reuseExisting
private Schema.Validation	validation

Constructor Summary

Access	Constructor and Description
public	CreateCollectionOptions()

Method Summary

Modifier and Type	Method and Description
public Boolean	getReuseExisting()
public Schema.Validation	getValidation()
public Schema.CreateCollectionOptions	setReuseExisting(boolean reuse)
public Schema.CreateCollectionOptions	setValidation(Schema.Validation validation)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

reuseExisting	back to summary
private Boolean reuseExisting

validation	back to summary
private Schema.Validation validation

Constructor Detail

CreateCollectionOptions	back to summary
public CreateCollectionOptions()

Method Detail

getReuseExisting	back to summary
public Boolean getReuseExisting()

getValidation	back to summary
public Schema.Validation getValidation()

setReuseExisting	back to summary
public Schema.CreateCollectionOptions setReuseExisting(boolean reuse)

setValidation	back to summary
public Schema.CreateCollectionOptions setValidation(Schema.Validation validation)

com.mysql.cj.xdevapi back to summary

public Class Schema.ModifyCollectionOptions

Class Inheritance

extends Object

java.lang.Object
com.mysql.cj.xdevapi.Schema.ModifyCollectionOptions

Defines options to be passed to Schema#modifyCollection(String, ModifyCollectionOptions). Options are defined by Validation object.

Example:

schema.modifyCollection(collName1, new ModifyCollectionOptions().setValidation(new Validation().setLevel(ValidationLevel.OFF)));

Field Summary

Modifier and Type	Field and Description
private Schema.Validation	validation

Constructor Summary

Access	Constructor and Description
public	ModifyCollectionOptions()

Method Summary

Modifier and Type	Method and Description
public Schema.Validation	getValidation()
public Schema.ModifyCollectionOptions	setValidation(Schema.Validation validation)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

validation	back to summary
private Schema.Validation validation

Constructor Detail

ModifyCollectionOptions	back to summary
public ModifyCollectionOptions()

Method Detail

getValidation	back to summary
public Schema.Validation getValidation()

setValidation	back to summary
public Schema.ModifyCollectionOptions setValidation(Schema.Validation validation)

com.mysql.cj.xdevapi back to summary

public Class Schema.Validation

Class Inheritance

extends Object

java.lang.Object
com.mysql.cj.xdevapi.Schema.Validation

Validation options to be passed to Schema#createCollection(String, CreateCollectionOptions) or Schema#modifyCollection(String, ModifyCollectionOptions).

Allowed options are:

schema - JSON schema as a String
level - ValidationLevel

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	Schema.Validation.ValidationLevel Defines how validation options are applied.

Field Summary

Modifier and Type	Field and Description
private Schema.Validation.ValidationLevel	level
private String	schema

Constructor Summary

Access	Constructor and Description
public	Validation()

Method Summary

Modifier and Type	Method and Description
public Schema.Validation.ValidationLevel	getLevel()
public String	getSchema()
public Schema.Validation	setLevel(Schema.Validation.ValidationLevel level)
public Schema.Validation	setSchema(String schema)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

level	back to summary
private Schema.Validation.ValidationLevel level

schema	back to summary
private String schema

Constructor Detail

Validation	back to summary
public Validation()

Method Detail

getLevel	back to summary
public Schema.Validation.ValidationLevel getLevel()

getSchema	back to summary
public String getSchema()

setLevel	back to summary
public Schema.Validation setLevel(Schema.Validation.ValidationLevel level)

setSchema	back to summary
public Schema.Validation setSchema(String schema)

com.mysql.cj.xdevapi back to summary

public final Enum Schema.Validation.ValidationLevel

Class Inheritance

extends Enum<Schema.Validation.ValidationLevel>

java.lang.Object
java.lang.Enum
com.mysql.cj.xdevapi.Schema.Validation.ValidationLevel

Defines how validation options are applied.

STRICT - enable JSON schema validation for documents in the collection.
OFF - disable JSON schema validation.

Field Summary

Modifier and Type	Field and Description
public static final Schema.Validation.ValidationLevel	OFF
public static final Schema.Validation.ValidationLevel	STRICT

Constructor Summary

Access	Constructor and Description
private	ValidationLevel()

Method Summary

Modifier and Type	Method and Description
public static Schema.Validation.ValidationLevel	valueOf(String name)
public static Schema.Validation.ValidationLevel[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

OFF	back to summary
public static final Schema.Validation.ValidationLevel OFF

STRICT	back to summary
public static final Schema.Validation.ValidationLevel STRICT

Constructor Detail

ValidationLevel	back to summary
private ValidationLevel()

Method Detail

valueOf	back to summary
public static Schema.Validation.ValidationLevel valueOf(String name)

values	back to summary
public static Schema.Validation.ValidationLevel[] values()

public Interface Schema

Nested and Inner Type Summary

Method Summary

Method Detail

public Class Schema.CreateCollectionOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Schema.ModifyCollectionOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Schema.Validation

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Schema.Validation.ValidationLevel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail