Package com.kuzudb

Class QueryResult

java.lang.Object

com.kuzudb.QueryResult

All Implemented Interfaces:

AutoCloseable

public class QueryResult
extends Object
implements AutoCloseable

QueryResult stores the result of a query execution.

Constructor Summary

Constructors

Constructor	Description
QueryResult()

Method Summary

Modifier and Type	Method	Description
void	close()	Close the query result and release the underlying resources.
DataType	getColumnDataType(long index)	Get the column data type at the given index.
String	getColumnName(long index)	Get the column name at the given index.
String	getErrorMessage()	Get the error message if any.
FlatTuple	getNext()	Get the next tuple.
QueryResult	getNextQueryResult()	Get the next query result.
long	getNumColumns()	Get the number of columns in the query result.
long	getNumTuples()	Get the number of tuples in the query result.
QuerySummary	getQuerySummary()	Get the query summary.
boolean	hasNext()	Return if the query result has next tuple or not.
boolean	hasNextQueryResult()	Return if the query result has next query result or not.
boolean	isOwnedByCPP()
boolean	isSuccess()	Check if the query is executed successfully.
void	resetIterator()	Reset the query result iterator.
String	toString()	Convert the query result to string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

QueryResult

public QueryResult()

Method Details

close

public void close()
           throws ObjectRefDestroyedException

Close the query result and release the underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Specified by:

close in interface AutoCloseable

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

isOwnedByCPP

public boolean isOwnedByCPP()

isSuccess

public boolean isSuccess()
                  throws ObjectRefDestroyedException

Check if the query is executed successfully.

Returns:

Query is executed successfully or not.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

getErrorMessage

public String getErrorMessage()
                       throws ObjectRefDestroyedException

Get the error message if any.

Returns:

Error message of the query execution if the query fails.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

getNumColumns

public long getNumColumns()
                   throws ObjectRefDestroyedException

Get the number of columns in the query result.

Returns:

The number of columns in the query result.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

getColumnName

public String getColumnName(long index)
                     throws ObjectRefDestroyedException

Get the column name at the given index.

Parameters:

index - : The index of the column.

Returns:

The column name at the given index.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

getColumnDataType

public DataType getColumnDataType(long index)
                           throws ObjectRefDestroyedException

Get the column data type at the given index.

Parameters:

index - : The index of the column.

Returns:

The column data type at the given index.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

getNumTuples

public long getNumTuples()
                  throws ObjectRefDestroyedException

Get the number of tuples in the query result.

Returns:

The number of tuples in the query result.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

getQuerySummary

public QuerySummary getQuerySummary()
                             throws ObjectRefDestroyedException

Get the query summary.

Returns:

The query summary.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

hasNext

public boolean hasNext()
                throws ObjectRefDestroyedException

Return if the query result has next tuple or not.

Returns:

Whether there are more tuples to read.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

getNext

public FlatTuple getNext()
                  throws ObjectRefDestroyedException

Get the next tuple.

Returns:

The next tuple.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

hasNextQueryResult

public boolean hasNextQueryResult()
                           throws ObjectRefDestroyedException

Return if the query result has next query result or not.

Returns:

Whether there are more query results to read.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

getNextQueryResult

public QueryResult getNextQueryResult()
                               throws ObjectRefDestroyedException

Get the next query result.

Returns:

The next query result.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.

toString

public String toString()

Convert the query result to string.

Overrides:

toString in class Object

Returns:

The string representation of the query result.

resetIterator

public void resetIterator()
                   throws ObjectRefDestroyedException

Reset the query result iterator.

Throws:

ObjectRefDestroyedException - If the query result has been destroyed.