Class UpdateEngine

java.lang.Object
org.litebridge.orm.engine.UpdateEngine

public final class UpdateEngine extends Object
Engine for processing UPDATE statements.
  • Field Details

    • EMPTY_UPDATE_META_DATA

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

    • UpdateEngine

      public UpdateEngine()
  • Method Details

    • update

      public <DTO> UpdateOpResult update(Class<DTO> dtoClass, Function<DtoUpdateStart<DTO>,UpdateQuery> update, LitebridgeContext litebridgeContext)
      Executes a SQL UPDATE statement targeting a mapped DTO/entity class.
      Type Parameters:
      DTO - the mapped DTO/entity type
      Parameters:
      dtoClass - the mapped DTO/entity type to update
      update - update logic; a function that takes a DtoUpdateStart and returns a UpdateQuery
      litebridgeContext - Litebridge context
      Returns:
      the result of the update operation
    • update

      public UpdateOpResult update(String tableName, Function<SqlUpdateStart,UpdateQuery> update, LitebridgeContext litebridgeContext)
      Executes a SQL UPDATE statement targeting a specific table.
      Parameters:
      tableName - the name of the table to update
      update - update logic; a function that takes a SqlUpdateStart and returns a UpdateQuery
      litebridgeContext - Litebridge context
      Returns:
      the result of the update operation
    • createUpdateNodeChain

      public static <DTO> QueryNode createUpdateNodeChain(Class<DTO> dtoClass, Function<DtoUpdateStart<DTO>,UpdateQuery> update, LitebridgeContext litebridgeContext)
      Creates a chain of update nodes for the specified mapped DTO/entity type and update logic.
      Type Parameters:
      DTO - the mapped DTO/entity type
      Parameters:
      dtoClass - the mapped DTO/entity type to update
      update - update logic; a function defining the update operation, which consumes a DtoUpdateStart instance and returns an UpdateQuery
      litebridgeContext - Litebridge context
      Returns:
      the terminal QueryNode of the constructed update query chain
    • createUpdateNodeChain

      public static QueryNode createUpdateNodeChain(String tableName, Function<SqlUpdateStart,UpdateQuery> update, LitebridgeContext litebridgeContext)
      Creates a chain of update nodes for the specified table name and update logic.
      Parameters:
      tableName - the name of the database table to update
      update - update logic; a function defining the update operation, which consumes a SqlUpdateStart instance and returns an UpdateQuery
      litebridgeContext - Litebridge context
      Returns:
      the terminal QueryNode of the constructed update query chain
    • operationTypeName

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

      protected 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.