package Polarx.Crud

Get desktop application:
View/edit binary Protocol Buffers messages

collection

Used in: Delete, Find, Insert, Update

• required string name = 1

• optional string schema = 2

column definition

Used in: Insert

• optional string name = 1

• optional string alias = 2

• repeated Expr.DocumentPathItem document_path = 3

DataModel to use for filters, names, ...

Used in: Delete, Find, Insert, Update

• DOCUMENT = 1

• TABLE = 2

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 :param order: specifies order of matched rows :Returns: :protobuf:msg:`Polarx.Resultset::`

• required Collection collection = 1

• optional DataModel data_model = 2

• optional Expr.Expr criteria = 3

• repeated Datatypes.Scalar args = 6

• optional Limit limit = 4

• repeated Order order = 5

Find Documents/Rows in a Collection/Table .. uml:: client -> server: Find ... one or more Resultset ... :param collection: collection to insert into :param data_model: datamodel that the operations refer to :param projection: list of column projections that shall be returned :param args: values for parameters used in filter expression :param criteria: filter criteria :param limit: numbers of rows that shall be skipped and returned :param order: sort-order in which the rows/document shall be returned in :param grouping: column expression list for aggregation (GROUP BY) :param grouping_criteria: filter criteria for aggregated groups :Returns: :protobuf:msg:`Polarx.Resultset::`

• required Collection collection = 2

• optional DataModel data_model = 3

• repeated Projection projection = 4

• optional Expr.Expr criteria = 5

• repeated Datatypes.Scalar args = 11

• optional Limit limit = 6

• repeated Order order = 7

• repeated Expr.Expr grouping = 8

• optional Expr.Expr grouping_criteria = 9

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 :Returns: :protobuf:msg:`Polarx.Resultset::`

• required Collection collection = 1

• optional DataModel data_model = 2

• repeated Column projection = 3

• repeated Insert.TypedRow row = 4

• repeated Datatypes.Scalar args = 5

Used in: Insert

• repeated Expr.Expr field = 1

limit :param row_count: maximum rows to filter :param offset: maximum rows to skip before applying the row_count

Used in: Delete, Find, Update

• required uint64 row_count = 1

• optional uint64 offset = 2

sort order

Used in: Delete, Find, Update

• required Expr.Expr expr = 1

• optional Order.Direction direction = 2

Used in: Order

• ASC = 1

• DESC = 2

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. Required for DOCUMENTs (clients may use the source string as default)

Used in: Find

• required Expr.Expr source = 1

• optional string alias = 2

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 :param order: specifies order of matched rows :param operation: list of operations to be applied. Valid operations will depend on the data_model. :Returns: :protobuf:msg:`Polarx.Resultset::`

• required Collection collection = 2

• optional DataModel data_model = 3

• optional Expr.Expr criteria = 4

• repeated Datatypes.Scalar args = 8

• optional Limit limit = 5

• repeated Order order = 6

• repeated UpdateOperation operation = 7

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 operation

Used in: Update

• required Expr.ColumnIdentifier source = 1

• required UpdateOperation.UpdateType operation = 2

• optional Expr.Expr value = 3

Used in: UpdateOperation

• SET = 1

  only allowed for TABLE

• ITEM_REMOVE = 2

  no value (removes the identified path from a object or array)

• ITEM_SET = 3

  sets the new value on the identified path

• ITEM_REPLACE = 4

  replaces a value if the path exists

• ITEM_MERGE = 5

  source and value must be documents

• ARRAY_INSERT = 6

  insert the value in the array at the index identified in the source path

• ARRAY_APPEND = 7

  append the value on the array at the identified path