com.hazelcast.sql

Interface SqlResult

All Superinterfaces:

AutoCloseable, Iterable<SqlRow>

public interface SqlResult
extends Iterable<SqlRow>, AutoCloseable

SQL query result. Depending on the statement type it represents a stream of rows or an update count.

Usage for a stream of rows

1. Use iterator() to iterate over the rows.
2. Use close() to release the resources associated with the result.

Code example:

 try (SqlResult result = hazelcastInstance.getSql().execute("SELECT ...")) {
     for (SqlRow row : result) {
         // Process the row.
     }
 }
 

Usage for update count

     long updated = hazelcastInstance.getSql().execute("UPDATE ...").updateCount();
 

You don't need to call close() in this case.

Method Summary

Modifier and Type	Method and Description
void	close() Release the resources associated with the query result.
SqlRowMetadata	getRowMetadata() Gets row metadata.
boolean	isUpdateCount() If this result represents a row set, this method returns false.
Iterator<SqlRow>	iterator() Returns the iterator over the result rows.
long	updateCount() Returns the number of rows updated by the statement.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

isUpdateCount

boolean isUpdateCount()

If this result represents a row set, this method returns false. If this result represents an update count (such as for a DML query), it returns true.

Returns:

false for a rows result and true for an update count result

getRowMetadata

@Nonnull
SqlRowMetadata getRowMetadata()

Gets row metadata.

Returns:

row metadata

Throws:

IllegalStateException - if this result doesn't have rows (i.e. when isUpdateCount() returns true)

iterator

@Nonnull
Iterator<SqlRow> iterator()

Returns the iterator over the result rows.

The iterator may be requested only once.

Specified by:

iterator in interface Iterable<SqlRow>

Returns:

iterator

Throws:

IllegalStateException - if the method is invoked more than once or if this result doesn't have rows (i.e. when isUpdateCount() returns true)

HazelcastSqlException - in case of an SQL-related error condition

updateCount

long updateCount()

Returns the number of rows updated by the statement.

Throws:

IllegalStateException - if this result doesn't represent an update count (i.e. when isUpdateCount() returns false)

close

void close()

Release the resources associated with the query result. Must be called only if the isUpdateCount() returns false, that is when it's a result with rows, otherwise it's a no-op.

The query engine delivers the rows asynchronously. The query may become inactive even before all rows are consumed. The invocation of this command will cancel the execution of the query on all members if the query is still active. Otherwise it is no-op.

Specified by:

close in interface AutoCloseable