Package io.ebean.meta

Class QueryPlanRequest

java.lang.Object
io.ebean.meta.QueryPlanRequest
public class QueryPlanRequest
extends Object
Request used to capture query plans.

  • Constructor Summary

    Constructors
    Constructor Description
    QueryPlanRequest()  

  • Method Summary

    Modifier and Type Method Description
    int getMaxCount()
    Return the maximum number of plans to capture.
    long getMaxTimeMillis()
    Return the maximum amount of time we want to use to capture plans.
    long getSince()
    Return the epoch time in millis for minimum bind capture time.
    void setMaxCount​(int maxCount)
    Set the maximum number of plans to capture.
    void setMaxTimeMillis​(long maxTimeMillis)
    Set the maximum amount of time we want to use to capture plans.
    void setSince​(long since)
    Set the epoch time (e.g.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • getSince

      public long getSince()
      Return the epoch time in millis for minimum bind capture time.

      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.

    • setSince

      public void setSince​(long 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.
      Parameters:
      since - The minimum age of the bind values capture.

    • getMaxCount

      public int getMaxCount()
      Return the maximum number of plans to capture.

    • setMaxCount

      public void setMaxCount​(int maxCount)
      Set the maximum number of plans to capture.

      Use this to limit how much query plan capturing is done as query plan capture is actual database load.

    • getMaxTimeMillis

      public long getMaxTimeMillis()
      Return the maximum amount of time we want to use to capture plans.

      Query plan collection will stop once this time is exceeded.

    • setMaxTimeMillis

      public void setMaxTimeMillis​(long maxTimeMillis)
      Set the maximum amount of time we want to use to capture plans.

      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.