Interface SQLBuildStep

All Known Subinterfaces:
SQLDeleteStep, SQLDeleteWhereStep, SQLInsertSetStep, SQLInsertValuesStep, SQLSelectBuildStep, SQLSelectFromStep, SQLSelectGroupByStep, SQLSelectHavingStep, SQLSelectJoinedStep, SQLSelectOrderByStep, SQLSelectSourceStep, SQLSelectWhereStep, SQLUpdateSetStep, SQLUpdateWhereStep

public interface SQLBuildStep
A fluent stage that has enough information to produce a reusable immutable definition.
Since:
4.15
Author:
Eike Stepper
No Implement
This interface is not intended to be implemented by clients.
No Extend
This interface is not intended to be extended by clients.
  • Method Summary

    Modifier and Type
    Method
    Description
    Captures the operations completed so far in a new immutable template.
    default SQLStatement
    Compiles this complete definition for an adapter, rendering adapter-specific identifier quoting and recording parameter occurrences in generated SQL order.
  • Method Details

    • build

      SQLTemplate build()
      Captures the operations completed so far in a new immutable template. Later calls through a retained builder stage do not alter an already built template.
      Returns:
      an immutable definition snapshot
      Since:
      4.15
    • compile

      default SQLStatement compile(IDBAdapter adapter)
      Compiles this complete definition for an adapter, rendering adapter-specific identifier quoting and recording parameter occurrences in generated SQL order. The returned statement can be prepared through an IDBConnection and bound through its positional or parameter-identity methods.
      Parameters:
      adapter - the database adapter for identifier quoting and NULL type mapping
      Returns:
      the compiled statement