com.mysql.cj.protocol.x

Class XMessageBuilder

java.lang.Object

com.mysql.cj.protocol.x.XMessageBuilder

All Implemented Interfaces:

MessageBuilder<XMessage>

public class XMessageBuilder
extends java.lang.Object
implements MessageBuilder<XMessage>

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	XPLUGIN_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
XMessageBuilder()

Method Summary

Modifier and Type	Method and Description
private static void	applyFilterParams(FilterParams filterParams, java.util.function.Consumer<java.util.List<MysqlxCrud.Order>> setOrder, java.util.function.Consumer<MysqlxCrud.Limit> setLimit, java.util.function.Consumer<MysqlxExpr.Expr> setCriteria, java.util.function.Consumer<java.util.List<MysqlxDatatypes.Scalar>> setArgs) Apply the given filter params to the builder object (represented by the setter methods).
private static void	applyFilterParams(FilterParams filterParams, java.util.function.Consumer<java.util.List<MysqlxCrud.Order>> setOrder, java.util.function.Consumer<MysqlxCrud.LimitExpr> setLimit, java.util.function.Consumer<MysqlxExpr.Expr> setCriteria) Apply the given filter params to the builder object (represented by the setter methods) using the variant that takes a LimitExpr and no Args.
XMessage	buildCapabilitiesGet()
XMessage	buildCapabilitiesSet(java.util.Map<java.lang.String,java.lang.Object> keyValuePair)
XMessage	buildClose()
XMessage	buildComQuery(XMessage sharedPacket, Session sess, PreparedQuery preparedQuery, QueryBindings bindings, java.lang.String characterEncoding)
XMessage	buildCreateCollection(java.lang.String schemaName, java.lang.String collectionName)
XMessage	buildCreateCollection(java.lang.String schemaName, java.lang.String collectionName, Schema.CreateCollectionOptions options)
XMessage	buildCreateCollectionIndex(java.lang.String schemaName, java.lang.String collectionName, CreateIndexParams params)
XMessage	buildDelete(FilterParams filterParams) Build an XMessage for a non-prepared delete operation.
XMessage	buildDisableNotices(java.lang.String... notices)
XMessage	buildDocInsert(java.lang.String schemaName, java.lang.String collectionName, java.util.List<java.lang.String> json, boolean upsert) Build an XMessage for a non-prepared doc insert operation.
XMessage	buildDocUpdate(FilterParams filterParams, java.util.List<UpdateSpec> updates) Build an XMessage for a non-prepared doc update operation.
XMessage	buildDropCollection(java.lang.String schemaName, java.lang.String collectionName)
XMessage	buildDropCollectionIndex(java.lang.String schemaName, java.lang.String collectionName, java.lang.String indexName)
XMessage	buildEnableNotices(java.lang.String... notices)
XMessage	buildExpectOpen()
XMessage	buildExternalAuthStart(java.lang.String database)
XMessage	buildFind(FilterParams filterParams) Build an XMessage for a non-prepared find operation.
XMessage	buildListNotices() List the notices the server allows subscribing to.
XMessage	buildListObjects(java.lang.String schemaName, java.lang.String pattern) List the objects in the given schema.
XMessage	buildModifyCollectionOptions(java.lang.String schemaName, java.lang.String collectionName, Schema.ModifyCollectionOptions options)
XMessage	buildMysql41AuthContinue(java.lang.String user, java.lang.String password, byte[] salt, java.lang.String database)
XMessage	buildMysql41AuthStart()
XMessage	buildPlainAuthStart(java.lang.String user, java.lang.String password, java.lang.String database)
XMessage	buildPrepareDeallocate(int preparedStatementId) Build an XMessage for deallocating a prepared statement.
XMessage	buildPrepareDelete(int preparedStatementId, FilterParams filterParams) Build an XMessage for a prepared delete operation.
XMessage	buildPrepareDocUpdate(int preparedStatementId, FilterParams filterParams, java.util.List<UpdateSpec> updates) Build an XMessage for a prepared doc update operation.
XMessage	buildPrepareExecute(int preparedStatementId, FilterParams filterParams) Build an XMessage for executing a prepared statement with the given filters.
XMessage	buildPrepareFind(int preparedStatementId, FilterParams filterParams) Build an XMessage for a prepared find operation.
XMessage	buildPrepareRowUpdate(int preparedStatementId, FilterParams filterParams, UpdateParams updateParams) Build an XMessage for a prepared row update operation.
XMessage	buildPrepareSqlStatement(int preparedStatementId, java.lang.String statement) Build a Prepare message for a SQL statement.
XMessage	buildRowInsert(java.lang.String schemaName, java.lang.String tableName, InsertParams insertParams) Build an XMessage for a non-prepared row insert operation.
XMessage	buildRowUpdate(FilterParams filterParams, UpdateParams updateParams) Build an XMessage for a non-prepared row update operation.
XMessage	buildSessionResetAndClose()
XMessage	buildSessionResetKeepOpen()
XMessage	buildSha256MemoryAuthContinue(java.lang.String user, java.lang.String password, byte[] nonce, java.lang.String database)
XMessage	buildSha256MemoryAuthStart()
XMessage	buildSqlStatement(java.lang.String statement) Build a StmtExecute message for a SQL statement.
XMessage	buildSqlStatement(java.lang.String statement, java.util.List<java.lang.Object> args) Build a StmtExecute message for a SQL statement.
private MysqlxSql.StmtExecute	buildXpluginCommand(XpluginStatementCommand command, MysqlxDatatypes.Any... args) Build a StmtExecute message for an xplugin command.
private MysqlxCrud.Delete.Builder	commonDeleteBuilder(FilterParams filterParams) Initialize a Delete.Builder with common data for prepared and non-prepared executions.
private MysqlxCrud.Update.Builder	commonDocUpdateBuilder(FilterParams filterParams, java.util.List<UpdateSpec> updates) Initialize an Update.Builder for collection data model with common data for prepared and non-prepared executions.
private MysqlxCrud.Find.Builder	commonFindBuilder(FilterParams filterParams) Initialize a Find.Builder for collection data model with common data for prepared and non-prepared executions.
private MysqlxCrud.Insert.Builder	commonRowInsertBuilder(java.lang.String schemaName, java.lang.String tableName, InsertParams insertParams) Initialize a Insert.Builder for table data model with common data for prepared and non-prepared executions.
private MysqlxCrud.Update.Builder	commonRowUpdateBuilder(FilterParams filterParams, UpdateParams updateParams) Initialize an Update.Builder for table data model with common data for prepared and non-prepared executions.
private MysqlxSql.StmtExecute.Builder	commonSqlStatementBuilder(java.lang.String statement) Initialize a StmtExecute.Builder with common data for prepared and non-prepared executions.

