Package com.mysql.cj.x.protobuf
Message classes used for serialization with Google Protocol Buffers to support the X Protocol. Classes are generated using protoc like so:
protoc --java_out=PATH/src/generated/java --proto_path=PATH_TO_IMPORTS -I=PATH_TO_MYSQL_REPO/rapid/plugin/x/protocol PATH_TO_MYSQL_REPO/rapid/plugin/x/protocol/*.proto
- Since:
- 6.0
-
-
Class Summary Class Description Mysqlx Mysqlx.ClientMessages IDs of messages that can be sent from client to the server ..Mysqlx.ClientMessages.Builder IDs of messages that can be sent from client to the server ..Mysqlx.Error generic Error message A ``severity`` of ``ERROR`` indicates the current message sequence is aborted for the given error and the session is ready for more.Mysqlx.Error.Builder generic Error message A ``severity`` of ``ERROR`` indicates the current message sequence is aborted for the given error and the session is ready for more.Mysqlx.Ok generic Ok messageMysqlx.Ok.Builder generic Ok messageMysqlx.ServerMessages IDs of messages that can be sent from server to client ..Mysqlx.ServerMessages.Builder IDs of messages that can be sent from server to client ..MysqlxConnection MysqlxConnection.Capabilities CapabilitiesMysqlxConnection.Capabilities.Builder CapabilitiesMysqlxConnection.CapabilitiesGet get supported connection capabilities and their current state :returns: :protobuf:msg:`Mysqlx.Connection::Capabilities` or :protobuf:msg:`Mysqlx::Error`MysqlxConnection.CapabilitiesGet.Builder get supported connection capabilities and their current state :returns: :protobuf:msg:`Mysqlx.Connection::Capabilities` or :protobuf:msg:`Mysqlx::Error`MysqlxConnection.CapabilitiesSet sets connection capabilities atomically only provided values are changed, other values are left unchanged.MysqlxConnection.CapabilitiesSet.Builder sets connection capabilities atomically only provided values are changed, other values are left unchanged.MysqlxConnection.Capability a Capability a tuple of a ``name`` and a :protobuf:msg:`Mysqlx.Datatypes::Any`MysqlxConnection.Capability.Builder a Capability a tuple of a ``name`` and a :protobuf:msg:`Mysqlx.Datatypes::Any`MysqlxConnection.Close announce to the server that the client wants to close the connection it discards any session state of the server :Returns: :protobuf:msg:`Mysqlx::Ok`MysqlxConnection.Close.Builder announce to the server that the client wants to close the connection it discards any session state of the server :Returns: :protobuf:msg:`Mysqlx::Ok`MysqlxConnection.Compression Protobuf typeMysqlx.Connection.CompressionMysqlxConnection.Compression.Builder Protobuf typeMysqlx.Connection.CompressionMysqlxCrud MysqlxCrud.Collection collectionMysqlxCrud.Collection.Builder collectionMysqlxCrud.Column column definitionMysqlxCrud.Column.Builder column definitionMysqlxCrud.CreateView Protobuf typeMysqlx.Crud.CreateViewMysqlxCrud.CreateView.Builder Protobuf typeMysqlx.Crud.CreateViewMysqlxCrud.Delete Delete documents/rows from a Collection/Table :param collection: collection to change :param data_model: datamodel that the operations refer to :param criteria: filter expression to match rows that the operations will apply on :param args: values for parameters used in filter expression :param limit: limits the number of rows to match (user can set one of: limit, limit_expr) :param order: specifies order of matched rows :param limit_expr: limits the number of rows to match (user can set one of: limit, limit_expr) :Returns: :protobuf:msg:`Mysqlx.Resultset::`MysqlxCrud.Delete.Builder Delete documents/rows from a Collection/Table :param collection: collection to change :param data_model: datamodel that the operations refer to :param criteria: filter expression to match rows that the operations will apply on :param args: values for parameters used in filter expression :param limit: limits the number of rows to match (user can set one of: limit, limit_expr) :param order: specifies order of matched rows :param limit_expr: limits the number of rows to match (user can set one of: limit, limit_expr) :Returns: :protobuf:msg:`Mysqlx.Resultset::`MysqlxCrud.DropView Protobuf typeMysqlx.Crud.DropViewMysqlxCrud.DropView.Builder Protobuf typeMysqlx.Crud.DropViewMysqlxCrud.Find Find Documents/Rows in a Collection/Table ..MysqlxCrud.Find.Builder Find Documents/Rows in a Collection/Table ..MysqlxCrud.Insert Insert documents/rows into a collection/table :param collection: collection to insert into :param data_model: datamodel that the operations refer to :param projection: name of the columns to insert data into (empty if data_model is DOCUMENT) :param row: set of rows to insert into the collection/table (a single expression with a JSON document literal or an OBJECT expression) :param args: values for parameters used in row expressions :param upsert: true if this should be treated as an Upsert (that is, update on duplicate key) :Returns: :protobuf:msg:`Mysqlx.Resultset::`MysqlxCrud.Insert.Builder Insert documents/rows into a collection/table :param collection: collection to insert into :param data_model: datamodel that the operations refer to :param projection: name of the columns to insert data into (empty if data_model is DOCUMENT) :param row: set of rows to insert into the collection/table (a single expression with a JSON document literal or an OBJECT expression) :param args: values for parameters used in row expressions :param upsert: true if this should be treated as an Upsert (that is, update on duplicate key) :Returns: :protobuf:msg:`Mysqlx.Resultset::`MysqlxCrud.Insert.TypedRow Protobuf typeMysqlx.Crud.Insert.TypedRowMysqlxCrud.Insert.TypedRow.Builder Protobuf typeMysqlx.Crud.Insert.TypedRowMysqlxCrud.Limit limit :param row_count: maximum rows to filter :param offset: maximum rows to skip before applying the row_countMysqlxCrud.Limit.Builder limit :param row_count: maximum rows to filter :param offset: maximum rows to skip before applying the row_countMysqlxCrud.LimitExpr limit expression LimitExpr in comparison to Limit, is able to specify that row_count and offset are placeholders.MysqlxCrud.LimitExpr.Builder limit expression LimitExpr in comparison to Limit, is able to specify that row_count and offset are placeholders.MysqlxCrud.ModifyView Protobuf typeMysqlx.Crud.ModifyViewMysqlxCrud.ModifyView.Builder Protobuf typeMysqlx.Crud.ModifyViewMysqlxCrud.Order sort orderMysqlxCrud.Order.Builder sort orderMysqlxCrud.Projection a projection :param source: the expression identifying an element from the source data which can include a column identifier or any expression :param alias: optional alias.MysqlxCrud.Projection.Builder a projection :param source: the expression identifying an element from the source data which can include a column identifier or any expression :param alias: optional alias.MysqlxCrud.Update Update documents/rows in a collection/table :param collection: collection to change :param data_model: datamodel that the operations refer to :param criteria: filter expression to match rows that the operations will apply on :param args: values for parameters used in filter expression :param limit: limits the number of rows to match (user can set one of: limit, limit_expr) :param order: specifies order of matched rows :param operation: list of operations to be applied.MysqlxCrud.Update.Builder Update documents/rows in a collection/table :param collection: collection to change :param data_model: datamodel that the operations refer to :param criteria: filter expression to match rows that the operations will apply on :param args: values for parameters used in filter expression :param limit: limits the number of rows to match (user can set one of: limit, limit_expr) :param order: specifies order of matched rows :param operation: list of operations to be applied.MysqlxCrud.UpdateOperation update operations :param source: specification of the value to be updated if data_model is TABLE, a column name may be specified and also a document path, if the column has type JSON if data_model is DOCUMENT, only document paths are allowed in both cases, schema and table must be not set :param operation: the type of operation to be performed :param value: an expression to be computed as the new value for the operationMysqlxCrud.UpdateOperation.Builder update operations :param source: specification of the value to be updated if data_model is TABLE, a column name may be specified and also a document path, if the column has type JSON if data_model is DOCUMENT, only document paths are allowed in both cases, schema and table must be not set :param operation: the type of operation to be performed :param value: an expression to be computed as the new value for the operationMysqlxCursor MysqlxCursor.Close Close cursor ..MysqlxCursor.Close.Builder Close cursor ..MysqlxCursor.Fetch Fetch next portion of data from a cursor ..MysqlxCursor.Fetch.Builder Fetch next portion of data from a cursor ..MysqlxCursor.Open Open a cursor ..MysqlxCursor.Open.Builder Open a cursor ..MysqlxCursor.Open.OneOfMessage Protobuf typeMysqlx.Cursor.Open.OneOfMessageMysqlxCursor.Open.OneOfMessage.Builder Protobuf typeMysqlx.Cursor.Open.OneOfMessageMysqlxDatatypes MysqlxDatatypes.Any a helper to allow all field typesMysqlxDatatypes.Any.Builder a helper to allow all field typesMysqlxDatatypes.Array a ArrayMysqlxDatatypes.Array.Builder a ArrayMysqlxDatatypes.Object a objectMysqlxDatatypes.Object.Builder a objectMysqlxDatatypes.Object.ObjectField Protobuf typeMysqlx.Datatypes.Object.ObjectFieldMysqlxDatatypes.Object.ObjectField.Builder Protobuf typeMysqlx.Datatypes.Object.ObjectFieldMysqlxDatatypes.Scalar a scalarMysqlxDatatypes.Scalar.Builder a scalarMysqlxDatatypes.Scalar.Octets an opaque octet sequence, with an optional content_type See ``Mysqlx.Resultset.ContentType_BYTES`` for list of known values.MysqlxDatatypes.Scalar.Octets.Builder an opaque octet sequence, with an optional content_type See ``Mysqlx.Resultset.ContentType_BYTES`` for list of known values.MysqlxDatatypes.Scalar.String a string with a charset/collationMysqlxDatatypes.Scalar.String.Builder a string with a charset/collationMysqlxExpect MysqlxExpect.Close close a Expect block closing a Expect block restores the state of the previous Expect block for the following messages :returns: :protobuf:msg:`Mysqlx::Ok` on success, :protobuf:msg:`Mysqlx::Error` on errorMysqlxExpect.Close.Builder close a Expect block closing a Expect block restores the state of the previous Expect block for the following messages :returns: :protobuf:msg:`Mysqlx::Ok` on success, :protobuf:msg:`Mysqlx::Error` on errorMysqlxExpect.Open open an Expect block and set/unset the conditions that have to be fulfilled if any of the conditions fail, all enclosed messages will fail with a Mysqlx.Error message.MysqlxExpect.Open.Builder open an Expect block and set/unset the conditions that have to be fulfilled if any of the conditions fail, all enclosed messages will fail with a Mysqlx.Error message.MysqlxExpect.Open.Condition Protobuf typeMysqlx.Expect.Open.ConditionMysqlxExpect.Open.Condition.Builder Protobuf typeMysqlx.Expect.Open.ConditionMysqlxExpr MysqlxExpr.Array a Array of expressionsMysqlxExpr.Array.Builder a Array of expressionsMysqlxExpr.ColumnIdentifier col_identifier (table): col@doc_path, tbl.col@doc_path col, tbl.col, schema.tbl.col col_identifier (document): doc_path ..MysqlxExpr.ColumnIdentifier.Builder col_identifier (table): col@doc_path, tbl.col@doc_path col, tbl.col, schema.tbl.col col_identifier (document): doc_path ..MysqlxExpr.DocumentPathItem DocumentPathItem ..MysqlxExpr.DocumentPathItem.Builder DocumentPathItem ..MysqlxExpr.Expr Expressions the "root" of the expression tree ..MysqlxExpr.Expr.Builder Expressions the "root" of the expression tree ..MysqlxExpr.FunctionCall function call: ``func(a, b, "1", 3)`` ..MysqlxExpr.FunctionCall.Builder function call: ``func(a, b, "1", 3)`` ..MysqlxExpr.Identifier identifier: name, schame.name ..MysqlxExpr.Identifier.Builder identifier: name, schame.name ..MysqlxExpr.Object an object (with expression values)MysqlxExpr.Object.Builder an object (with expression values)MysqlxExpr.Object.ObjectField Protobuf typeMysqlx.Expr.Object.ObjectFieldMysqlxExpr.Object.ObjectField.Builder Protobuf typeMysqlx.Expr.Object.ObjectFieldMysqlxExpr.Operator operator: ``<<(a, b)`` ..MysqlxExpr.Operator.Builder operator: ``<<(a, b)`` ..MysqlxNotice MysqlxNotice.Frame Common Frame for all Notices ===================================================== ===== .type value ===================================================== ===== :protobuf:msg:`Mysqlx.Notice::Warning` 1 :protobuf:msg:`Mysqlx.Notice::SessionVariableChanged` 2 :protobuf:msg:`Mysqlx.Notice::SessionStateChanged` 3 ===================================================== ===== :param type: the type of the payload :param payload: the payload of the notification :param scope: global or local notificationMysqlxNotice.Frame.Builder Common Frame for all Notices ===================================================== ===== .type value ===================================================== ===== :protobuf:msg:`Mysqlx.Notice::Warning` 1 :protobuf:msg:`Mysqlx.Notice::SessionVariableChanged` 2 :protobuf:msg:`Mysqlx.Notice::SessionStateChanged` 3 ===================================================== ===== :param type: the type of the payload :param payload: the payload of the notification :param scope: global or local notificationMysqlxNotice.GroupReplicationStateChanged Notify clients about group replication state changes ========================================== ========== :protobuf:msg:`Mysqlx.Notice::Frame` field value ========================================== ========== ``.type`` 4 ``.scope`` ``global`` ========================================== ========== :param type: type of group replication event :param view_id: view identifierMysqlxNotice.GroupReplicationStateChanged.Builder Notify clients about group replication state changes ========================================== ========== :protobuf:msg:`Mysqlx.Notice::Frame` field value ========================================== ========== ``.type`` 4 ``.scope`` ``global`` ========================================== ========== :param type: type of group replication event :param view_id: view identifierMysqlxNotice.ServerHello Notify clients about connection to X Protocol server ========================================== ========== :protobuf:msg:`Mysqlx.Notice::Frame` field value ========================================== ========== ``.type`` 5 ``.scope`` ``global`` ========================================== ==========MysqlxNotice.ServerHello.Builder Notify clients about connection to X Protocol server ========================================== ========== :protobuf:msg:`Mysqlx.Notice::Frame` field value ========================================== ========== ``.type`` 5 ``.scope`` ``global`` ========================================== ==========MysqlxNotice.SessionStateChanged Notify clients about changes to the internal session state ========================================== ========= :protobuf:msg:`Mysqlx.Notice::Frame` field value ========================================== ========= ``.type`` 3 ``.scope`` ``local`` ========================================== ========= :param param: parameter key :param value: updated valueMysqlxNotice.SessionStateChanged.Builder Notify clients about changes to the internal session state ========================================== ========= :protobuf:msg:`Mysqlx.Notice::Frame` field value ========================================== ========= ``.type`` 3 ``.scope`` ``local`` ========================================== ========= :param param: parameter key :param value: updated valueMysqlxNotice.SessionVariableChanged Notify clients about changes to the current session variables Every change to a variable that is accessible through: ..MysqlxNotice.SessionVariableChanged.Builder Notify clients about changes to the current session variables Every change to a variable that is accessible through: ..MysqlxNotice.Warning Server-side warnings and notes ``.scope`` == ``local`` ``.level``, ``.code`` and ``.msg`` map the content of ..MysqlxNotice.Warning.Builder Server-side warnings and notes ``.scope`` == ``local`` ``.level``, ``.code`` and ``.msg`` map the content of ..MysqlxPrepare MysqlxPrepare.Deallocate Deallocate already prepared statement Deallocating the statement.MysqlxPrepare.Deallocate.Builder Deallocate already prepared statement Deallocating the statement.MysqlxPrepare.Execute Execute already prepared statement ..MysqlxPrepare.Execute.Builder Execute already prepared statement ..MysqlxPrepare.Prepare Prepare a new statement ..MysqlxPrepare.Prepare.Builder Prepare a new statement ..MysqlxPrepare.Prepare.OneOfMessage Protobuf typeMysqlx.Prepare.Prepare.OneOfMessageMysqlxPrepare.Prepare.OneOfMessage.Builder Protobuf typeMysqlx.Prepare.Prepare.OneOfMessageMysqlxResultset MysqlxResultset.ColumnMetaData meta data of a Column ..MysqlxResultset.ColumnMetaData.Builder meta data of a Column ..MysqlxResultset.FetchDone all resultsets are finishedMysqlxResultset.FetchDone.Builder all resultsets are finishedMysqlxResultset.FetchDoneMoreOutParams resultsets are finished, OUT paramset is nextMysqlxResultset.FetchDoneMoreOutParams.Builder resultsets are finished, OUT paramset is nextMysqlxResultset.FetchDoneMoreResultsets resultset and out-params are finished, but more resultsets availableMysqlxResultset.FetchDoneMoreResultsets.Builder resultset and out-params are finished, but more resultsets availableMysqlxResultset.FetchSuspended cursor is opened still the execution of PrepFetch or PrepExecute endedMysqlxResultset.FetchSuspended.Builder cursor is opened still the execution of PrepFetch or PrepExecute endedMysqlxResultset.Row Row in a Resultset a row is represented as a list of fields encoded as byte blobs.MysqlxResultset.Row.Builder Row in a Resultset a row is represented as a list of fields encoded as byte blobs.MysqlxSession MysqlxSession.AuthenticateContinue send by client or server after a :protobuf:msg:`Mysqlx.Session::AuthenticateStart` to exchange more auth data :param auth_data: authentication data :Returns: :protobuf:msg:`Mysqlx.Session::AuthenticateContinue`MysqlxSession.AuthenticateContinue.Builder send by client or server after a :protobuf:msg:`Mysqlx.Session::AuthenticateStart` to exchange more auth data :param auth_data: authentication data :Returns: :protobuf:msg:`Mysqlx.Session::AuthenticateContinue`MysqlxSession.AuthenticateOk sent by the server after successful authentication :param auth_data: authentication dataMysqlxSession.AuthenticateOk.Builder sent by the server after successful authentication :param auth_data: authentication dataMysqlxSession.AuthenticateStart the initial message send from the client to the server to start the authentication proccess :param mech_name: authentication mechanism name :param auth_data: authentication data :param initial_response: initial response :Returns: :protobuf:msg:`Mysqlx.Session::AuthenticateContinue`MysqlxSession.AuthenticateStart.Builder the initial message send from the client to the server to start the authentication proccess :param mech_name: authentication mechanism name :param auth_data: authentication data :param initial_response: initial response :Returns: :protobuf:msg:`Mysqlx.Session::AuthenticateContinue`MysqlxSession.Close close the current session :Returns: :protobuf:msg:`Mysqlx::Ok`MysqlxSession.Close.Builder close the current session :Returns: :protobuf:msg:`Mysqlx::Ok`MysqlxSession.Reset reset the current session param keep_open: if is true the session will be reset, but stays authenticated.MysqlxSession.Reset.Builder reset the current session param keep_open: if is true the session will be reset, but stays authenticated.MysqlxSql MysqlxSql.StmtExecute execute a statement in the given namespace ..MysqlxSql.StmtExecute.Builder execute a statement in the given namespace ..MysqlxSql.StmtExecuteOk statement executed successfulMysqlxSql.StmtExecuteOk.Builder statement executed successful -
Enum Summary Enum Description Mysqlx.ClientMessages.Type Protobuf enumMysqlx.ClientMessages.TypeMysqlx.Error.Severity Protobuf enumMysqlx.Error.SeverityMysqlx.ServerMessages.Type Protobuf enumMysqlx.ServerMessages.TypeMysqlxCrud.DataModel DataModel to use for filters, names, ...MysqlxCrud.Find.RowLock Protobuf enumMysqlx.Crud.Find.RowLockMysqlxCrud.Find.RowLockOptions Protobuf enumMysqlx.Crud.Find.RowLockOptionsMysqlxCrud.Order.Direction Protobuf enumMysqlx.Crud.Order.DirectionMysqlxCrud.UpdateOperation.UpdateType Protobuf enumMysqlx.Crud.UpdateOperation.UpdateTypeMysqlxCrud.ViewAlgorithm ViewAlgorithm defines how MySQL Server processes the viewMysqlxCrud.ViewCheckOption ViewCheckOption limits the write operations done on a `VIEW` (`INSERT`, `UPDATE`, `DELETE`) to rows in which the `WHERE` clause is `TRUE`MysqlxCrud.ViewSqlSecurity ViewSqlSecurity defines the security context in which the view is going to be executed, this means that VIEW can be executed with current user permissions or with permissions of the uses who defined the VIEWMysqlxCursor.Open.OneOfMessage.Type Protobuf enumMysqlx.Cursor.Open.OneOfMessage.TypeMysqlxDatatypes.Any.Type Protobuf enumMysqlx.Datatypes.Any.TypeMysqlxDatatypes.Scalar.Type Protobuf enumMysqlx.Datatypes.Scalar.TypeMysqlxExpect.Open.Condition.ConditionOperation Protobuf enumMysqlx.Expect.Open.Condition.ConditionOperationMysqlxExpect.Open.Condition.Key Protobuf enumMysqlx.Expect.Open.Condition.KeyMysqlxExpect.Open.CtxOperation Protobuf enumMysqlx.Expect.Open.CtxOperationMysqlxExpr.DocumentPathItem.Type Protobuf enumMysqlx.Expr.DocumentPathItem.TypeMysqlxExpr.Expr.Type Protobuf enumMysqlx.Expr.Expr.TypeMysqlxNotice.Frame.Scope Protobuf enumMysqlx.Notice.Frame.ScopeMysqlxNotice.Frame.Type Protobuf enumMysqlx.Notice.Frame.TypeMysqlxNotice.GroupReplicationStateChanged.Type Protobuf enumMysqlx.Notice.GroupReplicationStateChanged.TypeMysqlxNotice.SessionStateChanged.Parameter Protobuf enumMysqlx.Notice.SessionStateChanged.ParameterMysqlxNotice.Warning.Level Protobuf enumMysqlx.Notice.Warning.LevelMysqlxPrepare.Prepare.OneOfMessage.Type Determine which of optional fields was set by the client (Workaround for missing "oneof" keyword in pb2.5)MysqlxResultset.ColumnMetaData.FieldType Protobuf enumMysqlx.Resultset.ColumnMetaData.FieldTypeMysqlxResultset.ContentType_BYTES a hint about the higher-level encoding of a BYTES field ====== ====== =========== type value description ====== ====== =========== BYTES 0x0001 GEOMETRY (WKB encoding) BYTES 0x0002 JSON (text encoding) BYTES 0x0003 XML (text encoding) ====== ====== =========== ..MysqlxResultset.ContentType_DATETIME a hint about the higher-level encoding of a DATETIME field ====== ====== =========== type value description ======== ====== =========== DATE 0x0001 DATETIME contains only date part DATETIME 0x0002 DATETIME contains both date and time parts ====== ====== ===========