io.ebeaninternal.api.SpiSqlBinding Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean-core Show documentation

ebean core module

There is a newer version: 15.8.0

package io.ebeaninternal.api;

import io.avaje.lang.Nullable;

/**
 * SQL query binding (for SqlQuery and DtoQuery).
 */
public interface SpiSqlBinding extends SpiCancelableQuery {

  /**
   * Return the transaction explicitly associated to the query.
   */
  @Nullable
  SpiTransaction transaction();

  /**
   * Return true if this query should not use the read only data source.
   */
  boolean isUseMaster();

  /**
   * Return the named or positioned parameters.
   */
  BindParams getBindParams();

  /**
   * return the query.
   */
  String getQuery();

  /**
   * Return the label (to collect metrics on when set).
   */
  String getLabel();

  /**
   * Return the first row to fetch.
   */
  int getFirstRow();

  /**
   * Return the maximum number of rows to fetch.
   */
  int getMaxRows();

  /**
   * Return the query timeout.
   */
  int getTimeout();

  /**
   * Return the hint for Statement.setFetchSize().
   */
  int getBufferFetchSizeHint();

}