com.softwareag.eda.estore.query.api

Interface Query

All Superinterfaces:

java.lang.AutoCloseable

public interface Query
extends java.lang.AutoCloseable

Method Summary

Modifier and Type	Method and Description
void	close() Close the session and free any and all associated resources
ResultStream	execute() Executes the query and returns the result stream to the caller.
byte[]	explain() Returns a buffer containing information about the current query.

Method Detail

execute

ResultStream execute()
              throws QueryException

Executes the query and returns the result stream to the caller.

Returns:

A ResultStream containing the results of the query.

Throws:

QueryException - on error.

explain

byte[] explain()
        throws QueryException

Returns a buffer containing information about the current query. This information consists of the current query string in the Common Query Syntax and the query after transformation to the underlying storage technology. This information can then be used to debug issues found in one or more queries.

Returns:

A buffer containing the query information.

Throws:

QueryException - if the information can't be provided.

close

void close()
    throws QueryException

Close the session and free any and all associated resources

Specified by:

close in interface java.lang.AutoCloseable

Throws:

QueryException