ebean/ebean-api/src/main/java/io/ebean/meta/QueryPlanRequest.java

package io.ebean.meta;

/**
 * Request used to capture query plans.
 */
public class QueryPlanRequest {

  private long since;

  private int maxCount;

  private long maxTimeMillis;

  /**
   * Return the epoch time in millis for minimum bind capture time.
   * <p>
   * When set this ensures that the bind values used to get the query plan
   * have been around for a while (e.g. 5 mins) and so reasonably represent
   * bind values that match the slowest execution for this query plan.
   */
  public long since() {
    return since;
  }

  /**
   * Set the epoch time (e.g. 5 mins ago) such that the query bind values
   * reasonably represent bind values that match the slowest execution for this query plan.
   *
   * @param since The minimum age of the bind values capture.
   */
  public void since(long since) {
    this.since = since;
  }

  /**
   * Return the maximum number of plans to capture.
   */
  public int maxCount() {
    return maxCount;
  }

  /**
   * Set the maximum number of plans to capture.
   * <p>
   * Use this to limit how much query plan capturing is done as query
   * plan capture is actual database load.
   */
  public void maxCount(int maxCount) {
    this.maxCount = maxCount;
  }

  /**
   * Return the maximum amount of time we want to use to capture plans.
   * <p>
   * Query plan collection will stop once this time is exceeded.
   */
  public long maxTimeMillis() {
    return maxTimeMillis;
  }

  /**
   * Set the maximum amount of time we want to use to capture plans.
   * <p>
   * Query plan collection will stop once this time is exceeded. We use
   * this to ensure the query plan capture does not use excessive amount
   * of time - put too much load on the database.
   */
  public void maxTimeMillis(long maxTimeMillis) {
    this.maxTimeMillis = maxTimeMillis;
  }
}