Modifier and Type	Class and Description
private static record	ExplainQuery.ExplainImpl

Access	Constructor and Description
pack-priv	ExplainQuery()

Modifier and Type	Method and Description
pack-priv static Explain	explain(final DSLContext ctx, final Query query)

ExplainQuery	back to summary
pack-priv ExplainQuery()

explain	back to summary
pack-priv static Explain explain(final DSLContext ctx, final Query query)

org.jooq.impl back to summary

private final Record ExplainQuery.ExplainImpl

Class Inheritance

extends Record
implements Explain

java.lang.Object
java.lang.Record
org.jooq.impl.ExplainQuery.ExplainImpl

All Implemented Interfaces

org.jooq.Explain

Record Components

rows:double
cost:double
plan:String

Field Summary

Modifier and Type	Field and Description
private final double	cost Record Component accessed by cost().
private final String	plan Record Component accessed by plan().
private final double	rows Record Component accessed by rows().

Constructor Summary

Access	Constructor and Description
private	ExplainImpl(double rows, double cost, String plan)

Method Summary

Modifier and Type	Method and Description
public double	cost() Record Component getter of cost. Implements org.jooq.Explain.cost. The cost the database associated with the execution of the query.
public final boolean	equals(Object the reference object with which to compare. o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public String	plan() Record Component getter of plan. Implements org.jooq.Explain.plan. The formatted plan as returned by the database.
public double	rows() Record Component getter of rows. Implements org.jooq.Explain.rows. The number of rows (cardinality) that is estimated to be returned by the query.
public String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

cost	back to summary
private final double cost Record Component accessed by cost().

plan	back to summary
private final String plan Record Component accessed by plan().

rows	back to summary
private final double rows Record Component accessed by rows().

Constructor Detail

ExplainImpl	back to summary
private ExplainImpl(double rows, double cost, String plan)

Method Detail

cost back to summary

cost	back to summary
public double cost() Record Component getter of cost. Implements org.jooq.Explain.cost. Doc from org.jooq.Explain.cost. The cost the database associated with the execution of the query. This returns `Double#NaN` if cost could not be retrieved.

public double cost()

Record Component getter of cost.

Implements org.jooq.Explain.cost.

Doc from org.jooq.Explain.cost.

The cost the database associated with the execution of the query.

This returns Double#NaN if cost could not be retrieved.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this record is equal to the argument; `false` otherwise.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code. Returns:int a hash code value for this record.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int: a hash code value for this record.

plan	back to summary
public String plan() Record Component getter of plan. Implements org.jooq.Explain.plan. Doc from org.jooq.Explain.plan. The formatted plan as returned by the database.

plan

back to summary

public String plan()

Record Component getter of plan.

Implements org.jooq.Explain.plan.

Doc from org.jooq.Explain.plan.

The formatted plan as returned by the database.

rows back to summary

rows	back to summary
public double rows() Record Component getter of rows. Implements org.jooq.Explain.rows. Doc from org.jooq.Explain.rows. The number of rows (cardinality) that is estimated to be returned by the query. This returns `Double#NaN` if rows could not be estimated.

public double rows()

Record Component getter of rows.

Implements org.jooq.Explain.rows.

Doc from org.jooq.Explain.rows.

The number of rows (cardinality) that is estimated to be returned by the query.

This returns Double#NaN if rows could not be estimated.

toString back to summary

toString	back to summary
public String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves. Returns:String a string representation of the object. Annotations @Override

public String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String

a string representation of the object.

Annotations

@Override

pack-priv final Class ExplainQuery

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Record ExplainQuery.ExplainImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail