Class DefaultRelationalQuery

java.lang.Object
io.ebeaninternal.server.querydefn.AbstractQuery
io.ebeaninternal.server.querydefn.DefaultRelationalQuery
All Implemented Interfaces:
io.ebean.CancelableQuery, io.ebean.SqlQuery, SpiCancelableQuery, SpiSqlBinding, SpiSqlQuery, Serializable
@NullMarked public final class DefaultRelationalQuery extends AbstractQuery implements SpiSqlQuery
Default implementation of SQuery - SQL Query.
See Also:

  • Constructor Details

    • DefaultRelationalQuery

      public DefaultRelationalQuery(SpiEbeanServer server, String query)
      Additional supply a query detail object.

  • Method Details

    • transaction

      public SpiTransaction transaction()
      Description copied from interface: SpiSqlBinding
      Return the transaction explicitly associated to the query.
      Specified by:
      transaction in interface SpiSqlBinding

    • usingTransaction

      public io.ebean.SqlQuery usingTransaction(io.ebean.Transaction transaction)
      Specified by:
      usingTransaction in interface io.ebean.SqlQuery

    • usingConnection

      public io.ebean.SqlQuery usingConnection(Connection connection)
      Specified by:
      usingConnection in interface io.ebean.SqlQuery

    • usingMaster

      public io.ebean.SqlQuery usingMaster(boolean useMaster)
      Specified by:
      usingMaster in interface io.ebean.SqlQuery

    • isUseMaster

      public boolean isUseMaster()
      Description copied from interface: SpiSqlBinding
      Return true if this query should not use the read only data source.
      Specified by:
      isUseMaster in interface SpiSqlBinding

    • findEach

      public void findEach(Consumer<io.ebean.SqlRow> consumer)
      Specified by:
      findEach in interface io.ebean.SqlQuery

    • findEachWhile

      public void findEachWhile(Predicate<io.ebean.SqlRow> consumer)
      Specified by:
      findEachWhile in interface io.ebean.SqlQuery

    • findList

      public List<io.ebean.SqlRow> findList()
      Specified by:
      findList in interface io.ebean.SqlQuery

    • findEachRow

      public void findEachRow(io.ebean.RowConsumer consumer)
      Specified by:
      findEachRow in interface io.ebean.SqlQuery

    • findOne

      public io.ebean.SqlRow findOne()
      Specified by:
      findOne in interface io.ebean.SqlQuery

    • findOneOrEmpty

      public Optional<io.ebean.SqlRow> findOneOrEmpty()
      Specified by:
      findOneOrEmpty in interface io.ebean.SqlQuery

    • setParameters

      public DefaultRelationalQuery setParameters(Object... values)
      Specified by:
      setParameters in interface io.ebean.SqlQuery

    • setParameter

      public DefaultRelationalQuery setParameter(Object value)
      Specified by:
      setParameter in interface io.ebean.SqlQuery

    • setNullParameter

      public io.ebean.SqlQuery setNullParameter(int position, int jdbcType)
      Specified by:
      setNullParameter in interface io.ebean.SqlQuery

    • setNullParameter

      public io.ebean.SqlQuery setNullParameter(String name, int jdbcType)
      Specified by:
      setNullParameter in interface io.ebean.SqlQuery

    • setParameter

      public DefaultRelationalQuery setParameter(int position, Object value)
      Specified by:
      setParameter in interface io.ebean.SqlQuery

    • setArrayParameter

      public DefaultRelationalQuery setArrayParameter(int position, Collection<?> value)
      Specified by:
      setArrayParameter in interface io.ebean.SqlQuery

    • setParameter

      public DefaultRelationalQuery setParameter(String paramName, Object value)
      Specified by:
      setParameter in interface io.ebean.SqlQuery

    • setArrayParameter

      public DefaultRelationalQuery setArrayParameter(String paramName, Collection<?> value)
      Specified by:
      setArrayParameter in interface io.ebean.SqlQuery

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getFirstRow

      public int getFirstRow()
      Description copied from interface: SpiSqlBinding
      Return the first row to fetch.
      Specified by:
      getFirstRow in interface SpiSqlBinding

    • setFirstRow

      public DefaultRelationalQuery setFirstRow(int firstRow)
      Specified by:
      setFirstRow in interface io.ebean.SqlQuery

    • getMaxRows

      public int getMaxRows()
      Description copied from interface: SpiSqlBinding
      Return the maximum number of rows to fetch.
      Specified by:
      getMaxRows in interface SpiSqlBinding

    • setMaxRows

      public DefaultRelationalQuery setMaxRows(int maxRows)
      Specified by:
      setMaxRows in interface io.ebean.SqlQuery

    • getTimeout

      public int getTimeout()
      Description copied from interface: SpiSqlBinding
      Return the query timeout.
      Specified by:
      getTimeout in interface SpiSqlBinding

    • setTimeout

      public DefaultRelationalQuery setTimeout(int secs)
      Specified by:
      setTimeout in interface io.ebean.SqlQuery

    • getLabel

      public String getLabel()
      Description copied from interface: SpiSqlBinding
      Return the label (to collect metrics on when set).
      Specified by:
      getLabel in interface SpiSqlBinding

    • setLabel

      public DefaultRelationalQuery setLabel(String label)
      Specified by:
      setLabel in interface io.ebean.SqlQuery

    • getBindParams

      public BindParams getBindParams()
      Description copied from interface: SpiSqlBinding
      Return the named or positioned parameters.
      Specified by:
      getBindParams in interface SpiSqlBinding

    • setDefaultFetchBuffer

      public final void setDefaultFetchBuffer(int fetchSize)
      Description copied from interface: SpiSqlBinding
      Set the JDBC fetchSize buffer hint if not explicitly set.
      Specified by:
      setDefaultFetchBuffer in interface SpiSqlBinding

    • setBufferFetchSizeHint

      public DefaultRelationalQuery setBufferFetchSizeHint(int bufferFetchSizeHint)
      Specified by:
      setBufferFetchSizeHint in interface io.ebean.SqlQuery

    • getBufferFetchSizeHint

      public int getBufferFetchSizeHint()
      Description copied from interface: SpiSqlBinding
      Return the hint for Statement.setFetchSize().
      Specified by:
      getBufferFetchSizeHint in interface SpiSqlBinding

    • getQuery

      public String getQuery()
      Description copied from interface: SpiSqlBinding
      return the query.
      Specified by:
      getQuery in interface SpiSqlBinding

    • mapToScalar

      public <T> io.ebean.SqlQuery.TypeQuery<T> mapToScalar(Class<T> attributeType)
      Specified by:
      mapToScalar in interface io.ebean.SqlQuery

    • mapTo

      public <T> io.ebean.SqlQuery.TypeQuery<T> mapTo(io.ebean.RowMapper<T> mapper)
      Specified by:
      mapTo in interface io.ebean.SqlQuery