 |
C++ SDK Documentation
9.0
|
|
C++ SDK Documentation
9.0
|
Produces and initializes UDSources to process input data sources. More...
Public Types | |
| enum | UDXType { FUNCTION, TRANSFORM, ANALYTIC, MULTI_TRANSFORM, AGGREGATE, LOAD_SOURCE, LOAD_FILTER, LOAD_PARSER, FILESYSTEM, TYPE, CURSOR_TRANSFORM } |
Protected Attributes | |
| Oid | libOid |
| std::string | sqlName |
Produces and initializes UDSources to process input data sources.
Subclassing SourceFactory is the preferred way to implement a factory corresponding to a UDSource. If you need more flexibility, implement both IterativeSourceFactory and SourceIterator. (See the documentation of IterativeSourceFactory.)
Factories should be registered using the RegisterFactory() macro, defined in Vertica.h.
|
inherited |
The type of UDX instance this factory produces
|
inlinevirtual |
Request the number of threads that the SourceFactory wants to use. This function is called on each node before prepareUDSources().
'planCtxt' contains the same parameters stored by plan(). It exposes the maximum number of allowed threads, via 'getMaxAllowedThreads()', and also the actual number of threads, via 'getLoadConcurrency()'.
The default implementation of this invokes prepare(), saves the result in the ExecutorPlanContext, and returns the number of sources as the number of desired threads.
Reimplemented from Vertica::IterativeSourceFactory.
|
inlinevirtualinherited |
Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.
Reimplemented in Vertica::ParserFactory.
|
inlinevirtualinherited |
Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.
| srvInterface | a ServerInterface object used to communicate with Vertica |
| res | a VResources object used to tell Vertica what resources are needed by the UDX |
Reimplemented from Vertica::UDXFactory.
|
inlinevirtualinherited |
Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.
| srvInterface | a ServerInterface object used to communicate with Vertica |
| res | a VResources object used to tell Vertica what resources are needed by the UDX |
| argTypes | Provides the data types of arguments that this UDT was called with |
Reimplemented from Vertica::UDXFactory.
|
inlinevirtualinherited |
Provides the argument and return types of the UDL. UDL's take no input tuples; as such, their prototype is empty.
Implements Vertica::UDXFactory.
|
inlinevirtualinherited |
Not used in this form
Implements Vertica::UDXFactory.
|
inlinevirtualinherited |
Implements Vertica::UDXFactory.
|
inlinevirtual |
Execute any planning logic required at query plan time. This method is run once per query, during query initialization. Its job is to perform parameter validation, and to modify the set of nodes that the COPY statement will run on.
plan() runs exactly once per query, on the initiator node. If it throws an exception, the query will not proceed; it will be aborted prior to distributing the query to the other nodes and running prepare().
| srvInterface | Interface to server operations and functionality, including (not-per-column) parameter lookup |
| planCtxt | Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan(). Also provides functionality for specifying which nodes this query will run on. |
Reimplemented from Vertica::IterativeSourceFactory.
|
inlinevirtualinherited |
Prepare this SourceFactory to start creating sources. This function will be called on each node, prior to the Load operator starting to execute and prior to any other virtual functions on this class being called.
'planCtxt' contains the same data that was placed there by the plan() and getDesiredThreads() methods.
|
inlinevirtual |
Create UDSources. This function will be called on each node, prior to the Load operator starting to execute and prior to any other virtual functions on this class being called.
'planCtxt' contains the same data that was placed there by the plan() and getDesiredThreads() methods. It also exposes the maximum execution parallelism with 'getMaxAllowedThreads()' and the actual load concurrency with 'getLoadConcurrency()'.
Unlike the standard SourceFactory, this method directly instantiates all of its UDSources, and returns a vector of them. This requires that all UDSources be resident in memory for the duration of the query, which is fine in the common case but which may not be acceptable for some resource-intensive UDSources.
| srvInterface | Interface to server operations and functionality, including (not-per-column) parameter lookup |
| planCtxt | Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan() and getDesiredThreads(). Also provides functionality for determining which nodes this query is running on and getting the number of available threads. |