Module org.tentackle.sql

Package org.tentackle.sql

Record Class ScriptRunnerResult

java.lang.Object

java.lang.Record

org.tentackle.sql.ScriptRunnerResult

Record Components:

sql - the SQL code executed

offset - the offset within the SQL script

warnings - optional warnings, empty string if none, never null

columnCount - the number of columns, if result sets were returned, 0 if count only

results - the results returned from the statement, empty if none, never null

public record ScriptRunnerResult(String sql, int offset, String warnings, int columnCount, Object[] results)
extends Record

The result of a statement executed by a ScriptRunner.

Constructor Summary

Constructors

Constructor	Description
ScriptRunnerResult(String sql, int offset, String warnings, int columnCount, Object... results)	Creates an instance of a ScriptRunnerResult record class.

Method Summary

Modifier and Type	Method	Description
int	columnCount()	Returns the value of the columnCount record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	offset()	Returns the value of the offset record component.
Object[]	results()	Returns the value of the results record component.
String	sql()	Returns the value of the sql record component.
String	toString()	Returns a string representation of this record class.
String	warnings()	Returns the value of the warnings record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ScriptRunnerResult

public ScriptRunnerResult(String sql,
 int offset,
 String warnings,
 int columnCount,
 Object... results)

Creates an instance of a ScriptRunnerResult record class.

Parameters:

sql - the value for the sql record component

offset - the value for the offset record component

warnings - the value for the warnings record component

columnCount - the value for the columnCount record component

results - the value for the results record component

Method Details

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

sql

public String sql()

Returns the value of the sql record component.

Returns:

the value of the sql record component

offset

public int offset()

Returns the value of the offset record component.

Returns:

the value of the offset record component

warnings

public String warnings()

Returns the value of the warnings record component.

Returns:

the value of the warnings record component

columnCount

public int columnCount()

Returns the value of the columnCount record component.

Returns:

the value of the columnCount record component

results

public Object[] results()

Returns the value of the results record component.

Returns:

the value of the results record component