Provides UDxs with access to the Vertica server.
More...
|
abstract void | vlog (String logEntry) |
|
Provides UDxs with access to the Vertica server.
Vertica passes a ServerInterface instance to the setup(), destroy(), and main processing functions of each UDx. Key methods for UDx use include log() (to write to the Vertica log), getParamReader(), setParamReader(), getSessionParamReader(), and setSessionParamReader().
long com.vertica.sdk.ServerInterface.getFunctionOid |
( |
| ) |
|
String com.vertica.sdk.ServerInterface.getLocale |
( |
| ) |
|
- Returns
- the locale of the current session.
String com.vertica.sdk.ServerInterface.getNodeName |
( |
| ) |
|
- Returns
- the node name of the current session.
ParamReader com.vertica.sdk.ServerInterface.getParamReader |
( |
| ) |
|
Returns the ParamReader that allows accessing parameter values using their names
ParamReader com.vertica.sdk.ServerInterface.getSessionParamReader |
( |
| ) |
|
Returns the SessionParamReader that allows accessing session parameter values using their names
ParamReader com.vertica.sdk.ServerInterface.getUDSessionParamReader |
( |
String |
nsp | ) |
|
Get the UDSessionParamReader for a namespace
ParamReader com.vertica.sdk.ServerInterface.getUDSessionParamReader |
( |
| ) |
|
Get the UDSessionParamReader for the default namespace
Get the UDSessionParamReaderMap
void com.vertica.sdk.ServerInterface.log |
( |
String |
format, |
|
|
Object... |
args |
|
) |
| |
Writes a message to a log file stored in the UDxLogs directory of the database's catalog directory. The SQL name of the UDx is added to the log message, along with the string [UserMessage] to mark the entry as a message added by a call to this method.
- Parameters
-
format | a printf-style format string specifying the log message format. |
void com.vertica.sdk.ServerInterface.setFunctionOid |
( |
long |
oid | ) |
|
void com.vertica.sdk.ServerInterface.setParamReader |
( |
ParamReader |
paramReader | ) |
|
Set the paramReader of this ServerInterface when delayed creation is required Used by the code when delayed creation of the parameters is needed Users should not call this function
void com.vertica.sdk.ServerInterface.setSessionParamReader |
( |
ParamReader |
sessionParamReader | ) |
|
Set the UDSessionParamReaderMap
abstract void com.vertica.sdk.ServerInterface.vlog |
( |
String |
logEntry | ) |
|
|
abstractprotected |
FileManager com.vertica.sdk.ServerInterface.fileManager |
File manager of the session context