Interface QueryProfile

All Superinterfaces:
Plan
All Known Implementing Classes:
InternalQueryProfile
public sealed interface QueryProfile extends Plan permits InternalQueryProfile
This is the same as a regular Plan - except this plan has been executed, meaning it also contains detailed information about how much work each step of the plan incurred on the database.
Since:
6.2.0

  • Method Summary

    Modifier and Type
    Method
    Description
    List<? extends QueryProfile>
    children()
    As noted in the class-level javadoc, a plan is a tree, where each child is another plan.
    OptionalLong
    dbHits()
    Returns the number of times this part of the plan touched the underlying data stores if it was recorded.
    OptionalDouble
    pageCacheHitRatio()
    Returns the ratio of page cache hits to total number of lookups if it was recorded.
    OptionalLong
    pageCacheHits()
    Returns the number of page cache hits caused by executing the associated execution step if it was recorded.
    OptionalLong
    pageCacheMisses()
    Returns the number of page cache misses caused by executing the associated execution step if it was recorded.
    OptionalLong
    rows()
    Returns the number of rows processed by the associated execution step if it was recorded.
    Optional<Duration>
    time()
    Returns the amount of time spent in the associated execution step if it was recorded.

    Methods inherited from interface Plan

    arguments, identifiers, operatorType

  • Method Details

    • dbHits

      OptionalLong dbHits()
      Returns the number of times this part of the plan touched the underlying data stores if it was recorded.
      Returns:
      the number of times this part of the plan touched the underlying data stores if it was recorded

    • rows

      OptionalLong rows()
      Returns the number of rows processed by the associated execution step if it was recorded.
      Returns:
      the number of rows processed by the associated execution step if it was recorded

    • pageCacheHits

      OptionalLong pageCacheHits()
      Returns the number of page cache hits caused by executing the associated execution step if it was recorded.
      Returns:
      the number of page cache hits caused by executing the associated execution step if it was recorded

    • pageCacheMisses

      OptionalLong pageCacheMisses()
      Returns the number of page cache misses caused by executing the associated execution step if it was recorded.
      Returns:
      the number of page cache misses caused by executing the associated execution step if it was recorded

    • pageCacheHitRatio

      OptionalDouble pageCacheHitRatio()
      Returns the ratio of page cache hits to total number of lookups if it was recorded.
      Returns:
      the ratio of page cache hits to total number of lookups if it was recorded

    • time

      Optional<Duration> time()
      Returns the amount of time spent in the associated execution step if it was recorded.
      Returns:
      the amount of time spent in the associated execution step if it was recorded

    • children

      List<? extends QueryProfile> children()
      Description copied from interface: Plan
      As noted in the class-level javadoc, a plan is a tree, where each child is another plan. The children are where this part of the plan gets its input records - unless this is an operator that introduces new records on its own.
      Specified by:
      children in interface Plan
      Returns:
      zero or more child plans