Class DefaultN1qlQueryResult

    • Constructor Detail

      • DefaultN1qlQueryResult

        public DefaultN1qlQueryResult​(List<AsyncN1qlQueryRow> rows,
                                      Object signature,
                                      N1qlMetrics info,
                                      List<JsonObject> errors,
                                      JsonObject profileInfo,
                                      String finalStatus,
                                      Boolean finalSuccess,
                                      boolean parseSuccess,
                                      String requestId,
                                      String clientContextId)
        Create a default blocking representation of a query result.
        rows - the list of rows.
        signature - the signature for rows.
        info - the metrics.
        profileInfo - the profile information
        errors - the list of errors and warnings.
        finalStatus - the definitive (but potentially delayed) status of the query.
        finalSuccess - the definitive (but potentially delayed) success of the query.
        parseSuccess - the intermediate result of the query
    • Method Detail

      • signature

        public Object signature()
        Specified by:
        signature in interface N1qlQueryResult
        an object representing the signature of the results, that can be used to learn about the common structure of each row. This signature is usually a JsonObject, but could also be any JSON-valid type like a boolean scalar, JsonArray...
      • info

        public N1qlMetrics info()
        Specified by:
        info in interface N1qlQueryResult
        an object describing some metrics/info about the execution of the query.
      • profileInfo

        public JsonObject profileInfo()
        Specified by:
        profileInfo in interface N1qlQueryResult
        an object describing some profiling info about the execution of the query.
      • parseSuccess

        public boolean parseSuccess()
        Specified by:
        parseSuccess in interface N1qlQueryResult
        true if the query could be parsed, false if it short-circuited due to syntax/fatal error.
      • finalSuccess

        public boolean finalSuccess()
        Description copied from interface: N1qlQueryResult
        Denotes the success or failure of the query. It could fail slower than with N1qlQueryResult.parseSuccess(), for example if a fatal error comes up while streaming the results to the client. This method blocks until the query is over and the success can be established.
        Specified by:
        finalSuccess in interface N1qlQueryResult
      • status

        public String status()
        Description copied from interface: N1qlQueryResult
        Returns the final status of the query. For example, a successful query will return "success" (which is equivalent to N1qlQueryResult.finalSuccess() returning true). Other statuses include (but are not limited to) "fatal" when fatal errors occurred and "timeout" when the query timed out on the server side but not yet on the client side. This method blocks until the query is over and the status can be established.
        Specified by:
        status in interface N1qlQueryResult
      • clientContextId

        public String clientContextId()
        Specified by:
        clientContextId in interface N1qlQueryResult
        the clientContextId that was set by the client (could be truncated to 64 bytes of UTF-8 chars)