com.cloudant.client.api.query

Class ExecutionStats

java.lang.Object

com.cloudant.client.api.query.ExecutionStats

public class ExecutionStats
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ExecutionStats(long totalKeysExamined, long totalDocsExamined, long totalQuorumDocsExamined, long resultsReturned, long executionTimeMs)

Method Summary

Modifier and Type	Method and Description
double	getExecutionTimeMs()
long	getResultsReturned()
long	getTotalDocsExamined()
long	getTotalKeysExamined()
long	getTotalQuorumDocsExamined()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutionStats

public ExecutionStats(long totalKeysExamined,
                      long totalDocsExamined,
                      long totalQuorumDocsExamined,
                      long resultsReturned,
                      long executionTimeMs)

Method Detail

getTotalKeysExamined

public long getTotalKeysExamined()

Returns:

Number of index keys examined. Currently always 0.

getTotalDocsExamined

public long getTotalDocsExamined()

Returns:

Number of documents fetched from the database / index, equivalent to using include_docs=true in a view. These may then be filtered in-memory to further narrow down the result set based on the selector.

getTotalQuorumDocsExamined

public long getTotalQuorumDocsExamined()

Returns:

Number of documents fetched from the database using an out-of-band document fetch. This is only non-zero when read quorum > 1 is specified in the query parameters.

getResultsReturned

public long getResultsReturned()

Returns:

Number of results returned from the query. Ideally this should not be significantly lower than the total documents / keys examined.

getExecutionTimeMs

public double getExecutionTimeMs()

Returns:

Total execution time in milliseconds as measured by the database.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object