Module org.postgresql.pljava
Package org.postgresql.pljava.annotation

Enum Class Aggregate.FinishEffect

java.lang.Object
java.lang.Enum<Aggregate.FinishEffect>
org.postgresql.pljava.annotation.Aggregate.FinishEffect
All Implemented Interfaces:
Serializable, Comparable<Aggregate.FinishEffect>, Constable
Enclosing class:
Aggregate
public static enum Aggregate.FinishEffect extends Enum<Aggregate.FinishEffect>
Declares the effect of the finish function in a Plan.

If READ_ONLY, PostgreSQL can continue updating the same state with additional rows, and call the finisher again for updated results.

If SHAREABLE, the state cannot be further updated after a finisher call, but finishers for other aggregates that use the same state representation (and are also SHAREABLE) can be called to produce the results for those aggregates. An example could be the several linear-regression-related aggregates, all of which can work from a state that contains the count of values, sum of values, and sum of squares.

If READ_WRITE, no further use can be made of the state after the finisher has run.

  • Enum Constant Details

  • Method Details

    • values

      public static Aggregate.FinishEffect[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Aggregate.FinishEffect valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null