Module org.neo4j.driver
Package org.neo4j.driver.summary

Interface ProfiledPlan

All Superinterfaces:
Plan
All Known Implementing Classes:
InternalProfiledPlan
public interface ProfiledPlan extends Plan
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:
1.0

  • Method Details

    • dbHits

      long dbHits()
      Returns:
      the number of times this part of the plan touched the underlying data stores

    • records

      long records()
      Returns:
      the number of records this part of the plan produced

    • hasPageCacheStats

      boolean hasPageCacheStats()
      Returns:
      if the number page cache hits and misses and the ratio was recorded.

    • pageCacheHits

      long pageCacheHits()
      Returns:
      number of page cache hits caused by executing the associated execution step

    • pageCacheMisses

      long pageCacheMisses()
      Returns:
      number of page cache misses caused by executing the associated execution step

    • pageCacheHitRatio

      double pageCacheHitRatio()
      Returns:
      the ratio of page cache hits to total number of lookups or 0 if no data is available

    • time

      long time()
      Returns:
      amount of time spent in the associated execution step.

    • children

      List<ProfiledPlan> 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.