Mysqlx::Crud::Find Struct Reference

Find Documents/Rows in a Collection/Table. More...

Public Types
enum	RowLock { SHARED_LOCK = 1 , EXCLUSIVE_LOCK = 2 }
enum	RowLockOptions { NOWAIT = 1 , SKIP_LOCKED = 2 }

Public Attributes
required Collection	collection = 2
	collection in which to find More...
optional DataModel	data_model = 3
	data model that the operations refer to More...
repeated Projection	projection = 4
	list of column projections that shall be returned More...
repeated Mysqlx::Datatypes::Scalar	args = 11
	values for parameters used in filter expression More...
optional Mysqlx::Expr::Expr	criteria = 5
	filter criteria More...
optional Limit	limit = 6
	numbers of rows that shall be skipped and returned (user can set one of: limit, limit_expr) More...
repeated Order	order = 7
	sort-order in which the rows/document shall be returned in More...
repeated Mysqlx::Expr::Expr	grouping = 8
	column expression list for aggregation (GROUP BY) More...
optional Mysqlx::Expr::Expr	grouping_criteria = 9
	filter criteria for aggregated groups More...
optional RowLock	locking = 12
	perform row locking on matches More...
optional RowLockOptions	locking_options = 13
	additional options how to handle locked rows More...
optional LimitExpr	limit_expr = 14
	numbers of rows that shall be skipped and returned (user can set one of: limit, limit_expr) More...
ClientMessages::Type	client_message_id = CRUD_FIND

Detailed Description

Find Documents/Rows in a Collection/Table.

Returns

Mysqlx::Resultset

Member Enumeration Documentation

RowLock

enum Mysqlx::Crud::Find::RowLock

Enumerator
SHARED_LOCK	Lock matching rows against updates.
EXCLUSIVE_LOCK	Lock matching rows so no other transaction can read or write to it.

RowLockOptions

enum Mysqlx::Crud::Find::RowLockOptions

Enumerator
NOWAIT	Do not wait to acquire row lock, fail with an error if a requested row is locked.
SKIP_LOCKED	Do not wait to acquire a row lock, remove locked rows from the result set.

Member Data Documentation

args

repeated Mysqlx::Datatypes::Scalar Mysqlx::Crud::Find::args = 11

values for parameters used in filter expression

client_message_id

ClientMessages::Type Mysqlx::Crud::Find::client_message_id = CRUD_FIND

collection

required Collection Mysqlx::Crud::Find::collection = 2

collection in which to find

criteria

optional Mysqlx::Expr::Expr Mysqlx::Crud::Find::criteria = 5

filter criteria

data_model

optional DataModel Mysqlx::Crud::Find::data_model = 3

data model that the operations refer to

grouping

repeated Mysqlx::Expr::Expr Mysqlx::Crud::Find::grouping = 8

column expression list for aggregation (GROUP BY)

grouping_criteria

optional Mysqlx::Expr::Expr Mysqlx::Crud::Find::grouping_criteria = 9

filter criteria for aggregated groups

limit

optional Limit Mysqlx::Crud::Find::limit = 6

numbers of rows that shall be skipped and returned (user can set one of: limit, limit_expr)

limit_expr

optional LimitExpr Mysqlx::Crud::Find::limit_expr = 14

numbers of rows that shall be skipped and returned (user can set one of: limit, limit_expr)

locking

optional RowLock Mysqlx::Crud::Find::locking = 12

perform row locking on matches

locking_options

optional RowLockOptions Mysqlx::Crud::Find::locking_options = 13

additional options how to handle locked rows

order

repeated Order Mysqlx::Crud::Find::order = 7

sort-order in which the rows/document shall be returned in

projection

repeated Projection Mysqlx::Crud::Find::projection = 4

list of column projections that shall be returned

---

The documentation for this struct was generated from the following file:

• plugin/x/protocol/protobuf/mysqlx_crud.proto