RESULT_SET

  • rows
    Type: array array[] · RESULT_SET_ROW[]
    required

    An ordered set of RESULT_SET rows.

    • Type: array · RESULT_SET_ROW

      A set of cells representing a RESULT_SET row, one cell for each column. Content of a cell is ANY (i.e. a OBJECT in most programming languages).

  • columns
    Type: array object[] · RESULT_SET_COLUMN[]

    A set of AQL column specifications, defined in the given AQL.

    An AQL column specification (e.g. a pair of column name and associated AQL path).

    • name
      Type: string
      required

      Name of the column. When column alias is not present in the AQL, a 0-based column index is used prefixed by a hash sign (i.e. #0, #1...)

    • path
      Type: string

      Path from the given AQL of the specified column.

  • meta
    Type: object · ResultSetMetadata

    RESULT_SET metadata.

    • _created
      Type: stringFormat: date-time

      Result creation time (in the extended ISO 8601 format).

    • _executed_aql
      Type: string

      The actual AQL query that was executed by the server, after replacing the query parameters. This attribute is not mandatory, but is useful for debugging.

    • _generator
      Type: string

      Some identifier of the application that generated the result, useful for debugging.

    • _href
      Type: stringFormat: uri

      URL of the executed query (only for GET endpoint).

    • _schema_version
      Type: string

      The version of the specification defining the serialized object.

    • _type
      Type: string

      The type of the serialized result object.

    • propertyName
      Type: anything
  • name
    Type: string · QueryName

    The (fully qualified) name of the query (when is registered as a stored query), in a format of [{namespace}::]{query-name}. The namespace prefix is optional, and when used it should be in a form of a reverse domain name.

  • q
    Type: string · AQL

    The given AQL query.