Class AbstractInsertEngine

java.lang.Object
org.litebridge.orm.engine.AbstractInsertEngine
Direct Known Subclasses:
InsertEngine, MergeEngine

public abstract non-sealed class AbstractInsertEngine extends Object
Provides common functionality for creating update metadata.
  • Field Details

    • EMPTY_UPDATE_META_DATA

      protected static final UpdateMetaData EMPTY_UPDATE_META_DATA
      Default empty update metadata instance.
  • Constructor Details

    • AbstractInsertEngine

      public AbstractInsertEngine()
  • Method Details

    • createUpdateMetaData

      public static @Nullable UpdateMetaData createUpdateMetaData(PreparedOperation preparedOperation, Supplier<Table> tableSupplier, LitebridgeContext litebridgeContext)
      Creates an instance of UpdateMetaData based on the provided operation details, table supplier, and context.

      This method focuses on handling insert operations and determines whether generated keys should be included in the metadata.

      Parameters:
      preparedOperation - the prepared database operation containing the structured operation and associated bind values
      tableSupplier - a supplier that provides the current Table instance
      litebridgeContext - the context containing metadata cache and database-related utilities
      Returns:
      an UpdateMetaData instance with the details of the update operation, or null if the provided operation is not an insert
    • getGeneratedPrimaryKeyColumns

      protected static List<ColumnMetaData> getGeneratedPrimaryKeyColumns(TableMetaData tableMetaData)
      Get the primary key columns for which the database generates values.
      Parameters:
      tableMetaData - the TableMetaData object containing the metadata of the target table
      Returns:
      a list of ColumnMetaData objects representing the generated primary key columns
    • operationTypeName

      protected abstract String operationTypeName()
      Returns the engine's operation type name, for logging.
      Returns:
      The name of the engine's operation type.
    • logger

      protected abstract org.slf4j.Logger logger()
      Returns the logger for the engine.
      Returns:
      the engine's logger instance
    • execute

      protected final UpdateResult execute(QueryNode node, LitebridgeContext litebridgeContext)
      Executes a given query node within the provided Litebridge context and returns the result of the operation.
      Parameters:
      node - The query node representing a step in the query chain to be executed.
      litebridgeContext - Context for the statement execution.
      Returns:
      The result of executing the query node, represented as an instance of UpdateResult, which includes information such as the number of rows affected by the operation.
      Throws:
      IllegalStateException - If an error occurs during query execution, such as issues with the database or query compilation.
    • execute

      protected final <T extends Result> T execute(QueryNode node, Function<PreparedOperation,@Nullable UpdateMetaData> updateMetaDataCreator, Class<T> resultType, LitebridgeContext litebridgeContext)
      Executes a given query node, either by using a cached prepared SQL statement or by compiling and executing it if no cache exists.

      The result is returned as an instance of the specified result type.

      Type Parameters:
      T - The type of the result extending UpdateOpResult.
      Parameters:
      node - The query node to be executed.
      updateMetaDataCreator - A function to create update metadata for the operation.
      resultType - The class type of the result to return; must extend UpdateOpResult.
      litebridgeContext - Context for the statement execution.
      Returns:
      The result of executing the query node, represented as an instance of the specified result type. This result contains information about the outcome of the operation, such as the number of rows affected.
      Throws:
      IllegalStateException - If an error occurs during SQL execution, including database or query issues.
    • compileAndExecute

      protected final <T extends Result> T compileAndExecute(int astCacheKey, QueryNode node, Function<PreparedOperation,@Nullable UpdateMetaData> updateMetaDataCreator, Class<T> resultType, LitebridgeContext litebridgeContext)
      Compiles and executes the provided query node against the database.
      Type Parameters:
      T - The type of the result.
      Parameters:
      astCacheKey - The cache key for the AST.
      node - The query node to be compiled and executed.
      updateMetaDataCreator - A function to create update metadata.
      resultType - The result type to return.
      litebridgeContext - The context for the statement execution.
      Returns:
      The result of the database operation, which is an instance of the specified result type.
      Throws:
      IllegalStateException - If the execution of the SQL statement fails, including database or query issues.
    • execute

      protected final <T extends Result> T execute(PreparedSql preparedSql, Class<T> resultType, LitebridgeContext litebridgeContext)
      Executes the provided prepared SQL statement against the database and returns the result of the operation.
      Type Parameters:
      T - The type of the result.
      Parameters:
      preparedSql - The prepared SQL statement containing the SQL query and its bind parameters.
      resultType - The result type to return.
      litebridgeContext - Context for the statement execution.
      Returns:
      The result of the database operation, which is an instance of the specified result type.
      Throws:
      IllegalStateException - If the execution of the SQL statement fails, including database or query issues.