QueryClass {RBaseX}

QueryClass

Description

The client can be used in 'standard' mode and in 'query' mode. Query mode is used to define queries, binding variables and for iterative evaluation.

Methods

Public methods

• QueryClass$new()

• QueryClass$ExecuteQuery()

• QueryClass$Bind()

• QueryClass$Context()

• QueryClass$Full()

• QueryClass$More()

• QueryClass$Next()

• QueryClass$Info()

• QueryClass$Options()

• QueryClass$Updating()

• QueryClass$Close()

• QueryClass$clone()

Method new()

Initialize a new instance from QueryClass

Usage

QueryClass$new(query, Parent)

Arguments

query

Query-string

Parent

The 'Parent' for this QueryClass-instance

Details

QueryClass-instances can only be created by calling the 'Query'-method from the 'BasexClient'-class.

Method ExecuteQuery()

Executes a query.

Usage

QueryClass$ExecuteQuery()

Method Bind()

Binds a value to a variable.

Usage

QueryClass$Bind(...)

Arguments

...

Binding Information

query_obj

QueryClass instance-ID

Details

When using the primitive functions, this function can be chained.

Method Context()

Binds a value to the context. The type will be ignored if the string is empty.

Usage

QueryClass$Context(value, type)

Arguments

value

Value that should be boud to the context

type

The type will be ignored when the string is empty

Details

When using the primitive functions, this function can be chained.

Method Full()

Executes a query and returns a vector with all resulting items as strings, prefixed by the 'XDM' (Xpath Data Model) Meta Data <https://www.xdm.org/>.

Usage

QueryClass$Full()

Method More()

Indicates if there are any other results in the query-result.

Usage

QueryClass$More()

Method Next()

Returns the next result when iterating over a query

Usage

QueryClass$Next()

Method Info()

Returns a string with query compilation and profiling info.

Usage

QueryClass$Info()

Method Options()

Returns a string with all query serialization parameters, which can e.g. be assigned to the serializer option.

Usage

QueryClass$Options()

Method Updating()

Check if the query contains updating expressions.

Usage

QueryClass$Updating()

Method Close()

Closes and unregisters the query with the specified ID

Usage

QueryClass$Close()

Details

When using the primitive functions, this function can be chained.

Method clone()

The objects of this class are cloneable with this method.

Usage

QueryClass$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.