io.ebean.meta.MetaInfoManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation

composite of common runtime dependencies for all platforms

There is a newer version: 15.8.1

package io.ebean.meta;

import java.util.List;

/**
 * Provides access to the meta data in EbeanServer such as query execution statistics.
 */
public interface MetaInfoManager {

  /**
   * Return the MetaBeanInfo for a bean type.
   */
  MetaBeanInfo getMetaBeanInfo(Class beanClass);

  /**
   * Return all the MetaBeanInfo.
   */
  List getMetaBeanInfoList();

  /**
   * Collect and return the query plan statistics for all the beans.
   * 
   * Note that this excludes the query plan statistics where there has been no
   * executions (since the last collection with reset).
   * 
   */
  List collectQueryPlanStatistics(boolean reset);

  /**
   * Collect and return the ObjectGraphNode statistics.
   * 
   * These show query executions based on an origin point and relative path.
   * This is used to look at the amount of lazy loading occurring for a given
   * query origin point and highlight potential for tuning a query.
   * 
   *
   * @param reset Set to true to reset the underlying statistics after collection.
   */
  List collectNodeStatistics(boolean reset);

}