Class Hierarchy        Index

Interface COM.cloudscape.types.RunTimeStatistics

public interface RunTimeStatistics
extends Serializable
Copyright © 1998-1999, Cloudscape, Inc. All rights reserved.

A RunTimeStatistics object is a representation of the query execution plan and run time statistics for a java.sql.ResultSet. A query execution plan is a tree of execution nodes. There are a number of possible node types. Statistics are accumulated during execution at each node. The types of statistics include the amount of time spent in specific operations (if STATISTICS TIMING is SET ON), the number of rows passed to the node by its child(ren) and the number of rows returned by the node to its parent. (The exact statistics are specific to each node type.)

RunTimeStatistics is most meaningful for DML statements (SELECT, INSERT, DELETE and UPDATE).

See Also:
RunTimeStatistics

Variable Index

 o CLASS_NAME

Method Index

 o getBeginCompilationTimestamp()
Get the timestamp for the beginning of query compilation.
 o getBeginExecutionTimestamp()
Get the timestamp for the beginning of query execution.
 o getBindTimeInMillis()
Get the bind time for the associated query in milliseconds.
 o getCompileTimeInMillis()
Get the total compile time for the associated query in milliseconds.
 o getEndCompilationTimestamp()
Get the timestamp for the end of query compilation.
 o getEndExecutionTimestamp()
Get the timestamp for the end of query execution.
 o getEstimatedRowCount()
Get the estimated row count for the number of rows returned by the associated query or statement.
 o getExecuteTimeInMillis()
Get the execute time for the associated query in milliseconds.
 o getGenerateTimeInMillis()
Get the generate time for the associated query in milliseconds.
 o getOptimizeTimeInMillis()
Get the optimize time for the associated query in milliseconds.
 o getParseTimeInMillis()
Get the parse time for the associated query in milliseconds.
 o getScanStatisticsText()
Get a String representation of the information on the nodes relating to table and index scans from the execution plan for the associated query or statement.
 o getSPSName()
Get the name of the Stored Prepared Statement used for the statement.
 o getStatementExecutionPlanText()
Get a String representation of the execution plan for the associated query or statement.
 o getStatementName()
Get the name of the associated query or statement.
 o getStatementText()
Get the text for the associated query or statement.

Variables

 o CLASS_NAME
 public static final String CLASS_NAME

Methods

 o getCompileTimeInMillis
 public abstract long getCompileTimeInMillis()
Get the total compile time for the associated query in milliseconds. Compile time can be divided into parse, bind, optimize and generate times.

0 is returned if STATISTICS TIMING is not SET ON.

Returns:
The total compile time for the associated query in milliseconds.
 o getParseTimeInMillis
 public abstract long getParseTimeInMillis()
Get the parse time for the associated query in milliseconds.

0 is returned if STATISTICS TIMING is not SET ON.

Returns:
The parse time for the associated query in milliseconds.
 o getBindTimeInMillis
 public abstract long getBindTimeInMillis()
Get the bind time for the associated query in milliseconds.

Returns:
The bind time for the associated query in milliseconds.
 o getOptimizeTimeInMillis
 public abstract long getOptimizeTimeInMillis()
Get the optimize time for the associated query in milliseconds.

0 is returned if STATISTICS TIMING is not SET ON.

Returns:
The optimize time for the associated query in milliseconds.
 o getGenerateTimeInMillis
 public abstract long getGenerateTimeInMillis()
Get the generate time for the associated query in milliseconds.

0 is returned if STATISTICS TIMING is not SET ON.

Returns:
The generate time for the associated query in milliseconds.
 o getExecuteTimeInMillis
 public abstract long getExecuteTimeInMillis()
Get the execute time for the associated query in milliseconds.

0 is returned if STATISTICS TIMING is not SET ON.

Returns:
The execute time for the associated query in milliseconds.
 o getBeginCompilationTimestamp
 public abstract Timestamp getBeginCompilationTimestamp()
Get the timestamp for the beginning of query compilation.

A null is returned if STATISTICS TIMING is not SET ON.

Returns:
The timestamp for the beginning of query compilation.
 o getEndCompilationTimestamp
 public abstract Timestamp getEndCompilationTimestamp()
Get the timestamp for the end of query compilation.

A null is returned if STATISTICS TIMING is not SET ON.

Returns:
The timestamp for the end of query compilation.
 o getBeginExecutionTimestamp
 public abstract Timestamp getBeginExecutionTimestamp()
Get the timestamp for the beginning of query execution.

A null is returned if STATISTICS TIMING is not SET ON.

Returns:
The timestamp for the beginning of query execution.
 o getEndExecutionTimestamp
 public abstract Timestamp getEndExecutionTimestamp()
Get the timestamp for the end of query execution.

A null is returned if STATISTICS TIMING is not SET ON.

Returns:
The timestamp for the end of query execution.
 o getStatementName
 public abstract String getStatementName()
Get the name of the associated query or statement. (This will be an internally generated name if the user did not assign a name.)

Returns:
The name of the associated query or statement.
 o getSPSName
 public abstract String getSPSName()
Get the name of the Stored Prepared Statement used for the statement. This method returns a value only for EXECUTE STATEMENT statements; otherwise, returns null.

Note that the name is returned in the schema.name format (e.g. APP.MYSTMT).

Returns:
The Stored Prepared Statement name of the associated statement, or null if it is not an EXECUTE STATEMENT statement.
 o getStatementText
 public abstract String getStatementText()
Get the text for the associated query or statement.

Returns:
The text for the associated query or statement.
 o getStatementExecutionPlanText
 public abstract String getStatementExecutionPlanText()
Get a String representation of the execution plan for the associated query or statement.

Returns:
The execution plan for the associated query or statement.
 o getScanStatisticsText
 public abstract String getScanStatisticsText()
Get a String representation of the information on the nodes relating to table and index scans from the execution plan for the associated query or statement.

Returns:
The nodes relating to table and index scans from the execution plan for the associated query or statement.
 o getEstimatedRowCount
 public abstract double getEstimatedRowCount()
Get the estimated row count for the number of rows returned by the associated query or statement.

Returns:
The estimated number of rows returned by the associated query or statement.

  Class Hierarchy        Index