![]() |
Java SDK Documentation
8.1
|
An ExecutorParamWriter is a ParamWriter whose scope is limited to a single executor node - it will never be serialized for transfer to a different node. As a result, any object which is allocated from a Vertica memory pool (i.e. a ServerInterface's allocator object) can have its address saved in the ExecutorParamWriter (see setPointer()), and be safely retrieved later on (see getPointer()) from a different API call in the same query. More...
Public Member Functions | |
ExecutorParamWriter (ParamReader params) | |
void | addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName) |
void | addCol (ByteBuffer arg, int colstride, VerticaType dt) |
void | addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) |
void | addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) |
boolean | checkStringUserBlockInfo (int idx) |
boolean | checkTimeUserBlockInfo (int idx) |
void | clearParameter (String fieldName) |
boolean | containsParameter (String paramName) |
Function to see if the ParamReader has a value for the parameter. | |
boolean | getBoolean (int idx) |
Get a BOOLEAN value from the input row. More... | |
boolean | getBoolean (String paramName) throws UdfException |
ByteBuffer | getColDataAreaRef (int idx) |
ByteBuffer | getColRef (int idx) |
java.sql.Date | getDate (String paramName) throws UdfException |
java.sql.Date | getDate (int idx) |
Get a DATE value from the input row. More... | |
double | getDouble (int idx) |
Get a DOUBLE value from the input row. More... | |
double | getDouble (String paramName) throws UdfException |
int | getIndex (String paramName) throws UdfException |
long | getLong (int idx) |
Get a LONG INTEGER value from the input row. More... | |
long | getLong (String paramName) throws UdfException |
int | getNumCols () |
int | getNumRows () |
ArrayList< String > | getParamNames () |
Return all names of parameters stored in this ParamReader. | |
BaseDataOID | getProcessBlockUserInfoVectorAt (int i) |
String | getString (String paramName) throws UdfException |
String | getString (int idx) |
Get a reference to an VARCHAR/CHAR/VARBINARY/BINARY value from the input row. More... | |
int | getStringLength (String paramName) throws UdfException |
int | getStringLength (int idx) |
Get length of the String from the input row. More... | |
int | getStringLoc (int idx) |
Get 'location' of the String from the input row. More... | |
java.sql.Timestamp | getTimestamp (String paramName) throws UdfException |
java.sql.Timestamp | getTimestamp (int idx) |
Get a TIMESTAMP value from the input row. More... | |
VerticaType | getType (String paramName) throws UdfException |
Return the type of the given parameter. More... | |
SizedColumnTypes | getTypeMetaData () |
VNumeric | getVNumeric (String paramName) throws UdfException |
VNumeric | getVNumeric (int idx) |
Get a reference to a VNumeric value from the input row. More... | |
VString | getVString (String paramName) throws UdfException |
VString | getVString (int idx) |
Get a reference from the input row to an VString value, which represents a SQL VARCHAR/CHAR/VARBINARY/BINARY value. More... | |
boolean | isBooleanNull (int idx) |
Check whether a value from the input row is NULL in BOOLEAN type. More... | |
boolean | isBooleanNull (String paramName) throws UdfException |
boolean | isDateNull (String paramName) throws UdfException |
boolean | isDateNull (int idx) |
Check whether a value from the input row is NULL in DATE type. More... | |
boolean | isDoubleNull (int idx) |
Check whether a value from the input row is NULL in DOUBLE type. More... | |
boolean | isDoubleNull (String paramName) throws UdfException |
boolean | isEmpty () |
Returns true if there are no parameters. | |
boolean | isLongNull (int idx) |
Check whether a value from the input row is NULL in LONG INTERGER type. More... | |
boolean | isLongNull (String paramName) throws UdfException |
boolean | isStringNull (String paramName) throws UdfException |
boolean | isStringNull (int idx) |
Check whether a value from the input row is NULL in SQL VARCHAR/CHAR/VARBINARY/BINARY type. More... | |
boolean | isTimestampInfinite (String paramName) throws UdfException |
boolean | isTimestampInfinite (int idx) |
Check whether a TIMESTAMP value from the input row represents 'infinity'. More... | |
boolean | isTimestampInfiniteNeg (String paramName) throws UdfException |
boolean | isTimestampInfiniteNeg (int idx) |
Check whether a TIMESTAMP value from the input row represents '-infinity'. More... | |
boolean | isTimestampInfinitePos (String paramName) throws UdfException |
boolean | isTimestampInfinitePos (int idx) |
Check whether a TIMESTAMP value from the input row represents '+infinity'. More... | |
boolean | isTimestampNull (String paramName) throws UdfException |
boolean | isTimestampNull (int idx) |
Check whether a value from the input row is NULL in TIMESTAMP type. More... | |
boolean | next () throws UdfException, DestroyInvocation |
void | resetBuffers () |
void | setBool (String fieldName, boolean r) throws UdfException |
Adds a BOOLEAN value to the output row. More... | |
void | setDate (String fieldName, java.sql.Date r) throws UdfException |
Adds a DATE value to the output row. More... | |
void | setDouble (String fieldName, double r) throws UdfException |
Adds a FLOAT value to the output row. More... | |
void | setLong (String fieldName, Long r) throws UdfException |
Adds a LONG INTEGER value to the output row. More... | |
void | setLongString (String fieldName, String r) throws UdfException |
Adds a Long String value to the output row. More... | |
void | setNumeric (String fieldName, BigDecimal bd) |
Allocate a new VNumeric object to use as output. More... | |
void | setObjects (Map< String, Object > objects) |
void | setString (String fieldName, String r) throws UdfException |
Adds a String value to the output row. More... | |
void | setTimestamp (String fieldName, java.sql.Timestamp r) throws UdfException |
Adds a TIMESTAMP value to the output row. More... | |
void | setTimestampInfiniteNeg (String fieldName) throws UdfException |
void | setTimestampInfinitePos (String fieldName) throws UdfException |
Map< String, Object > | viewObjects () |
Public Attributes | |
int | count |
int | index |
int | ncols |
int | nrows |
HashMap< String, Integer > | paramNameToIndex |
SizedColumnTypes | typeMetaData |
Protected Member Functions | |
void | clear () |
ByteBuffer | getInlineColBuffer (int idx) |
Protected Attributes | |
ArrayList< ByteBuffer > | coldataareas |
ArrayList< ByteBuffer > | cols |
ArrayList< Integer > | colstrides |
ArrayList< Integer > | currentPos |
An ExecutorParamWriter is a ParamWriter whose scope is limited to a single executor node - it will never be serialized for transfer to a different node. As a result, any object which is allocated from a Vertica memory pool (i.e. a ServerInterface's allocator object) can have its address saved in the ExecutorParamWriter (see setPointer()), and be safely retrieved later on (see getPointer()) from a different API call in the same query.
|
inherited |
Add the location for reading a particular argument.
arg | The base location to find data. |
colstride | The stride between data instances. |
dt | The type of input. |
colName | Name of the column |
Referenced by com.vertica.sdk.VerticaBlock.addCol().
|
inherited |
Add the location for reading a particular argument.
arg | The base location to find data. |
colstride | The stride between data instances. |
dt | The type of input. |
|
inherited |
Add the location for reading a particular argument.
arg | The base location to find data. |
da | The location to find out of band string data. |
colstride | The stride between data instances. |
dt | The type of input. |
|
inherited |
Add the location for reading a particular argument.
arg | The base location to find data. |
da | The location to find out of band string data. |
colstride | The stride between data instances. |
dt | The type of input. |
colName | Name of the column |
|
inherited |
Get a BOOLEAN value from the input row.
idx | The column number to retrieve from the input row. |
|
inherited |
Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument
idx |
Referenced by com.vertica.sdk.BlockReader.getVString().
|
inherited |
Example:
Referenced by com.vertica.sdk.PartitionWriter.copyFromInput(), com.vertica.sdk.BlockReader.getBoolean(), com.vertica.sdk.BlockReader.getDouble(), com.vertica.sdk.VerticaBlock.getInlineColBuffer(), com.vertica.sdk.BlockReader.getLong(), com.vertica.sdk.BlockReader.getStringLength(), com.vertica.sdk.BlockReader.getStringLoc(), com.vertica.sdk.BlockReader.getVNumeric(), com.vertica.sdk.BlockReader.getVString(), com.vertica.sdk.BlockWriter.getVStringWriter(), com.vertica.sdk.BlockReader.isBooleanNull(), com.vertica.sdk.ParamWriter.setBool(), com.vertica.sdk.BlockWriter.setBoolean(), com.vertica.sdk.BlockWriter.setBooleanNull(), com.vertica.sdk.PartitionWriter.setBooleanValue(), com.vertica.sdk.BlockWriter.setDate(), com.vertica.sdk.BlockWriter.setDateNull(), com.vertica.sdk.PartitionWriter.setDateValue(), com.vertica.sdk.BlockWriter.setDouble(), com.vertica.sdk.ParamWriter.setDouble(), com.vertica.sdk.BlockWriter.setDoubleNull(), com.vertica.sdk.PartitionWriter.setDoubleValue(), com.vertica.sdk.BlockWriter.setLongNull(), com.vertica.sdk.ParamWriter.setLongString(), com.vertica.sdk.PartitionWriter.setLongValue(), com.vertica.sdk.ParamWriter.setNumeric(), com.vertica.sdk.BlockWriter.setNumeric(), com.vertica.sdk.ParamWriter.setString(), com.vertica.sdk.BlockWriter.setString(), com.vertica.sdk.BlockWriter.setStringNull(), com.vertica.sdk.BlockWriter.setTimestamp(), com.vertica.sdk.BlockWriter.setTimestampInfiniteNeg(), com.vertica.sdk.BlockWriter.setTimestampInfinitePos(), com.vertica.sdk.BlockWriter.setTimestampNull(), and com.vertica.sdk.PartitionWriter.setTimestampValue().
|
inherited |
Get a DATE value from the input row.
idx | The column number to retrieve from the input row. |
|
inherited |
Get a DOUBLE value from the input row.
idx | The column number to retrieve from the input row. |
|
protectedinherited |
Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.
Referenced by com.vertica.sdk.PartitionWriter.setStringBytes(), and com.vertica.sdk.PartitionWriter.setStringValue().
|
inherited |
Get a LONG INTEGER value from the input row.
idx | The column number to retrieve from the input row. |
Example:
Referenced by com.vertica.sdk.BlockReader.getDate(), com.vertica.sdk.BlockReader.getTimestamp(), com.vertica.sdk.BlockReader.isDoubleNull(), com.vertica.sdk.BlockReader.isLongNull(), com.vertica.sdk.BlockReader.isTimestampInfiniteNeg(), and com.vertica.sdk.BlockReader.isTimestampInfinitePos().
|
inherited |
|
inherited |
|
inherited |
Get a reference to an VARCHAR/CHAR/VARBINARY/BINARY value from the input row.
idx | The column number to retrieve from the input row. |
|
inherited |
Get length of the String from the input row.
idx | The column number to retrieve from the input row. |
Referenced by com.vertica.sdk.BlockReader.getVString(), and com.vertica.sdk.BlockReader.isStringNull().
|
inherited |
Get 'location' of the String from the input row.
idx | The column number to retrieve from the input row. |
Referenced by com.vertica.sdk.BlockReader.getVString().
|
inherited |
Get a TIMESTAMP value from the input row.
idx | The column number to retrieve from the input row. |
|
inherited |
Return the type of the given parameter.
UdfException |
|
inherited |
Referenced by com.vertica.sdk.ParamReader.getType(), com.vertica.sdk.PartitionWriter.setRowFromMap(), and com.vertica.sdk.PartitionWriter.setValue().
|
inherited |
Get a reference to a VNumeric value from the input row.
idx | The column number to retrieve from the input row. |
|
inherited |
Get a reference from the input row to an VString value, which represents a SQL VARCHAR/CHAR/VARBINARY/BINARY value.
idx | The column number to retrieve from the input row. |
Referenced by com.vertica.sdk.BlockReader.getString().
|
inherited |
Check whether a value from the input row is NULL in BOOLEAN type.
idx | The column number to retrieve from the input row. |
|
inherited |
Check whether a value from the input row is NULL in DATE type.
idx | The column number to retrieve from the input row. |
Referenced by com.vertica.sdk.BlockReader.getDate().
|
inherited |
Check whether a value from the input row is NULL in DOUBLE type.
idx | The column number to retrieve from the input row. |
|
inherited |
Check whether a value from the input row is NULL in LONG INTERGER type.
idx | The column number to retrieve from the input row. |
Referenced by com.vertica.sdk.BlockReader.isDateNull(), and com.vertica.sdk.BlockReader.isTimestampNull().
|
inherited |
Check whether a value from the input row is NULL in SQL VARCHAR/CHAR/VARBINARY/BINARY type.
idx | The column number to retrieve from the input row. |
Referenced by com.vertica.sdk.BlockReader.getString().
|
inherited |
Check whether a TIMESTAMP value from the input row represents 'infinity'.
idx | The column number to retrieve from the input row. |
Referenced by com.vertica.sdk.BlockReader.getTimestamp().
|
inherited |
Check whether a TIMESTAMP value from the input row represents '-infinity'.
idx | The column number to retrieve from the input row. |
Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().
|
inherited |
Check whether a TIMESTAMP value from the input row represents '+infinity'.
idx | The column number to retrieve from the input row. |
Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().
|
inherited |
Check whether a value from the input row is NULL in TIMESTAMP type.
idx | The column number to retrieve from the input row. |
Referenced by com.vertica.sdk.BlockReader.getTimestamp().
|
inherited |
Advance to the next record.
|
inherited |
Adds a BOOLEAN value to the output row.
r | The BOOLEAN value to insert into the output row. |
|
inherited |
Adds a DATE value to the output row.
r | The DATE value to insert into the output row. |
|
inherited |
Adds a FLOAT value to the output row.
r | The FLOAT value to insert into the output row. |
|
inherited |
Adds a LONG INTEGER value to the output row.
Setter methods
r | The LONG INTEGER value to insert into the output row. |
Referenced by com.vertica.sdk.ParamWriter.setDate(), and com.vertica.sdk.ParamWriter.setTimestamp().
|
inherited |
Adds a Long String value to the output row.
r | The Long String value to insert into the output row. |
|
inherited |
|
inherited |
Adds a String value to the output row.
r | The String value to insert into the output row. |
|
inherited |
Adds a TIMESTAMP value to the output row.
r | The TIMESTAMP value to insert into the output row. |