Results (oceanbase-client 2.4.0 API)

java.lang.Object
- com.oceanbase.jdbc.internal.com.read.dao.Results

```
public class Results
extends Object
```

Constructor Summary

Constructors
Constructor and Description
`Results()` Single Text query.
`Results(OceanBaseStatement statement, int fetchSize, boolean batch, int expectedSize, boolean binaryFormat, int resultSetScrollType, int resultSetConcurrency, int autoGeneratedKeys, int autoIncrement, String sql, ParameterHolder[] parameters)` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abort()` Connection.abort() has been called, abort remaining active result-set
`void`	`addResultSet(SelectResultSet resultSet, boolean moreResultAvailable)` Add resultSet to results.
`void`	`addStats(long updateCount, long insertId, boolean moreResultAvailable)` Add execution statistics.
`void`	`addStatsError(boolean moreResultAvailable)` Indicate that result is an Error, to set appropriate results.
`void`	`close()`
`boolean`	`commandEnd()` Indicate that command / batch is finished, so set current resultSet if needed.
`int`	`getAutoGeneratedKeys()`
`boolean`	`getBatchSucceed()`
`SelectResultSet`	`getCallableResultSet()`
`CmdInformation`	`getCmdInformation()`
`int`	`getCurrentStatNumber()`
`Deque<SelectResultSet>`	`getExecutionResults()`
`int`	`getExpectedSize()`
`int`	`getFetchSize()`
`ResultSet`	`getGeneratedKeys(Protocol protocol)` Send a resultSet that contain auto generated keys.
`int`	`getMaxFieldSize()`
`boolean`	`getMoreResults(int current, Protocol protocol)` Position to next resultSet.
`ParameterHolder[]`	`getParameters()`
`SelectResultSet`	`getResultSet()`
`int`	`getResultSetConcurrency()`
`int`	`getResultSetScrollType()`
`String`	`getSql()`
`OceanBaseStatement`	`getStatement()`
`int`	`getStatementId()`
`boolean`	`isBatch()`
`boolean`	`isBinaryFormat()`
`boolean`	`isFullyLoaded(Protocol protocol)` Indicate if result contain result-set that is still streaming from server.
`boolean`	`isInternalResult()`
`boolean`	`isRewritten()`
`boolean`	`isToCursorFetch()`
`boolean`	`isToPrepareExecute()`
`void`	`loadFully(boolean skip, Protocol protocol)` Load fully current results.
`void`	`removeFetchSize()`
`void`	`setAutoIncrement(int autoIncrement)`
`void`	`setBatchSucceed(boolean succeed)`
`protected void`	`setCmdInformation(CmdInformation cmdInformation)`
`void`	`setInternalResult(boolean internalResult)`
`void`	`setParameters(ParameterHolder[] parameters)`
`void`	`setRewritten(boolean rewritten)`
`void`	`setStatementId(int statementId)`
`void`	`setToCursorFetch(boolean val)`
`void`	`setToPrepareExecute(boolean val)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Results
```
public Results()
```
    Single Text query. /! use internally, because autoincrement value is not right for multi-queries !/
  - Results
```
public Results(OceanBaseStatement statement,
               int fetchSize,
               boolean batch,
               int expectedSize,
               boolean binaryFormat,
               int resultSetScrollType,
               int resultSetConcurrency,
               int autoGeneratedKeys,
               int autoIncrement,
               String sql,
               ParameterHolder[] parameters)
```
    Default constructor.
    
    Parameters:
    
    statement - current statement
    
    fetchSize - fetch size
    
    batch - select result possible
    
    expectedSize - expected size
    
    binaryFormat - use binary protocol
    
    resultSetScrollType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
    
    resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
    
    autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS
    
    autoIncrement - Connection auto-increment value
    
    sql - sql command
    
    parameters - parameters
- Method Detail
  - addStats
```
public void addStats(long updateCount,
                     long insertId,
                     boolean moreResultAvailable)
```
    Add execution statistics.
    
    Parameters:
    
    updateCount - number of updated rows
    
    insertId - primary key
    
    moreResultAvailable - is there additional packet
  - addStatsError
```
public void addStatsError(boolean moreResultAvailable)
```
    Indicate that result is an Error, to set appropriate results.
    
    Parameters:
    
    moreResultAvailable - indicate if other results (ResultSet or updateCount) are available.
  - getCurrentStatNumber
```
public int getCurrentStatNumber()
```
  - addResultSet
```
public void addResultSet(SelectResultSet resultSet,
                         boolean moreResultAvailable)
```
    Add resultSet to results.
    
    Parameters:
    
    resultSet - new resultSet.
    
    moreResultAvailable - indicate if other results (ResultSet or updateCount) are available.
  - isToCursorFetch
```
public boolean isToCursorFetch()
```
  - setToCursorFetch
```
public void setToCursorFetch(boolean val)
```
  - isToPrepareExecute
```
public boolean isToPrepareExecute()
```
  - setToPrepareExecute
```
public void setToPrepareExecute(boolean val)
```
  - isInternalResult
