FilterFactory

class vertica_sdk.FilterFactory

Produces vertica_sdk.UDFilter objects, which transform one raw data stream into another.

vertica_sdk.FilterFactory implementations should be stateless. Modifications to instance, class, or global variables might not be persisted.

classmethod getUDXFactoryType(cls)

Returns vertica_sdk.UDXType.LOAD_FILTER.

classmethod plan(self, serverInterface, planContext)

Execute any logic required at query plan time.

This method is run once per query on the initiator node. If it raises an exception, the query will not proceed.

serverInterface is a vertica_sdk.ServerInterface object which provides access to server functionality, including session and statement parameters.

planContext is vertica_sdk.PlanContext object, for storing and retrieving data which will be serialized and distributed to all nodes which run the query plan.

classmethod prepare(self, serverInterface, planContext)

Create a vertica_sdk.UDFilter object for execution. This method is run once per load thread on each node, prior to the start of execution.

serverInterface is a vertica_sdk.ServerInterface object which provides access to server functionality, including session and statement parameters. It contains the same parameters as the ServerInterface argument to plan() in the same query.

planContext is a vertica_sdk.PlanContext object which contains any data which was stored during a call to plan().