com.vertica.sdk.NodeSpecifyingPlanContext Class Reference

Inheritance diagram for com.vertica.sdk.NodeSpecifyingPlanContext:

Collaboration diagram for com.vertica.sdk.NodeSpecifyingPlanContext:

Public Member Functions
	NodeSpecifyingPlanContext (ParamWriter writer, ArrayList< String > clusterNodes, boolean canApportionSource)
	NodeSpecifyingPlanContext (ParamWriter writer, ArrayList< String > clusterNodes, ArrayList< String > targetNodes, boolean canApportionSource)
boolean	canApportionSource ()
ArrayList< String >	getClusterNodes ()
ParamReader	getReader ()
ArrayList< String >	getTargetNodes ()
ParamWriter	getWriter ()
void	setTargetNodes (ArrayList< String > nodes) throws UdfException

Detailed Description

Interface that allows storage of query-plan state, when different parts of query planning take place on different computers. For example, if some work is done on the query initiator node and some is done on each node executing the query.

In addition to the functionality provided by PlanContext, NodeSpecifyingPlanContext allows you to specify which nodes the query should run on. This is used for UDLs.

Member Function Documentation

getClusterNodes()

ArrayList<String> com.vertica.sdk.PlanContext.getClusterNodes ( )

inherited

Returns

A list of all of the nodes in the current cluster, by node name

Referenced by com.vertica.sdk.NodeSpecifyingPlanContext.setTargetNodes().

getReader()

ParamReader com.vertica.sdk.PlanContext.getReader ( )

inherited

Returns

A read-only instance of the current context

getTargetNodes()

ArrayList<String> com.vertica.sdk.NodeSpecifyingPlanContext.getTargetNodes

(

)

Returns

The set of nodes that this query is currently set to run on

getWriter()

ParamWriter com.vertica.sdk.PlanContext.getWriter ( )

inherited

Returns

The current context for writing

setTargetNodes()

void com.vertica.sdk.NodeSpecifyingPlanContext.setTargetNodes

(

ArrayList< String >

nodes

)

throws UdfException

Change the set of nodes that the query is intended to run on.

Parameters

nodes

new target nodes

Exceptions

UdfException

if any of the specified node names is not actually the name of any node in the cluster.