QueryResult

baja.coll. QueryResult

new QueryResult()

Description:

  • Represents a baja:QueryResult in BajaScript.

    A QueryResult can be resolved from a NEQL query.

Source:

Members

(static) DEFAULT :baja.coll.QueryResult

Description:

  • Default QueryResult instance.

Source:

Default QueryResult instance.

Type:

Methods

cursor(obj) → {Promise}

Description:

  • Iterate through a QueryResult's Entities.

    Please note, this may retrieve data asynchronously.

    A callback function is passed in to retrieve the Cursor.

Source:
See:
Example
myQueryResult.cursor({
    each: function () {
      // Called for each Entity in the Cursor...
      var dataFromCursor = this.get();
    }
  })
    .then(function (cursor) {
      // Called once we have the Cursor
    })
    .catch(function (err) {
      // Called if any errors in getting data
    });
Parameters:
Name Type Description
obj Object | function

the object literal that specifies the method's
arguments.

Properties
Name Type Attributes Default Description
ok function <optional>

(Deprecated: use Promise) called when the
cursor has been created with the cursor as an argument.
fail function <optional>

(Deprecated: use Promise) called if the cursor
fails to be retrieved. An error is passed in as the first argument.
batch baja.comm.Batch <optional>

if specified, the operation will be
batched into this object.
before function <optional>

called just before the Cursor is about to be
iterated through.
after function <optional>

called just after the Cursor has finished
iterating.
offset Number <optional>
 0

Specifies the row number to start encoding
the result-set from.
limit Number <optional>
 10

Specifies the maximum number of rows that
can be encoded.
Returns:

a promise that will be resolved once the cursor has been
retrieved.

Type
Promise

getQuery() → {String}

Description:

  • Return the Query string for the result.

Source:
Returns:

The Query.

Type
String

getScopeOrd() → {baja.Ord}

Description:

  • Return the Scope ORD for the result.

Source:
Returns:

The Scope ORD.

Type
baja.Ord