Methods inherited from class java.lang.Object

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

Field Detail

XPLUGIN_NAMESPACE

private static final java.lang.String XPLUGIN_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

XMessageBuilder

public XMessageBuilder()

Method Detail

buildCapabilitiesGet

public XMessage buildCapabilitiesGet()

buildCapabilitiesSet

public XMessage buildCapabilitiesSet(java.util.Map<java.lang.String,java.lang.Object> keyValuePair)

buildDocInsert

public XMessage buildDocInsert(java.lang.String schemaName,
                               java.lang.String collectionName,
                               java.util.List<java.lang.String> json,
                               boolean upsert)

Build an XMessage for a non-prepared doc insert operation.

Parameters:

schemaName - the schema name

collectionName - the collection name

json - the documents to insert

upsert - Whether this is an upsert operation or not

Returns:

an XMessage instance

commonRowInsertBuilder

private MysqlxCrud.Insert.Builder commonRowInsertBuilder(java.lang.String schemaName,
                                                         java.lang.String tableName,
                                                         InsertParams insertParams)

Initialize a Insert.Builder for table data model with common data for prepared and non-prepared executions.

Parameters:

schemaName - the schema name

tableName - the table name

insertParams - the parameters to insert

Returns:

an initialized Insert.Builder instance

buildRowInsert

public XMessage buildRowInsert(java.lang.String schemaName,
                               java.lang.String tableName,
                               InsertParams insertParams)

Build an XMessage for a non-prepared row insert operation.

Parameters:

schemaName - the schema name

tableName - the table name

insertParams - the parameters to insert

Returns:

an XMessage instance

commonDocUpdateBuilder

private MysqlxCrud.Update.Builder commonDocUpdateBuilder(FilterParams filterParams,
                                                         java.util.List<UpdateSpec> updates)

Initialize an Update.Builder for collection data model with common data for prepared and non-prepared executions.

Parameters:

filterParams - the filter parameters

updates - the updates specifications to perform

Returns:

an initialized Update.Builder instance

buildDocUpdate

public XMessage buildDocUpdate(FilterParams filterParams,
                               java.util.List<UpdateSpec> updates)

Build an XMessage for a non-prepared doc update operation.

Parameters:

filterParams - the filter parameters

updates - the updates specifications to perform

Returns:

an XMessage instance

buildPrepareDocUpdate

public XMessage buildPrepareDocUpdate(int preparedStatementId,
                                      FilterParams filterParams,
                                      java.util.List<UpdateSpec> updates)

Build an XMessage for a prepared doc update operation.

Parameters:

preparedStatementId - the prepared statement id

filterParams - the filter parameters

updates - the updates specifications to perform

Returns:

an XMessage instance

commonRowUpdateBuilder

