org.postgresql.core
Interface Query

public interface Query

Abstraction of a generic Query, hiding the details of any protocol-version-specific data needed to execute the query efficiently.

Query objects should be explicitly closed when no longer needed; if resources are allocated on the server for this query, their cleanup is triggered by closing the Query.

Author:

Oliver Jowett (oliver@opencloud.com)

Method Summary

void	close() Close this query and free any server-side resources associated with it.
ParameterList	createParameterList() Create a ParameterList suitable for storing parameters associated with this Query.
String	toString(ParameterList parameters) Stringize this query to a human-readable form, substituting particular parameter values for parameter placeholders.

Method Detail

createParameterList

ParameterList createParameterList()

Create a ParameterList suitable for storing parameters associated with this Query.

If this query has no parameters, a ParameterList will be returned, but it may be a shared immutable object. If this query does have parameters, the returned ParameterList is a new list, unshared by other callers.

Returns:

a suitable ParameterList instance for this query

toString

String toString(ParameterList parameters)

Stringize this query to a human-readable form, substituting particular parameter values for parameter placeholders.

Parameters:

parameters - a ParameterList returned by this Query's createParameterList() method, or null to leave the parameter placeholders unsubstituted.

Returns:

a human-readable representation of this query

close

void close()

Close this query and free any server-side resources associated with it. The resources may not be immediately deallocated, but closing a Query may make the deallocation more prompt.

A closed Query should not be executed.