Index (groovy-sql 2.3.0-rc-3 API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

add(Map) - Method in DataSet
add(Map) - Method in GroovyResultSet: Adds a new row to this result set
add(Map) - Method in GroovyResultSetExtension: Adds a new row to the result set
addBatch(List) - Method in BatchingPreparedStatementWrapper
addBatch(String) - Method in BatchingStatementWrapper
ARRAY - Field in Sql
asBoolean(GroovyResultSet) - Method in SqlGroovyMethods: Coerce a GroovyResultSet to a boolean value.
asList(String, ResultSet, int, int, Closure) - Method in Sql
asSql(GString, List) - Method in Sql: Hook to allow derived classes to override sql generation from GStrings.

B

batchCount - Field in BatchingStatementWrapper
BatchingPreparedStatementWrapper - Class in groovy.sql: Class which delegates to a PreparedStatement but keeps track of a batch count size.
BatchingPreparedStatementWrapper(PreparedStatement, List, int, Logger, Sql) - Constructor in BatchingPreparedStatementWrapper
BatchingStatementWrapper - Class in groovy.sql: Class which delegates to a Statement but keeps track of a batch count size.
BatchingStatementWrapper(Statement, int, Logger) - Constructor in BatchingStatementWrapper
batchSize - Field in BatchingStatementWrapper
BIGINT - Field in Sql
BINARY - Field in Sql
BIT - Field in Sql
BLOB - Field in Sql
BOOLEAN - Field in Sql
buildSqlWithIndexedProps(String) - Method in Sql: Hook to allow derived classes to override behavior associated with the parsing and indexing of parameters from a given sql statement.

C

cacheConnection(Closure) - Method in DataSet
cacheConnection(Closure) - Method in Sql: Caches the connection used while the closure is active.
cacheStatements(Closure) - Method in Sql: Caches every created preparedStatement in Closure closure Every cached preparedStatement is closed after closure has been called.
call(GString, Closure) - Method in Sql: Performs a stored procedure call with the given parameters, calling the closure once with all result objects.
callWithRows(String, List, boolean, Closure) - Method in Sql: Base internal method for both call() and callWithRows() style of methods.
CHAR - Field in Sql
checkForNamedParams(String, List) - Method in Sql
clear() - Method in GroovyRowResult
clearBatch() - Method in BatchingStatementWrapper
CLOB - Field in Sql
close() - Method in BatchingStatementWrapper
close() - Method in DataSet
close() - Method in Sql: If this SQL object was created with a Connection then this method closes the connection.
closeResources(Connection, Statement) - Method in DataSet
closeResources(Connection) - Method in Sql: An extension point allowing the behavior of resource closing to be overridden in derived classes.
closeResources(ResultSet) - Method in Sql.AbstractQueryCommand: After performing the execute operation and making use of its return, it's necessary to free the resources allocated for the statement.
commit() - Method in DataSet
commit() - Method in Sql: If this SQL object was created with a Connection then this method commits the connection.
configure(Statement) - Method in Sql: Provides a hook for derived classes to be able to configure JDBC statements.
containsKey(Object) - Method in GroovyRowResult
containsValue(Object) - Method in GroovyRowResult
createConnection() - Method in DataSet
createConnection() - Method in Sql: An extension point allowing derived classes to change the behavior of connection creation.
createPreparedQueryCommand(String, List) - Method in Sql: Factory for the PreparedQueryCommand command pattern object allows subclass to supply implementations of the command class.
createQueryCommand(String) - Method in Sql: Factory for the QueryCommand command pattern object allows subclasses to supply implementations of the command class.
createView(Closure) - Method in DataSet

D

DATALINK - Field in Sql
DataSet - Class in groovy.sql: An enhancement of Groovy's Sql class providing support for accessing and querying databases using POGO fields and operators rather than JDBC-level API calls and RDBMS column names.
DataSet(Sql, String) - Constructor in DataSet
dataSet(Class) - Method in Sql
DATE - Field in Sql
DECIMAL - Field in Sql
DISTINCT - Field in Sql
DOUBLE - Field in Sql

E

each(int, int, Closure) - Method in DataSet: Calls the provided closure for a "page" of rows from the table represented by this DataSet.
eachRow(Closure) - Method in GroovyResultSet: Call the closure once for each row in the result set.
eachRow(Closure) - Method in GroovyResultSetExtension: Call the closure once for each row in the result set.
eachRow(GString, Closure) - Method in Sql: Performs the given SQL query calling the given Closure with each row of the result set.
entrySet() - Method in GroovyRowResult
equals(Object) - Method in GroovyRowResult
execute(GString) - Method in Sql: Executes the given SQL with embedded expressions inside.
execute() - Method in Sql.AbstractQueryCommand: Execute the command that's defined by the subclass following the Command pattern.
execute(Connection, String) - Method in Sql.AbstractStatementCommand: Execute the command that's defined by the subclass following the Command pattern.
execute(Connection, String) - Method in Sql.CreatePreparedStatementCommand
execute(Connection, String) - Method in Sql.CreateStatementCommand
executeBatch() - Method in BatchingStatementWrapper
executeInsert(GString) - Method in Sql: Executes the given SQL statement (typically an INSERT statement).
executePreparedQuery(String, List) - Method in Sql: Useful helper method which handles resource management when executing a prepared query which returns a result set.
executeQuery(String) - Method in Sql: Useful helper method which handles resource management when executing a query which returns a result set.
executeUpdate(GString) - Method in Sql: Executes the given SQL update with embedded expressions inside.
expand(Object) - Method in Sql: When using GString SQL queries, allows a variable to be expanded in the Sql string rather than representing an sql parameter.
ExpandedVariable - Interface in groovy.sql: Identifies a variable to be expanded into the sql string rather than representing a placeholder.

F

findAll(Closure) - Method in DataSet
findWhereKeyword(String) - Method in Sql: Hook to allow derived classes to override where clause sniffing.
firstRow() - Method in DataSet: Returns the first row from a DataSet's underlying table
firstRow(String, Object) - Method in Sql: Performs the given SQL query and return the first row of the result set.
FLOAT - Field in Sql

G

get(Object) - Method in GroovyRowResult
getAt(String) - Method in GroovyResultSet: Gets the value of the designated column in the current row as an Object.
getAt(int) - Method in GroovyResultSetExtension: Supports integer based subscript operators for accessing at numbered columns starting at zero.
getAt(int) - Method in GroovyRowResult: Retrieve the value of the property by its index.
getConnection() - Method in Sql: If this instance was created with a single Connection then the connection is returned.
getDataSource() - Method in Sql
getImpl(CallableStatement, int) - Method in CallResultSet
getImpl() - Method in GroovyResultSetProxy: Gets a proxy instance that can be used as GroovyResultSet.
getObject() - Method in ExpandedVariable
getOrderBy() - Method in SqlOrderByVisitor
getParameters() - Method in DataSet
getParameters(GString) - Method in Sql: Hook to allow derived classes to override behavior associated with extracting params from a GString.
getParameters() - Method in SqlWhereVisitor
getParams() - Method in SqlWithParams
getProperty(String) - Method in GroovyResultSetExtension: Gets the value of the designated column in the current row of as an Object.
getProperty(String) - Method in GroovyRowResult: Retrieve the value of the property by its name
getProperty(String) - Method in ResultSetMetaDataWrapper
getResultSet() - Method in CallResultSet
getResultSet() - Method in GroovyResultSetExtension: Gets the current result set.
getResultSetConcurrency() - Method in Sql: Gets the resultSetConcurrency for statements created using the connection.
getResultSetHoldability() - Method in Sql: Gets the resultSetHoldability for statements created using the connection.
getResultSetType() - Method in Sql: Gets the resultSetType for statements created using the connection.
getSql() - Method in DataSet
getSql() - Method in SqlWithParams
getSqlOrderByVisitor() - Method in DataSet
getSqlWhereVisitor() - Method in DataSet
getType() - Method in InParameter: The JDBC data type.
getType() - Method in OutParameter: Get the JDBC datatype for this parameter.
getUpdateCount() - Method in Sql: @return Returns the updateCount.
getUpdatedParams(List, List) - Method in Sql
getValue() - Method in InParameter: The object holding the data value.
getWhere() - Method in SqlWhereVisitor
GroovyResultSet - Interface in groovy.sql: Represents an extent of objects
GroovyResultSetExtension - Class in groovy.sql: GroovyResultSetExtension implements additional logic for ResultSet.
GroovyResultSetExtension(ResultSet) - Constructor in GroovyResultSetExtension: Creates a GroovyResultSet implementation.
GroovyResultSetProxy - Class in groovy.sql: GroovyResultSetProxy is used to create a proxy for GroovyResultSet.
GroovyResultSetProxy(GroovyResultSetExtension) - Constructor in GroovyResultSetProxy: Creates a new proxy instance with a custom extension.
GroovyRowResult - Class in groovy.sql: Represents an extent of objects.
GroovyRowResult(Map) - Constructor in GroovyRowResult

H

hashCode() - Method in GroovyRowResult
hasNext() - Method in SqlGroovyMethods.ResultSetMetaDataIterator

I

in(int, Object) - Method in Sql: Create a new InParameter
inout(InParameter) - Method in Sql: Create an inout parameter using this in parameter.
InOutParameter - Interface in groovy.sql: @author rfuller
InParameter - Interface in groovy.sql: A typed parameter to pass to a query
INTEGER - Field in Sql
invoke(Object, Method, Object) - Method in GroovyResultSetProxy: Invokes a method for the GroovyResultSet.
invokeMethod(String, Object) - Method in BatchingStatementWrapper
invokeMethod(String, Object) - Method in GroovyResultSetExtension
invokeMethod(String, Object) - Method in ResultSetMetaDataWrapper
isCacheNamedQueries() - Method in Sql: @return boolean true if caching is enabled (the default is true)
isCacheStatements() - Method in Sql: @return boolean true if cache is enabled (default is false)
isEmpty() - Method in GroovyRowResult
isEnableNamedQueries() - Method in Sql: @return boolean true if named query processing is enabled (the default is true)
isWithinBatch() - Method in Sql: Returns true if the current Sql object is currently executing a withBatch method call.
iterator(ResultSetMetaData) - Method in SqlGroovyMethods: Return an Iterator given a ResultSetMetaData.

J

JAVA_OBJECT - Field in Sql

K

keySet() - Method in GroovyRowResult

L

loadDriver(String) - Method in Sql: Attempts to load the JDBC driver on the thread, current or system class loaders
log - Field in BatchingStatementWrapper
LOG - Field in Sql: Hook to allow derived classes to access the log
LONGVARBINARY - Field in Sql
LONGVARCHAR - Field in Sql

M

N

newInstance(Map) - Method in Sql: Creates a new Sql instance given parameters in a Map.
next() - Method in GroovyResultSetExtension: Moves the cursor down one row from its current position.
next() - Method in SqlGroovyMethods.ResultSetMetaDataIterator
normalizeIndex(int) - Method in GroovyResultSetExtension: Takes a zero based index and convert it into an SQL based 1 based index.
NULL - Field in Sql
nullify(String) - Method in Sql: Hook to allow derived classes to override null handling.
NUMERIC - Field in Sql

O

OTHER - Field in Sql
out(int) - Method in Sql: Create a new OutParameter
OutParameter - Interface in groovy.sql: A parameter to be returned from a CallableStatement.

P

preCheckForNamedParams(String) - Method in Sql: @deprecated Use buildSqlWithIndexedProps(String) instead
previous() - Method in GroovyResultSetExtension: Moves the cursor to the previous row in this getResultSet() object.
processResult(int[]) - Method in BatchingStatementWrapper
put(Object, Object) - Method in GroovyRowResult
putAll(Map) - Method in GroovyRowResult
putAt(String, Object) - Method in GroovyResultSet: Updates the designated column with an Object value.
putAt(int, Object) - Method in GroovyResultSetExtension: Supports integer based subscript operators for updating the values of numbered columns starting at zero.

Q

query(GString, Closure) - Method in Sql: Performs the given SQL query, which should return a single ResultSet object.

R

REAL - Field in Sql
REF - Field in Sql
remove(Object) - Method in GroovyRowResult
remove() - Method in SqlGroovyMethods.ResultSetMetaDataIterator
reset() - Method in BatchingStatementWrapper
results - Field in BatchingStatementWrapper
resultSet(int) - Method in Sql: Create a new ResultSetOutParameter
ResultSetMetaDataWrapper - Class in groovy.sql: This class defines a wrapper for accessing a specific column in ResultSetMetaData.
ResultSetMetaDataWrapper(ResultSetMetaData, int) - Constructor in ResultSetMetaDataWrapper
ResultSetOutParameter - Interface in groovy.sql: A ResultSet out parameter.
reverse() - Method in DataSet
rollback() - Method in DataSet
rollback() - Method in Sql: If this SQL object was created with a Connection then this method rolls back the connection.
rows(int, int) - Method in DataSet: Returns a "page" of the rows from the table a DataSet represents.
rows(GString, int, int, Closure) - Method in Sql: Performs the given SQL query and return a "page" of rows from the result set.
runQuery(Connection) - Method in Sql.AbstractQueryCommand: Perform the query.
runQuery(Connection) - Method in Sql.PreparedQueryCommand
runQuery(Connection) - Method in Sql.QueryCommand

S

setCacheNamedQueries(boolean) - Method in Sql

Enables named query caching.

setCacheStatements(boolean) - Method in Sql

Enables statement caching.

setEnableNamedQueries(boolean) - Method in Sql

Enables named query support:

if enableNamedQueries is true, queries with ':propname' and '?

setInternalConnection(Connection) - Method in Sql

Stub needed for testing.

setObject(PreparedStatement, int, Object) - Method in Sql

Strategy method allowing derived classes to handle types differently such as for CLOBs etc.

setParameters(List, PreparedStatement) - Method in Sql

Hook to allow derived classes to override behavior associated with setting params for a prepared statement.

setProperty(String, Object) - Method in GroovyResultSetExtension

Updates the designated column with an Object value.

setProperty(String, Object) - Method in ResultSetMetaDataWrapper

setResultSetConcurrency(int) - Method in Sql

Sets the resultSetConcurrency for statements created using the connection.

setResultSetHoldability(int) - Method in Sql

Sets the resultSetHoldability for statements created using the connection.

setResultSetType(int) - Method in Sql

Sets the resultSetType for statements created using the connection.

size() - Method in GroovyRowResult

SMALLINT - Field in Sql

sort(Closure) - Method in DataSet

Sql - Class in groovy.sql

A facade over Java's normal JDBC APIs providing greatly simplified resource management and result set handling.

Sql.AbstractQueryCommand - Class in groovy.sql

Sql.AbstractQueryCommand(String) - Constructor in Sql.AbstractQueryCommand

Sql(Sql) - Constructor in Sql

sql - Field in Sql.AbstractQueryCommand

SqlGroovyMethods - Class in org.codehaus.groovy.runtime

This class defines all the new SQL-related groovy methods which enhance the normal JDK SQL classes when inside the Groovy environment.

SqlGroovyMethods.ResultSetMetaDataIterator(ResultSetMetaData) - Constructor in SqlGroovyMethods.ResultSetMetaDataIterator

SqlOrderByVisitor - Class in groovy.sql

@author Paul King

SqlWhereVisitor - Class in groovy.sql

@author James Strachan

SqlWithParams - Class in groovy.sql

SqlWithParams(String, List) - Constructor in SqlWithParams

statement - Field in Sql.AbstractQueryCommand

STRUCT - Field in Sql

T

TIME - Field in Sql
TIMESTAMP - Field in Sql
TINYINT - Field in Sql
tokenAsSql(Token) - Method in SqlWhereVisitor
toRowResult(ResultSet) - Method in SqlGroovyMethods: Returns a GroovyRowResult given a ResultSet.
toString() - Method in GroovyResultSetExtension
toString() - Method in GroovyRowResult
toTimestamp(Date) - Method in SqlGroovyMethods: Return a java.sql.Timestamp given a java.util.Date.

U

V

values() - Method in GroovyRowResult
VARBINARY - Field in Sql
VARCHAR - Field in Sql
visitBinaryExpression(BinaryExpression) - Method in SqlWhereVisitor
visitBooleanExpression(BooleanExpression) - Method in SqlWhereVisitor
visitConstantExpression(ConstantExpression) - Method in SqlWhereVisitor
visitPropertyExpression(PropertyExpression) - Method in SqlOrderByVisitor
visitPropertyExpression(PropertyExpression) - Method in SqlWhereVisitor
visitReturnStatement(ReturnStatement) - Method in SqlOrderByVisitor
visitReturnStatement(ReturnStatement) - Method in SqlWhereVisitor
visitVariableExpression(VariableExpression) - Method in SqlWhereVisitor

W

withBatch(int, String, Closure) - Method in Sql: Performs the closure (containing batch operations specific to an associated prepared statement) within a batch using a given batch size.
withInstance(Map, Closure) - Method in Sql: Invokes a closure passing it a new Sql instance created from the given map of arguments.
withStatement(Closure) - Method in Sql: Allows a closure to be passed in to configure the JDBC statements before they are executed.
withTransaction(Closure) - Method in DataSet
withTransaction(Closure) - Method in Sql: Performs the closure within a transaction using a cached connection.