private MysqlxCrud.Update.Builder commonRowUpdateBuilder(FilterParams filterParams,
                                                         UpdateParams updateParams)

Initialize an Update.Builder for table data model with common data for prepared and non-prepared executions.

Parameters:

filterParams - the filter parameters

updateParams - the update parameters

Returns:

an initialized Update.Builder instance

buildRowUpdate

public XMessage buildRowUpdate(FilterParams filterParams,
                               UpdateParams updateParams)

Build an XMessage for a non-prepared row update operation.

Parameters:

filterParams - the filter parameters

updateParams - the update parameters

Returns:

an XMessage instance

buildPrepareRowUpdate

public XMessage buildPrepareRowUpdate(int preparedStatementId,
                                      FilterParams filterParams,
                                      UpdateParams updateParams)

Build an XMessage for a prepared row update operation.

Parameters:

preparedStatementId - the prepared statement id

filterParams - the filter parameters

updateParams - the update parameters

Returns:

an XMessage instance

commonFindBuilder

private MysqlxCrud.Find.Builder commonFindBuilder(FilterParams filterParams)

Initialize a Find.Builder for collection data model with common data for prepared and non-prepared executions.

Parameters:

filterParams - the filter parameters

Returns:

an initialized Find.Builder instance

buildFind

public XMessage buildFind(FilterParams filterParams)

Build an XMessage for a non-prepared find operation.

Parameters:

filterParams - the filter parameters

Returns:

an XMessage instance

buildPrepareFind

public XMessage buildPrepareFind(int preparedStatementId,
                                 FilterParams filterParams)

Build an XMessage for a prepared find operation.

Parameters:

preparedStatementId - the prepared statement id

filterParams - the filter parameters

Returns:

an XMessage instance

commonDeleteBuilder

private MysqlxCrud.Delete.Builder commonDeleteBuilder(FilterParams filterParams)

Initialize a Delete.Builder with common data for prepared and non-prepared executions.

Parameters:

filterParams - the filter parameters

Returns:

an initialized Delete.Builder instance

buildDelete

public XMessage buildDelete(FilterParams filterParams)

Build an XMessage for a non-prepared delete operation.

Parameters:

filterParams - the filter parameters

Returns:

an XMessage instance

buildPrepareDelete

public XMessage buildPrepareDelete(int preparedStatementId,
                                   FilterParams filterParams)

Build an XMessage for a prepared delete operation.

Parameters:

preparedStatementId - the prepared statement id

filterParams - the filter parameters

Returns:

an XMessage instance

commonSqlStatementBuilder

private MysqlxSql.StmtExecute.Builder commonSqlStatementBuilder(java.lang.String statement)

Initialize a StmtExecute.Builder with common data for prepared and non-prepared executions.

Parameters:

statement - the SQL statement

Returns:

an initialized StmtExecute.Builder instance

buildSqlStatement

public XMessage buildSqlStatement(java.lang.String statement)

Build a StmtExecute message for a SQL statement.

Specified by:

buildSqlStatement in interface MessageBuilder<XMessage>

Parameters:

statement - SQL statement string

Returns:

XMessage wrapping MysqlxSql.StmtExecute

buildSqlStatement

public XMessage buildSqlStatement(java.lang.String statement,
                                  java.util.List<java.lang.Object> args)

Build a StmtExecute message for a SQL statement.

Specified by:

buildSqlStatement in interface MessageBuilder<XMessage>

Parameters:

statement - SQL statement string

args - list of Object arguments

Returns:

XMessage wrapping MysqlxSql.StmtExecute

buildPrepareSqlStatement

public XMessage buildPrepareSqlStatement(int preparedStatementId,
                                         java.lang.String statement)

Build a Prepare message for a SQL statement.

Parameters:

preparedStatementId - the prepared statement id

statement - SQL statement string

Returns:

XMessage wrapping MysqlxSql.StmtExecute

applyFilterParams

private static void applyFilterParams(FilterParams filterParams,
                                      java.util.function.Consumer<java.util.List<MysqlxCrud.Order>> setOrder,
                                      java.util.function.Consumer<MysqlxCrud.Limit> setLimit,
                                      java.util.function.Consumer<MysqlxExpr.Expr> setCriteria,
                                      java.util.function.Consumer<java.util.List<MysqlxDatatypes.Scalar>> setArgs)

Apply the given filter params to the builder object (represented by the setter methods). Abstract the process of setting the filter params on the operation message builder.

Parameters:

filterParams - the filter params to apply

setOrder - the "builder.addAllOrder()" method reference

setLimit - the "builder.setLimit()" method reference

setCriteria - the "builder.setCriteria()" method reference

setArgs - the "builder.addAllArgs()" method reference

applyFilterParams

