程序包 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
- 从以下版本开始:
- 6.0
-
类概要 类 说明 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 Protobuf typeMysqlx.ErrorMysqlx.Error.Builder Protobuf typeMysqlx.ErrorMysqlx.Ok Protobuf typeMysqlx.OkMysqlx.Ok.Builder Protobuf typeMysqlx.OkMysqlx.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 Capabilities list of CapabilityMysqlxConnection.Capabilities.Builder Capabilities list of CapabilityMysqlxConnection.CapabilitiesGet Get supported connection capabilities and their current state.MysqlxConnection.CapabilitiesGet.Builder Get supported connection capabilities and their current state.MysqlxConnection.CapabilitiesSet Set connection capabilities atomically.MysqlxConnection.CapabilitiesSet.Builder Set connection capabilities atomically.MysqlxConnection.Capability Capability A tuple of a ``name`` and a @ref Mysqlx::Datatypes::AnyMysqlxConnection.Capability.Builder Capability A tuple of a ``name`` and a @ref Mysqlx::Datatypes::AnyMysqlxConnection.Close Announce to the server that the client wants to close the connection.MysqlxConnection.Close.Builder Announce to the server that the client wants to close the connection.MysqlxConnection.Compression Protobuf typeMysqlx.Connection.CompressionMysqlxConnection.Compression.Builder Protobuf typeMysqlx.Connection.CompressionMysqlxCrud MysqlxCrud.Collection Protobuf typeMysqlx.Crud.CollectionMysqlxCrud.Collection.Builder Protobuf typeMysqlx.Crud.CollectionMysqlxCrud.Column Protobuf typeMysqlx.Crud.ColumnMysqlxCrud.Column.Builder Protobuf typeMysqlx.Crud.ColumnMysqlxCrud.CreateView CreateView create view based on indicated @ref Mysqlx::Crud::Find messageMysqlxCrud.CreateView.Builder CreateView create view based on indicated @ref Mysqlx::Crud::Find messageMysqlxCrud.Delete Delete documents/rows from a Collection/Table @returns @ref Mysqlx::ResultsetMysqlxCrud.Delete.Builder Delete documents/rows from a Collection/Table @returns @ref Mysqlx::ResultsetMysqlxCrud.DropView DropView removing existing viewMysqlxCrud.DropView.Builder DropView removing existing viewMysqlxCrud.Find Find Documents/Rows in a Collection/Table @startuml client -> server: Find ... one or more Resultset ...MysqlxCrud.Find.Builder Find Documents/Rows in a Collection/Table @startuml client -> server: Find ... one or more Resultset ...MysqlxCrud.Insert Insert documents/rows into a collection/table @returns @ref Mysqlx::ResultsetMysqlxCrud.Insert.Builder Insert documents/rows into a collection/table @returns @ref Mysqlx::ResultsetMysqlxCrud.Insert.TypedRow set of fields to insert as a one rowMysqlxCrud.Insert.TypedRow.Builder set of fields to insert as a one rowMysqlxCrud.Limit Protobuf typeMysqlx.Crud.LimitMysqlxCrud.Limit.Builder Protobuf typeMysqlx.Crud.LimitMysqlxCrud.LimitExpr LimitExpr, in comparison to Limit, is able to specify that row_count and offset are placeholders.MysqlxCrud.LimitExpr.Builder LimitExpr, in comparison to Limit, is able to specify that row_count and offset are placeholders.MysqlxCrud.ModifyView ModifyView modify existing view based on indicated @ref Mysqlx::Crud::Find messageMysqlxCrud.ModifyView.Builder ModifyView modify existing view based on indicated @ref Mysqlx::Crud::Find messageMysqlxCrud.Order Sort orderMysqlxCrud.Order.Builder Sort orderMysqlxCrud.Projection Protobuf typeMysqlx.Crud.ProjectionMysqlxCrud.Projection.Builder Protobuf typeMysqlx.Crud.ProjectionMysqlxCrud.Update Update documents/rows in a collection/table @returns @ref Mysqlx::ResultsetMysqlxCrud.Update.Builder Update documents/rows in a collection/table @returns @ref Mysqlx::ResultsetMysqlxCrud.UpdateOperation Protobuf typeMysqlx.Crud.UpdateOperationMysqlxCrud.UpdateOperation.Builder Protobuf typeMysqlx.Crud.UpdateOperationMysqlxCursor MysqlxCursor.Close Close cursor @startuml client -> server: Close alt Success client <- server: Ok else Failure client <- server: Error end @enduml @returns @ref Mysqlx::Ok or @ref Mysqlx::ErrorMysqlxCursor.Close.Builder Close cursor @startuml client -> server: Close alt Success client <- server: Ok else Failure client <- server: Error end @enduml @returns @ref Mysqlx::Ok or @ref Mysqlx::ErrorMysqlxCursor.Fetch Fetch next portion of data from a cursor @startuml client -> server: Fetch alt Success ... none or partial Resultsets or full Resultsets ... client <- server: StmtExecuteOk else client <- server: Error end @endumlMysqlxCursor.Fetch.Builder Fetch next portion of data from a cursor @startuml client -> server: Fetch alt Success ... none or partial Resultsets or full Resultsets ... client <- server: StmtExecuteOk else client <- server: Error end @endumlMysqlxCursor.Open Open a cursor @startuml client -> server: Open alt Success ... none or partial Resultsets or full Resultsets ... client <- server: StmtExecuteOk else Failure client <- server: Error end alt @enduml @returns @ref Mysqlx::OkMysqlxCursor.Open.Builder Open a cursor @startuml client -> server: Open alt Success ... none or partial Resultsets or full Resultsets ... client <- server: StmtExecuteOk else Failure client <- server: Error end alt @enduml @returns @ref Mysqlx::OkMysqlxCursor.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 An ArrayMysqlxDatatypes.Array.Builder An ArrayMysqlxDatatypes.Object An objectMysqlxDatatypes.Object.Builder An 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 @ref Mysqlx::Resultset::ContentType_BYTES for list of known values.MysqlxDatatypes.Scalar.Octets.Builder an opaque octet sequence, with an optional content_type See @ref 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.MysqlxExpect.Close.Builder Close a Expect block.MysqlxExpect.Open Open an Expect block and set/unset the conditions that have to be fulfilled.MysqlxExpect.Open.Builder Open an Expect block and set/unset the conditions that have to be fulfilled.MysqlxExpect.Open.Condition Protobuf typeMysqlx.Expect.Open.ConditionMysqlxExpect.Open.Condition.Builder Protobuf typeMysqlx.Expect.Open.ConditionMysqlxExpr MysqlxExpr.Array An array of expressionsMysqlxExpr.Array.Builder An array of expressionsMysqlxExpr.ColumnIdentifier Column identifier for table: col\@doc_path, tbl.col\@doc_path col, tbl.col, schema.tbl.col for document collection: doc_path // @par production list @code{unparsed} col_identifier: string "." string "." string | : string "." string | : string | : string "." string "." string "@" document_path | : string "." string "@" document_path | : string "@" document_path | : document_path document_path: member | arrayLocation | doubleAsterisk member = "." string | "." "*" arrayLocation = "[" index "]" | "[" "*" "]" doubleAsterisk = "**" @endcodeMysqlxExpr.ColumnIdentifier.Builder Column identifier for table: col\@doc_path, tbl.col\@doc_path col, tbl.col, schema.tbl.col for document collection: doc_path // @par production list @code{unparsed} col_identifier: string "." string "." string | : string "." string | : string | : string "." string "." string "@" document_path | : string "." string "@" document_path | : string "@" document_path | : document_path document_path: member | arrayLocation | doubleAsterisk member = "." string | "." "*" arrayLocation = "[" index "]" | "[" "*" "]" doubleAsterisk = "**" @endcodeMysqlxExpr.DocumentPathItem Document path item @par production list @code{unparsed} document_path: path_item | path_item document_path path_item : member | array_index | "**" member : "." string | "." "*" array_index : "[" number "]" | "[" "*" "]" @endcodeMysqlxExpr.DocumentPathItem.Builder Document path item @par production list @code{unparsed} document_path: path_item | path_item document_path path_item : member | array_index | "**" member : "." string | "." "*" array_index : "[" number "]" | "[" "*" "]" @endcodeMysqlxExpr.Expr The "root" of the expression tree.MysqlxExpr.Expr.Builder The "root" of the expression tree.MysqlxExpr.FunctionCall Function call: ``func(a, b, "1", 3)`` @par production list @code{unparsed} function_call: `identifier` "(" [ `expr` ["," `expr` ]* ] ")" @endcodeMysqlxExpr.FunctionCall.Builder Function call: ``func(a, b, "1", 3)`` @par production list @code{unparsed} function_call: `identifier` "(" [ `expr` ["," `expr` ]* ] ")" @endcodeMysqlxExpr.Identifier Identifier: name, schame.name @par production list @code{unparsed} identifier: string "." string | : string @endcodeMysqlxExpr.Identifier.Builder Identifier: name, schame.name @par production list @code{unparsed} identifier: string "." string | : string @endcodeMysqlxExpr.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 Protobuf typeMysqlx.Expr.OperatorMysqlxExpr.Operator.Builder Protobuf typeMysqlx.Expr.OperatorMysqlxNotice MysqlxNotice.Frame Common frame for all notices | ``.type`` | Value | |---------------------------------------------------|------ | | @ref Mysqlx::Notice::Warning | 1 | | @ref Mysqlx::Notice::SessionVariableChanged | 2 | | @ref Mysqlx::Notice::SessionStateChanged | 3 | | @ref Mysqlx::Notice::GroupReplicationStateChanged | 4 | | @ref Mysqlx::Notice::ServerHello | 5 |MysqlxNotice.Frame.Builder Common frame for all notices | ``.type`` | Value | |---------------------------------------------------|------ | | @ref Mysqlx::Notice::Warning | 1 | | @ref Mysqlx::Notice::SessionVariableChanged | 2 | | @ref Mysqlx::Notice::SessionStateChanged | 3 | | @ref Mysqlx::Notice::GroupReplicationStateChanged | 4 | | @ref Mysqlx::Notice::ServerHello | 5 |MysqlxNotice.GroupReplicationStateChanged Notify clients about group replication state changes | @ref Mysqlx::Notice::Frame Field | Value | |-----------------------------------|------------| |``.type`` | 4 | |``.scope`` | ``global`` |MysqlxNotice.GroupReplicationStateChanged.Builder Notify clients about group replication state changes | @ref Mysqlx::Notice::Frame Field | Value | |-----------------------------------|------------| |``.type`` | 4 | |``.scope`` | ``global`` |MysqlxNotice.ServerHello Notify clients about connection to X Protocol server | @ref Mysqlx::Notice::Frame Field | Value | |-----------------------------------|------------| |``.type`` | 5 | |``.scope`` | ``global`` |MysqlxNotice.ServerHello.Builder Notify clients about connection to X Protocol server | @ref Mysqlx::Notice::Frame Field | Value | |-----------------------------------|------------| |``.type`` | 5 | |``.scope`` | ``global`` |MysqlxNotice.SessionStateChanged Protobuf typeMysqlx.Notice.SessionStateChangedMysqlxNotice.SessionStateChanged.Builder Protobuf typeMysqlx.Notice.SessionStateChangedMysqlxNotice.SessionVariableChanged Notify clients about changes to the current session variables.MysqlxNotice.SessionVariableChanged.Builder Notify clients about changes to the current session variables.MysqlxNotice.Warning Server-side warnings and notes @par ``.scope`` == ``local`` ``.level``, ``.code`` and ``.msg`` map the content of: @code{sql} SHOW WARNINGS @endcode @par ``.scope`` == ``global`` (undefined) Will be used for global, unstructured messages like: - server is shutting down - a node disconnected from group - schema or table dropped | @ref Mysqlx::Notice::Frame Field | Value | |-----------------------------------|-------------------------| | ``.type`` | 1 | | ``.scope`` | ``local`` or ``global`` |MysqlxNotice.Warning.Builder Server-side warnings and notes @par ``.scope`` == ``local`` ``.level``, ``.code`` and ``.msg`` map the content of: @code{sql} SHOW WARNINGS @endcode @par ``.scope`` == ``global`` (undefined) Will be used for global, unstructured messages like: - server is shutting down - a node disconnected from group - schema or table dropped | @ref Mysqlx::Notice::Frame Field | Value | |-----------------------------------|-------------------------| | ``.type`` | 1 | | ``.scope`` | ``local`` or ``global`` |MysqlxPrepare MysqlxPrepare.Deallocate Deallocate already-prepared statement @startuml client -> server: Deallocate alt Success client <- server: Ok else Failure client <- server: Error end @enduml @returns @ref Mysqlx::Ok or @ref Mysqlx::ErrorMysqlxPrepare.Deallocate.Builder Deallocate already-prepared statement @startuml client -> server: Deallocate alt Success client <- server: Ok else Failure client <- server: Error end @enduml @returns @ref Mysqlx::Ok or @ref Mysqlx::ErrorMysqlxPrepare.Execute Execute already-prepared statement @startuml client -> server: Execute alt Success ...MysqlxPrepare.Execute.Builder Execute already-prepared statement @startuml client -> server: Execute alt Success ...MysqlxPrepare.Prepare Prepare a new statement @startuml client -> server: Prepare alt Success client <- server: Ok else Failure client <- server: Error end @enduml @returns @ref Mysqlx::Ok or @ref Mysqlx::ErrorMysqlxPrepare.Prepare.Builder Prepare a new statement @startuml client -> server: Prepare alt Success client <- server: Ok else Failure client <- server: Error end @enduml @returns @ref Mysqlx::Ok or @ref Mysqlx::ErrorMysqlxPrepare.Prepare.OneOfMessage Protobuf typeMysqlx.Prepare.Prepare.OneOfMessageMysqlxPrepare.Prepare.OneOfMessage.Builder Protobuf typeMysqlx.Prepare.Prepare.OneOfMessageMysqlxResultset MysqlxResultset.ColumnMetaData Meta data of a column @note The encoding used for the different ``bytes`` fields in the meta data is externally controlled.MysqlxResultset.ColumnMetaData.Builder Meta data of a column @note The encoding used for the different ``bytes`` fields in the meta data is externally controlled.MysqlxResultset.FetchDone All resultsets are finishedMysqlxResultset.FetchDone.Builder All resultsets are finishedMysqlxResultset.FetchDoneMoreOutParams Resultsets are finished, OUT paramset is next:MysqlxResultset.FetchDoneMoreOutParams.Builder Resultsets are finished, OUT paramset is next:MysqlxResultset.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.MysqlxResultset.Row.Builder Row in a Resultset.MysqlxSession MysqlxSession.AuthenticateContinue Send by client or server after an @ref Mysqlx::Session::AuthenticateStart to exchange more authentication data.MysqlxSession.AuthenticateContinue.Builder Send by client or server after an @ref Mysqlx::Session::AuthenticateStart to exchange more authentication data.MysqlxSession.AuthenticateOk Sent by the server after successful authentication.MysqlxSession.AuthenticateOk.Builder Sent by the server after successful authentication.MysqlxSession.AuthenticateStart The initial message send from the client to the server to start the authentication process.MysqlxSession.AuthenticateStart.Builder The initial message send from the client to the server to start the authentication process.MysqlxSession.Close Close the current session.MysqlxSession.Close.Builder Close the current session.MysqlxSession.Reset Reset the current session.MysqlxSession.Reset.Builder Reset the current session.MysqlxSql MysqlxSql.StmtExecute Execute a statement in the given namespace.MysqlxSql.StmtExecute.Builder Execute a statement in the given namespace.MysqlxSql.StmtExecuteOk Statement executed successfullyMysqlxSql.StmtExecuteOk.Builder Statement executed successfully -
枚举概要 枚举 说明 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 user 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 scope of noticeMysqlxNotice.Frame.Type type of notice payloadMysqlxNotice.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) | @note this list isn't comprehensive.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 |