Package org.dbos.apiary.voltdb

Class VoltContext

java.lang.Object

org.dbos.apiary.function.ApiaryContext

org.dbos.apiary.function.ApiaryTransactionalContext

org.dbos.apiary.voltdb.VoltContext

public class VoltContext
extends ApiaryTransactionalContext

VoltContext is a context for Apiary-VoltDB functions. It provides methods for accessing a VoltDB database.

Field Summary

Fields inherited from class org.dbos.apiary.function.ApiaryContext

execID, functionID, provBuff, service

Constructor Summary

Constructors

Constructor	Description
VoltContext(VoltFunction p, ProvenanceBuffer provBuff, String service, long execID, long functionID)

Method Summary

Modifier and Type	Method	Description
FunctionOutput	apiaryCallFunction(String name, Object... inputs)	Public Interface for functions.
FunctionOutput	checkPreviousExecution()	For internal use only.
org.voltdb.VoltTable[]	executeQuery(org.voltdb.SQLStmt procedure, Object... input)	Execute a database query.
void	executeUpdate(org.voltdb.SQLStmt procedure, Object... input)	Execute a database update.
void	recordExecution(FunctionOutput output)	For internal use only.

Methods inherited from class org.dbos.apiary.function.ApiaryTransactionalContext

apiaryGetTransactionId

Methods inherited from class org.dbos.apiary.function.ApiaryContext

apiaryQueueFunction, getFunctionOutput

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VoltContext

public VoltContext(VoltFunction p,
 ProvenanceBuffer provBuff,
 String service,
 long execID,
 long functionID)

Method Details

apiaryCallFunction

public FunctionOutput apiaryCallFunction(String name,
 Object... inputs)

Description copied from class: ApiaryTransactionalContext

Public Interface for functions.

Specified by:

apiaryCallFunction in class ApiaryTransactionalContext

Parameters:

name - the fully-qualified name of the invoked function.

inputs - the list of arguments provided to the invoked function.

Returns:

an FunctionOutput object that stores the output from a function.

checkPreviousExecution

public FunctionOutput checkPreviousExecution()

Description copied from class: ApiaryContext

For internal use only.

Specified by:

checkPreviousExecution in class ApiaryContext

Returns:

FunctionOutput

recordExecution

public void recordExecution(FunctionOutput output)

Description copied from class: ApiaryContext

For internal use only.

Specified by:

recordExecution in class ApiaryContext

Parameters:

output - the finalized output of a function.

executeUpdate

public void executeUpdate(org.voltdb.SQLStmt procedure,
 Object... input)

Execute a database update.

Parameters:

procedure - a SQL DML statement (e.g., INSERT, UPDATE, DELETE).

input - input parameters for the SQL statement.

executeQuery

public org.voltdb.VoltTable[] executeQuery(org.voltdb.SQLStmt procedure,
 Object... input)

Execute a database query.

Parameters:

procedure - a SQL query.

input - input parameters for the SQL statement.