private static void applyFilterParams(FilterParams filterParams,
                                      java.util.function.Consumer<java.util.List<MysqlxCrud.Order>> setOrder,
                                      java.util.function.Consumer<MysqlxCrud.LimitExpr> setLimit,
                                      java.util.function.Consumer<MysqlxExpr.Expr> setCriteria)

Apply the given filter params to the builder object (represented by the setter methods) using the variant that takes a LimitExpr and no Args. This variant is suitable for building prepared statements prepare messages. Abstract the process of setting the filter params on the operation message builder.

Parameters:

filterParams - the filter params to apply

setOrder - the "builder.addAllOrder()" method reference

setLimit - the "builder.setLimitExp()" method reference

setCriteria - the "builder.setCriteria()" method reference

buildPrepareExecute

public XMessage buildPrepareExecute(int preparedStatementId,
                                    FilterParams filterParams)

Build an XMessage for executing a prepared statement with the given filters.

Parameters:

preparedStatementId - the prepared statement id

filterParams - the filter parameter values

Returns:

an XMessage instance

buildPrepareDeallocate

public XMessage buildPrepareDeallocate(int preparedStatementId)

Build an XMessage for deallocating a prepared statement.

Parameters:

preparedStatementId - the prepared statement id

Returns:

an XMessage instance

buildCreateCollection

public XMessage buildCreateCollection(java.lang.String schemaName,
                                      java.lang.String collectionName,
                                      Schema.CreateCollectionOptions options)

buildModifyCollectionOptions

public XMessage buildModifyCollectionOptions(java.lang.String schemaName,
                                             java.lang.String collectionName,
                                             Schema.ModifyCollectionOptions options)

buildCreateCollection

public XMessage buildCreateCollection(java.lang.String schemaName,
                                      java.lang.String collectionName)

buildDropCollection

public XMessage buildDropCollection(java.lang.String schemaName,
                                    java.lang.String collectionName)

buildClose

public XMessage buildClose()

Specified by:

buildClose in interface MessageBuilder<XMessage>

buildListObjects

public XMessage buildListObjects(java.lang.String schemaName,
                                 java.lang.String pattern)

List the objects in the given schema. Returns a table as so:

 | name                | type       |
 |---------------------+------------|
 | CollectionTest      | COLLECTION |
 | some_view           | VIEW       |
 | xprotocol_test_test | TABLE      |
 

.

Parameters:

schemaName - schema name

pattern - object name pattern

Returns:

XMessage

buildEnableNotices

public XMessage buildEnableNotices(java.lang.String... notices)

buildDisableNotices

public XMessage buildDisableNotices(java.lang.String... notices)

buildListNotices

public XMessage buildListNotices()

List the notices the server allows subscribing to. Returns a table as so:

 | notice (string)     | enabled (int) |
 |---------------------+---------------|
 | warnings            | 1             |
 

Returns:

XMessage

buildCreateCollectionIndex

public XMessage buildCreateCollectionIndex(java.lang.String schemaName,
                                           java.lang.String collectionName,
                                           CreateIndexParams params)

buildDropCollectionIndex

public XMessage buildDropCollectionIndex(java.lang.String schemaName,
                                         java.lang.String collectionName,
                                         java.lang.String indexName)

buildXpluginCommand

private MysqlxSql.StmtExecute buildXpluginCommand(XpluginStatementCommand command,
                                                  MysqlxDatatypes.Any... args)

Build a StmtExecute message for an xplugin command.

Parameters:

command - the xplugin command to send

args - the arguments to the command

Returns:

MysqlxSql.StmtExecute

buildSha256MemoryAuthStart

public XMessage buildSha256MemoryAuthStart()

buildSha256MemoryAuthContinue

public XMessage buildSha256MemoryAuthContinue(java.lang.String user,
                                              java.lang.String password,
                                              byte[] nonce,
                                              java.lang.String database)

buildMysql41AuthStart

public XMessage buildMysql41AuthStart()

buildMysql41AuthContinue

public XMessage buildMysql41AuthContinue(java.lang.String user,
                                         java.lang.String password,
                                         byte[] salt,
                                         java.lang.String database)

buildPlainAuthStart

public XMessage buildPlainAuthStart(java.lang.String user,
                                    java.lang.String password,
                                    java.lang.String database)

buildExternalAuthStart

public XMessage buildExternalAuthStart(java.lang.String database)

buildSessionResetAndClose

public XMessage buildSessionResetAndClose()

buildSessionResetKeepOpen

public XMessage buildSessionResetKeepOpen()

buildExpectOpen

public XMessage buildExpectOpen()

buildComQuery

public XMessage buildComQuery(XMessage sharedPacket,
                              Session sess,
                              PreparedQuery preparedQuery,
                              QueryBindings bindings,
                              java.lang.String characterEncoding)

Specified by:

buildComQuery in interface MessageBuilder<XMessage>