Module org.neo4j.cypherdsl.core
Package org.neo4j.cypherdsl.core

Interface StatementBuilder.BuildableStatement<T extends Statement>

Type Parameters:
T - the type of the statement that is returned
All Known Subinterfaces:
ExposesSubqueryCall.BuildableSubquery, StatementBuilder.BuildableMatchAndUpdate, StatementBuilder.BuildableOngoingMergeAction, StatementBuilder.OngoingMatchAndReturnWithOrder, StatementBuilder.OngoingMerge, StatementBuilder.OngoingReadingAndReturn, StatementBuilder.OngoingStandaloneCallWithArguments, StatementBuilder.OngoingStandaloneCallWithoutArguments, StatementBuilder.OngoingStandaloneCallWithReturnFields, StatementBuilder.OngoingUpdate, StatementBuilder.TerminalExposesLimit, StatementBuilder.TerminalOngoingOrderDefinition
Enclosing interface:
StatementBuilder
public static interface StatementBuilder.BuildableStatement<T extends Statement>
A statement that has all information required to be build and exposes a build method.
Since:
1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    build()
     
    default @NotNull Statement
    explain()
     
    default @NotNull Statement
    profile()
     

  • Method Details

    • build

      @NotNull @Contract(pure=true) T build()
      Returns:
      The statement ready to be used, i.e. in a renderer.

    • explain

      @NotNull @Contract(pure=true) default @NotNull Statement explain()
      Returns:
      Creates a statement that returns an explain plan for the original statement.
      Since:
      2020.1.2

    • profile

      @NotNull @Contract(pure=true) default @NotNull Statement profile()
      Returns:
      Creates a profiled statement that includes both the result and the actually executed and profiled plan.
      Since:
      2020.1.2