```
public boolean isInternalResult()
```
  - setInternalResult
```
public void setInternalResult(boolean internalResult)
```
  - getCmdInformation
```
public CmdInformation getCmdInformation()
```
  - setCmdInformation
```
protected void setCmdInformation(CmdInformation cmdInformation)
```
  - commandEnd
```
public boolean commandEnd()
```
    Indicate that command / batch is finished, so set current resultSet if needed.
    
    Returns:
    
    true id has cmdInformation
  - getResultSet
```
public SelectResultSet getResultSet()
```
  - getCallableResultSet
```
public SelectResultSet getCallableResultSet()
```
  - loadFully
```
public void loadFully(boolean skip,
                      Protocol protocol)
               throws SQLException
```
    Load fully current results.
    Lock must be set before using this method
    
    Parameters:
    
    skip - must result be available afterwhile
    
    protocol - current protocol
    
    Throws:
    
    SQLException - if any connection error occur
  - abort
```
public void abort()
           throws SQLException
```
    Connection.abort() has been called, abort remaining active result-set
    
    Throws:
    
    SQLException - exception
  - isFullyLoaded
```
public boolean isFullyLoaded(Protocol protocol)
```
    Indicate if result contain result-set that is still streaming from server.
    
    Parameters:
    
    protocol - current protocol
    
    Returns:
    
    true if streaming is finished
  - getMoreResults
```
public boolean getMoreResults(int current,
                              Protocol protocol)
                       throws SQLException
```
    Position to next resultSet.
    
    Parameters:
    
    current - one of the following Statement constants indicating what should happen to current ResultSet objects obtained using the method getResultSet: Statement.CLOSE_CURRENT_RESULT, Statement.KEEP_CURRENT_RESULT, or Statement.CLOSE_ALL_RESULTS
    
    protocol - current protocol
    
    Returns:
    
    true if other resultSet exists.
    
    Throws:
    
    SQLException - if any connection error occur.
  - getFetchSize
```
public int getFetchSize()
```
  - getStatement
```
public OceanBaseStatement getStatement()
```
  - isBatch
```
public boolean isBatch()
```
  - getExpectedSize
```
public int getExpectedSize()
```
  - isBinaryFormat
```
public boolean isBinaryFormat()
```
  - removeFetchSize
```
public void removeFetchSize()
```
  - getResultSetScrollType
```
public int getResultSetScrollType()
```
  - getSql
```
public String getSql()
```
  - getParameters
```
public ParameterHolder[] getParameters()
```
  - getGeneratedKeys
```
public ResultSet getGeneratedKeys(Protocol protocol)
                           throws SQLException
```
    Send a resultSet that contain auto generated keys. 2 differences :
    1. Batch will list all insert ids.
    2. in case of multi-query is set, resultSet will be per query.
    example "INSERT INTO myTable values ('a'),('b');INSERT INTO myTable values ('c'),('d'),('e')" will have a resultSet of 2 values, and when Statement.getMoreResults() will be called, a Statement.getGeneratedKeys will return a resultset with 3 ids.
    Parameters:
    
    protocol - current protocol
    
    Returns:
    
    a ResultSet containing generated ids.
    
    Throws:
    
    SQLException - if autoGeneratedKeys was not set to Statement.RETURN_GENERATED_KEYS
  - close
```
public void close()
           throws SQLException
```
    Throws:
    
    SQLException
  - getMaxFieldSize
```
public int getMaxFieldSize()
```
  - setAutoIncrement
```
public void setAutoIncrement(int autoIncrement)
```
  - getResultSetConcurrency
```
public int getResultSetConcurrency()
```
  - getAutoGeneratedKeys
```
public int getAutoGeneratedKeys()
```
  - isRewritten
```
public boolean isRewritten()
```
  - setRewritten
```
public void setRewritten(boolean rewritten)
```
  - setStatementId
```
public void setStatementId(int statementId)
```
  - getStatementId
```
public int getStatementId()
```
  - setParameters
```
public void setParameters(ParameterHolder[] parameters)
```
  - getBatchSucceed
```
public boolean getBatchSucceed()
```
  - setBatchSucceed
```
public void setBatchSucceed(boolean succeed)
```
  - getExecutionResults
```
public Deque<SelectResultSet> getExecutionResults()
```

Class Results

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Results

Results

Method Detail

addStats

addStatsError

getCurrentStatNumber

addResultSet

isToCursorFetch

setToCursorFetch

isToPrepareExecute

setToPrepareExecute

isInternalResult

setInternalResult

getCmdInformation

setCmdInformation

commandEnd

getResultSet

getCallableResultSet

loadFully

abort

isFullyLoaded

getMoreResults

getFetchSize

getStatement

isBatch

getExpectedSize

isBinaryFormat

removeFetchSize

getResultSetScrollType

getSql

getParameters

getGeneratedKeys

close

getMaxFieldSize

setAutoIncrement

getResultSetConcurrency

getAutoGeneratedKeys

isRewritten

setRewritten

setStatementId

getStatementId

setParameters

getBatchSucceed

setBatchSucceed

getExecutionResults