Package com.arangodb.entity

Class CursorEntity<T>

java.lang.Object
com.arangodb.entity.CursorEntity<T>
public final class CursorEntity<T> extends Object
Author:
Mark Vollmary

  • Constructor Details

    • CursorEntity

      public CursorEntity()

  • Method Details

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • getCount

      public Integer getCount()
      Returns:
      the total number of result documents available (only available if the query was executed with the count attribute set)

    • getExtra

      public CursorEntity.Extras getExtra()
      Returns:
      an optional object with extra information about the query result contained in its stats sub-attribute. For data-modification queries, the extra.stats sub-attribute will contain the number of modified documents and the number of documents that could not be modified due to an error (if ignoreErrors query option is specified)

    • getCached

      public Boolean getCached()
      Returns:
      a boolean flag indicating whether the query result was served from the query cache or not. If the query result is served from the query cache, the extra return attribute will not contain any stats sub-attribute and no profile sub-attribute.

    • getHasMore

      public Boolean getHasMore()
      Returns:
      A boolean indicator whether there are more results available for the cursor on the server

    • getResult

      public List<T> getResult()
      Returns:
      a list of result documents (might be empty if query has no results)

    • isPotentialDirtyRead

      public Boolean isPotentialDirtyRead()
      Returns:
      true if the result is a potential dirty read
      Since:
      ArangoDB 3.10

    • setPotentialDirtyRead

      public void setPotentialDirtyRead(Boolean potentialDirtyRead)

    • getNextBatchId

      public String getNextBatchId()
      Returns:
      The ID of the batch after the current one. The first batch has an ID of 1 and the value is incremented by 1 with every batch. Only set if the allowRetry query option is enabled.
      Since:
      ArangoDB 3.11