| Package | Description |
|---|---|
| com.mysql.cj.protocol.x | |
| com.mysql.cj.x.protobuf |
Message classes used for serialization with Google Protocol Buffers to support the X Protocol.
|
| com.mysql.cj.xdevapi |
Java classes for X DevAPI support.
|
| Class and Description |
|---|
| Mysqlx.Error
Protobuf type
Mysqlx.Error |
| MysqlxConnection.Compression
Protobuf type
Mysqlx.Connection.Compression |
| MysqlxCrud.Delete.Builder
Delete documents/rows from a Collection/Table
@returns @ref Mysqlx::Resultset
|
| MysqlxCrud.Find.Builder
Find Documents/Rows in a Collection/Table
@startuml
client -> server: Find
...
|
| MysqlxCrud.Insert.Builder
Insert documents/rows into a collection/table
@returns @ref Mysqlx::Resultset
|
| MysqlxCrud.Limit
Protobuf type
Mysqlx.Crud.Limit |
| MysqlxCrud.LimitExpr
LimitExpr, in comparison to Limit, is able to specify that row_count and
offset are placeholders.
|
| MysqlxCrud.Order
Sort order
|
| MysqlxCrud.Update.Builder
Update documents/rows in a collection/table
@returns @ref Mysqlx::Resultset
|
| MysqlxDatatypes.Any
A helper to allow all field types
|
| MysqlxDatatypes.Scalar
a scalar
|
| MysqlxExpr.Expr
The "root" of the expression tree.
|
| 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 |
|
| 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.FieldType
Protobuf enum
Mysqlx.Resultset.ColumnMetaData.FieldType |
| MysqlxResultset.Row
Row in a Resultset.
|
| MysqlxSql.StmtExecute
Execute a statement in the given namespace.
|
| MysqlxSql.StmtExecute.Builder
Execute a statement in the given namespace.
|
| Class and Description |
|---|
| 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.ClientMessages.Type
Protobuf enum
Mysqlx.ClientMessages.Type |
| Mysqlx.ClientMessagesOrBuilder |
| Mysqlx.Error
Protobuf type
Mysqlx.Error |
| Mysqlx.Error.Builder
Protobuf type
Mysqlx.Error |
| Mysqlx.Error.Severity
Protobuf enum
Mysqlx.Error.Severity |
| Mysqlx.ErrorOrBuilder |
| Mysqlx.Ok
Protobuf type
Mysqlx.Ok |
| Mysqlx.Ok.Builder
Protobuf type
Mysqlx.Ok |
| Mysqlx.OkOrBuilder |
| Mysqlx.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.
|
| Mysqlx.ServerMessages.Type
Protobuf enum
Mysqlx.ServerMessages.Type |
| Mysqlx.ServerMessagesOrBuilder |
| MysqlxConnection.Capabilities
Capabilities
list of Capability
|
| MysqlxConnection.Capabilities.Builder
Capabilities
list of Capability
|
| MysqlxConnection.CapabilitiesGet
Get supported connection capabilities and their current state.
|
| MysqlxConnection.CapabilitiesGet.Builder
Get supported connection capabilities and their current state.
|
| MysqlxConnection.CapabilitiesGetOrBuilder |
| MysqlxConnection.CapabilitiesOrBuilder |
| MysqlxConnection.CapabilitiesSet
Set connection capabilities atomically.
|
| MysqlxConnection.CapabilitiesSet.Builder
Set connection capabilities atomically.
|
| MysqlxConnection.CapabilitiesSetOrBuilder |
| MysqlxConnection.Capability
Capability
A tuple of a ``name`` and a @ref Mysqlx::Datatypes::Any
|
| MysqlxConnection.Capability.Builder
Capability
A tuple of a ``name`` and a @ref Mysqlx::Datatypes::Any
|
| MysqlxConnection.CapabilityOrBuilder |
| MysqlxConnection.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.CloseOrBuilder |
| MysqlxConnection.Compression
Protobuf type
Mysqlx.Connection.Compression |
| MysqlxConnection.Compression.Builder
Protobuf type
Mysqlx.Connection.Compression |
| MysqlxConnection.CompressionOrBuilder |
| MysqlxCrud.Collection
Protobuf type
Mysqlx.Crud.Collection |
| MysqlxCrud.Collection.Builder
Protobuf type
Mysqlx.Crud.Collection |
| MysqlxCrud.CollectionOrBuilder |
| MysqlxCrud.Column
Protobuf type
Mysqlx.Crud.Column |
| MysqlxCrud.Column.Builder
Protobuf type
Mysqlx.Crud.Column |
| MysqlxCrud.ColumnOrBuilder |
| MysqlxCrud.CreateView
CreateView create view based on indicated @ref Mysqlx::Crud::Find message
|
| MysqlxCrud.CreateView.Builder
CreateView create view based on indicated @ref Mysqlx::Crud::Find message
|
| MysqlxCrud.CreateViewOrBuilder |
| MysqlxCrud.DataModel
DataModel to use for filters, names, ...
|
| MysqlxCrud.Delete
Delete documents/rows from a Collection/Table
@returns @ref Mysqlx::Resultset
|
| MysqlxCrud.Delete.Builder
Delete documents/rows from a Collection/Table
@returns @ref Mysqlx::Resultset
|
| MysqlxCrud.DeleteOrBuilder |
| MysqlxCrud.DropView
DropView removing existing view
|
| MysqlxCrud.DropView.Builder
DropView removing existing view
|
| MysqlxCrud.DropViewOrBuilder |
| MysqlxCrud.Find
Find Documents/Rows in a Collection/Table
@startuml
client -> server: Find
...
|
| MysqlxCrud.Find.Builder
Find Documents/Rows in a Collection/Table
@startuml
client -> server: Find
...
|
| MysqlxCrud.Find.RowLock
Protobuf enum
Mysqlx.Crud.Find.RowLock |
| MysqlxCrud.Find.RowLockOptions
Protobuf enum
Mysqlx.Crud.Find.RowLockOptions |
| MysqlxCrud.FindOrBuilder |
| MysqlxCrud.Insert
Insert documents/rows into a collection/table
@returns @ref Mysqlx::Resultset
|
| MysqlxCrud.Insert.Builder
Insert documents/rows into a collection/table
@returns @ref Mysqlx::Resultset
|
| MysqlxCrud.Insert.TypedRow
set of fields to insert as a one row
|
| MysqlxCrud.Insert.TypedRow.Builder
set of fields to insert as a one row
|
| MysqlxCrud.Insert.TypedRowOrBuilder |
| MysqlxCrud.InsertOrBuilder |
| MysqlxCrud.Limit
Protobuf type
Mysqlx.Crud.Limit |
| MysqlxCrud.Limit.Builder
Protobuf type
Mysqlx.Crud.Limit |
| MysqlxCrud.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.LimitExprOrBuilder |
| MysqlxCrud.LimitOrBuilder |
| MysqlxCrud.ModifyView
ModifyView modify existing view based on indicated
@ref Mysqlx::Crud::Find message
|
| MysqlxCrud.ModifyView.Builder
ModifyView modify existing view based on indicated
@ref Mysqlx::Crud::Find message
|
| MysqlxCrud.ModifyViewOrBuilder |
| MysqlxCrud.Order
Sort order
|
| MysqlxCrud.Order.Builder
Sort order
|
| MysqlxCrud.Order.Direction
Protobuf enum
Mysqlx.Crud.Order.Direction |
| MysqlxCrud.OrderOrBuilder |
| MysqlxCrud.Projection
Protobuf type
Mysqlx.Crud.Projection |
| MysqlxCrud.Projection.Builder
Protobuf type
Mysqlx.Crud.Projection |
| MysqlxCrud.ProjectionOrBuilder |
| MysqlxCrud.Update
Update documents/rows in a collection/table
@returns @ref Mysqlx::Resultset
|
| MysqlxCrud.Update.Builder
Update documents/rows in a collection/table
@returns @ref Mysqlx::Resultset
|
| MysqlxCrud.UpdateOperation
Protobuf type
Mysqlx.Crud.UpdateOperation |
| MysqlxCrud.UpdateOperation.Builder
Protobuf type
Mysqlx.Crud.UpdateOperation |
| MysqlxCrud.UpdateOperation.UpdateType
Protobuf enum
Mysqlx.Crud.UpdateOperation.UpdateType |
| MysqlxCrud.UpdateOperationOrBuilder |
| MysqlxCrud.UpdateOrBuilder |
| MysqlxCrud.ViewAlgorithm
ViewAlgorithm defines how MySQL Server processes the view
|
| MysqlxCrud.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 VIEW
|
| 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::Error
|
| MysqlxCursor.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::Error
|
| MysqlxCursor.CloseOrBuilder |
| MysqlxCursor.Fetch
Fetch next portion of data from a cursor
@startuml
client -> server: Fetch
alt Success
...
|
| MysqlxCursor.Fetch.Builder
Fetch next portion of data from a cursor
@startuml
client -> server: Fetch
alt Success
...
|
| MysqlxCursor.FetchOrBuilder |
| MysqlxCursor.Open
Open a cursor
@startuml
client -> server: Open
alt Success
...
|
| MysqlxCursor.Open.Builder
Open a cursor
@startuml
client -> server: Open
alt Success
...
|
| MysqlxCursor.Open.OneOfMessage
Protobuf type
Mysqlx.Cursor.Open.OneOfMessage |
| MysqlxCursor.Open.OneOfMessage.Builder
Protobuf type
Mysqlx.Cursor.Open.OneOfMessage |
| MysqlxCursor.Open.OneOfMessage.Type
Protobuf enum
Mysqlx.Cursor.Open.OneOfMessage.Type |
| MysqlxCursor.Open.OneOfMessageOrBuilder |
| MysqlxCursor.OpenOrBuilder |
| MysqlxDatatypes.Any
A helper to allow all field types
|
| MysqlxDatatypes.Any.Builder
A helper to allow all field types
|
| MysqlxDatatypes.Any.Type
Protobuf enum
Mysqlx.Datatypes.Any.Type |
| MysqlxDatatypes.AnyOrBuilder |
| MysqlxDatatypes.Array
An Array
|
| MysqlxDatatypes.Array.Builder
An Array
|
| MysqlxDatatypes.ArrayOrBuilder |
| MysqlxDatatypes.Object
An object
|
| MysqlxDatatypes.Object.Builder
An object
|
| MysqlxDatatypes.Object.ObjectField
Protobuf type
Mysqlx.Datatypes.Object.ObjectField |
| MysqlxDatatypes.Object.ObjectField.Builder
Protobuf type
Mysqlx.Datatypes.Object.ObjectField |
| MysqlxDatatypes.Object.ObjectFieldOrBuilder |
| MysqlxDatatypes.ObjectOrBuilder |
| MysqlxDatatypes.Scalar
a scalar
|
| MysqlxDatatypes.Scalar.Builder
a scalar
|
| MysqlxDatatypes.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.OctetsOrBuilder |
| MysqlxDatatypes.Scalar.String
a string with a charset/collation
|
| MysqlxDatatypes.Scalar.String.Builder
a string with a charset/collation
|
| MysqlxDatatypes.Scalar.StringOrBuilder |
| MysqlxDatatypes.Scalar.Type
Protobuf enum
Mysqlx.Datatypes.Scalar.Type |
| MysqlxDatatypes.ScalarOrBuilder |
| MysqlxExpect.Close
Close a Expect block.
|
| MysqlxExpect.Close.Builder
Close a Expect block.
|
| MysqlxExpect.CloseOrBuilder |
| 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 type
Mysqlx.Expect.Open.Condition |
| MysqlxExpect.Open.Condition.Builder
Protobuf type
Mysqlx.Expect.Open.Condition |
| MysqlxExpect.Open.Condition.ConditionOperation
Protobuf enum
Mysqlx.Expect.Open.Condition.ConditionOperation |
| MysqlxExpect.Open.Condition.Key
Protobuf enum
Mysqlx.Expect.Open.Condition.Key |
| MysqlxExpect.Open.ConditionOrBuilder |
| MysqlxExpect.Open.CtxOperation
Protobuf enum
Mysqlx.Expect.Open.CtxOperation |
| MysqlxExpect.OpenOrBuilder |
| MysqlxExpr.Array
An array of expressions
|
| MysqlxExpr.Array.Builder
An array of expressions
|
| MysqlxExpr.ArrayOrBuilder |
| MysqlxExpr.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 = "**"
@endcode
|
| MysqlxExpr.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 = "**"
@endcode
|
| MysqlxExpr.ColumnIdentifierOrBuilder |
| MysqlxExpr.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 "]" | "[" "*" "]"
@endcode
|
| MysqlxExpr.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 "]" | "[" "*" "]"
@endcode
|
| MysqlxExpr.DocumentPathItem.Type
Protobuf enum
Mysqlx.Expr.DocumentPathItem.Type |
| MysqlxExpr.DocumentPathItemOrBuilder |
| MysqlxExpr.Expr
The "root" of the expression tree.
|
| MysqlxExpr.Expr.Builder
The "root" of the expression tree.
|
| MysqlxExpr.Expr.Type
Protobuf enum
Mysqlx.Expr.Expr.Type |
| MysqlxExpr.ExprOrBuilder |
| MysqlxExpr.FunctionCall
Function call: ``func(a, b, "1", 3)``
@par production list
@code{unparsed}
function_call: `identifier` "(" [ `expr` ["," `expr` ]* ] ")"
@endcode
|
| MysqlxExpr.FunctionCall.Builder
Function call: ``func(a, b, "1", 3)``
@par production list
@code{unparsed}
function_call: `identifier` "(" [ `expr` ["," `expr` ]* ] ")"
@endcode
|
| MysqlxExpr.FunctionCallOrBuilder |
| MysqlxExpr.Identifier
Identifier: name, schame.name
@par production list
@code{unparsed}
identifier: string "." string |
: string
@endcode
|
| MysqlxExpr.Identifier.Builder
Identifier: name, schame.name
@par production list
@code{unparsed}
identifier: string "." string |
: string
@endcode
|
| MysqlxExpr.IdentifierOrBuilder |
| MysqlxExpr.Object
An object (with expression values)
|
| MysqlxExpr.Object.Builder
An object (with expression values)
|
| MysqlxExpr.Object.ObjectField
Protobuf type
Mysqlx.Expr.Object.ObjectField |
| MysqlxExpr.Object.ObjectField.Builder
Protobuf type
Mysqlx.Expr.Object.ObjectField |
| MysqlxExpr.Object.ObjectFieldOrBuilder |
| MysqlxExpr.ObjectOrBuilder |
| MysqlxExpr.Operator
Protobuf type
Mysqlx.Expr.Operator |
| MysqlxExpr.Operator.Builder
Protobuf type
Mysqlx.Expr.Operator |
| MysqlxExpr.OperatorOrBuilder |
| 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.Frame.Scope
scope of notice
|
| MysqlxNotice.Frame.Type
type of notice payload
|
| MysqlxNotice.FrameOrBuilder |
| 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.GroupReplicationStateChanged.Type
Protobuf enum
Mysqlx.Notice.GroupReplicationStateChanged.Type |
| MysqlxNotice.GroupReplicationStateChangedOrBuilder |
| 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.ServerHelloOrBuilder |
| MysqlxNotice.SessionStateChanged
Protobuf type
Mysqlx.Notice.SessionStateChanged |
| MysqlxNotice.SessionStateChanged.Builder
Protobuf type
Mysqlx.Notice.SessionStateChanged |
| MysqlxNotice.SessionStateChanged.Parameter
Protobuf enum
Mysqlx.Notice.SessionStateChanged.Parameter |
| MysqlxNotice.SessionStateChangedOrBuilder |
| MysqlxNotice.SessionVariableChanged
Notify clients about changes to the current session variables.
|
| MysqlxNotice.SessionVariableChanged.Builder
Notify clients about changes to the current session variables.
|
| MysqlxNotice.SessionVariableChangedOrBuilder |
| 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`` |
|
| MysqlxNotice.Warning.Level
Protobuf enum
Mysqlx.Notice.Warning.Level |
| MysqlxNotice.WarningOrBuilder |
| 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::Error
|
| MysqlxPrepare.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::Error
|
| MysqlxPrepare.DeallocateOrBuilder |
| MysqlxPrepare.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.ExecuteOrBuilder |
| 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::Error
|
| MysqlxPrepare.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::Error
|
| MysqlxPrepare.Prepare.OneOfMessage
Protobuf type
Mysqlx.Prepare.Prepare.OneOfMessage |
| MysqlxPrepare.Prepare.OneOfMessage.Builder
Protobuf type
Mysqlx.Prepare.Prepare.OneOfMessage |
| MysqlxPrepare.Prepare.OneOfMessage.Type
Determine which of optional fields was set by the client
(Workaround for missing "oneof" keyword in pb2.5)
|
| MysqlxPrepare.Prepare.OneOfMessageOrBuilder |
| MysqlxPrepare.PrepareOrBuilder |
| 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.ColumnMetaData.FieldType
Protobuf enum
Mysqlx.Resultset.ColumnMetaData.FieldType |
| MysqlxResultset.ColumnMetaDataOrBuilder |
| MysqlxResultset.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 |
|
| MysqlxResultset.FetchDone
All resultsets are finished
|
| MysqlxResultset.FetchDone.Builder
All resultsets are finished
|
| MysqlxResultset.FetchDoneMoreOutParams
Resultsets are finished, OUT paramset is next:
|
| MysqlxResultset.FetchDoneMoreOutParams.Builder
Resultsets are finished, OUT paramset is next:
|
| MysqlxResultset.FetchDoneMoreOutParamsOrBuilder |
| MysqlxResultset.FetchDoneMoreResultsets
Resultset and out-params are finished, but more resultsets available
|
| MysqlxResultset.FetchDoneMoreResultsets.Builder
Resultset and out-params are finished, but more resultsets available
|
| MysqlxResultset.FetchDoneMoreResultsetsOrBuilder |
| MysqlxResultset.FetchDoneOrBuilder |
| MysqlxResultset.FetchSuspended
Cursor is opened; still, the execution of PrepFetch or PrepExecute ended
|
| MysqlxResultset.FetchSuspended.Builder
Cursor is opened; still, the execution of PrepFetch or PrepExecute ended
|
| MysqlxResultset.FetchSuspendedOrBuilder |
| MysqlxResultset.Row
Row in a Resultset.
|
| MysqlxResultset.Row.Builder
Row in a Resultset.
|
| MysqlxResultset.RowOrBuilder |
| 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.AuthenticateContinueOrBuilder |
| MysqlxSession.AuthenticateOk
Sent by the server after successful authentication.
|
| MysqlxSession.AuthenticateOk.Builder
Sent by the server after successful authentication.
|
| MysqlxSession.AuthenticateOkOrBuilder |
| 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.AuthenticateStartOrBuilder |
| MysqlxSession.Close
Close the current session.
|
| MysqlxSession.Close.Builder
Close the current session.
|
| MysqlxSession.CloseOrBuilder |
| MysqlxSession.Reset
Reset the current session.
|
| MysqlxSession.Reset.Builder
Reset the current session.
|
| MysqlxSession.ResetOrBuilder |
| MysqlxSql.StmtExecute
Execute a statement in the given namespace.
|
| MysqlxSql.StmtExecute.Builder
Execute a statement in the given namespace.
|
| MysqlxSql.StmtExecuteOk
Statement executed successfully
|
| MysqlxSql.StmtExecuteOk.Builder
Statement executed successfully
|
| MysqlxSql.StmtExecuteOkOrBuilder |
| MysqlxSql.StmtExecuteOrBuilder |
| Class and Description |
|---|
| MysqlxCrud.Collection
Protobuf type
Mysqlx.Crud.Collection |
| MysqlxCrud.Column
Protobuf type
Mysqlx.Crud.Column |
| MysqlxCrud.Insert.TypedRow
set of fields to insert as a one row
|
| MysqlxCrud.Order
Sort order
|
| MysqlxCrud.Projection
Protobuf type
Mysqlx.Crud.Projection |
| MysqlxCrud.UpdateOperation.UpdateType
Protobuf enum
Mysqlx.Crud.UpdateOperation.UpdateType |
| MysqlxDatatypes.Any
A helper to allow all field types
|
| MysqlxDatatypes.Scalar
a scalar
|
| MysqlxExpr.Array
An array of expressions
|
| MysqlxExpr.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 = "**"
@endcode
|
| MysqlxExpr.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 "]" | "[" "*" "]"
@endcode
|
| MysqlxExpr.Expr
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` ]* ] ")"
@endcode
|
| MysqlxExpr.Identifier
Identifier: name, schame.name
@par production list
@code{unparsed}
identifier: string "." string |
: string
@endcode
|
| MysqlxExpr.Object
An object (with expression values)
|
| MysqlxExpr.Operator
Protobuf type
Mysqlx.Expr.Operator |