Class BatchQuery

java.lang.Object
org.apache.cayenne.query.BatchQuery
All Implemented Interfaces:
Serializable, Query
Direct Known Subclasses:
DeleteBatchQuery, InsertBatchQuery, UpdateBatchQuery

public abstract class BatchQuery
extends Object
implements Query
BatchQuery and its descendants allow to group similar data for the batch database modifications, including inserts, updates and deletes. Single BatchQuery corresponds to a parameterized PreparedStatement and a matrix of values.
See Also:
Serialized Form
  • Field Details

  • Constructor Details

    • BatchQuery

      public BatchQuery​(DbEntity dbEntity, List<DbAttribute> dbAttributes, int batchCapacity)
      Since:
      4.0
  • Method Details

    • getRows

      public List<BatchQueryRow> getRows()
      Since:
      4.0
    • getMetaData

      public QueryMetadata getMetaData​(EntityResolver resolver)
      Returns default select parameters.
      Specified by:
      getMetaData in interface Query
      Since:
      1.2
    • route

      public void route​(QueryRouter router, EntityResolver resolver, Query substitutedQuery)
      Description copied from interface: Query
      A callback method invoked by Cayenne during the routing phase of the query execution. Mapping of DataNodes is provided by QueryRouter. Query should use a QueryRouter.route(QueryEngine, Query, Query) callback method to route itself. Query can create one or more substitute queries or even provide its own QueryEngine to execute itself.
      Specified by:
      route in interface Query
      Since:
      1.2
    • createSQLAction

      public SQLAction createSQLAction​(SQLActionVisitor visitor)
      Calls "batchAction" on the visitor.
      Specified by:
      createSQLAction in interface Query
      Since:
      1.2
    • isUsingOptimisticLocking

      public boolean isUsingOptimisticLocking()
      Returns true if the batch query uses optimistic locking.
      Since:
      1.1
    • getDbEntity

      public DbEntity getDbEntity()
      Returns a DbEntity associated with this batch.
    • getDbAttributes

      public List<DbAttribute> getDbAttributes()
      Returns a list of DbAttributes describing batch parameters.