Module datarush.library
Class ReadActianVector
java.lang.Object
com.pervasive.datarush.operators.AbstractLogicalOperator
com.pervasive.datarush.operators.CompositeOperator
com.pervasive.datarush.operators.io.vectorwise.ReadActianVector
- All Implemented Interfaces:
LogicalOperator
Bulk read data from the Actian Vector database. This utilizes a direct connection
with the database initialized with a jdbc connection. This allows the read to
operate with greater parallelism than the typical Vector jdbc connection.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidCompose the body of this operator.Discovers the output type based on this operator's configuration.Get the database name.Get any extra JDBC properties for the connection.getHost()Get the server host name property.Get the columns which will be read from the table.Get the Actian Vector instance name.Gets the JDBC connection url that should be explicitly used.intGet the maximum number of errors allowed.Get the password.intgetPort()Get the Actian Vector instance port.getTable()Get the target table name.getUser()Get the user account name.intGet the buffer size (in rows).voidsetDatabase(String database) Set the database name.voidsetExtraProperties(Map<String, String> extraProperties) Set any extra JDBC properties for the connection.voidSet the host name property.voidsetIncludedColumns(List<String> includedColumns) Set the columns which should be read from the table.voidsetInstance(String instance) Set the Actian Vector instance name.voidsetJdbcUrl(String jdbcUrl) Sets the jdbc connection url that should explicitly be used.voidsetMaxErrors(int maxErrors) Set the maximum number of errors allowed per stream before aborting the data read operation.voidsetPassword(String password) Set the user's password.voidsetPort(int port) Set the Actian Vector instance port.voidSet the name of the table to read.voidSet the user name.voidsetVectorSize(int vectorSize) Set the size of the buffer (in rows) used to cache data received from the Vector engine.Methods inherited from class com.pervasive.datarush.operators.AbstractLogicalOperator
disableParallelism, getInputPorts, getOutputPorts, newInput, newInput, newOutput, newRecordInput, newRecordInput, newRecordOutput, notifyError
-
Constructor Details
-
ReadActianVector
public ReadActianVector()
-
-
Method Details
-
getOutput
-
getHost
Get the server host name property.- Returns:
- server host name
-
setHost
Set the host name property. This is the host name of the server where Actian Vector is installed.- Parameters:
hostName- Actian Vector server host name
-
getDatabase
Get the database name.- Returns:
- database name
-
setDatabase
Set the database name. Specify the database where the target table lives.- Parameters:
databaseName- database name
-
getInstance
Get the Actian Vector instance name.- Returns:
- instance name
-
setInstance
Set the Actian Vector instance name. Vector defaults are "VW" and "VH".- Parameters:
instanceName- instance name
-
getPort
public int getPort()Get the Actian Vector instance port.- Returns:
- port number
-
setPort
public void setPort(int port) Set the Actian Vector instance port. Defaults to 7.- Parameters:
port- port number
-
getVectorSize
public int getVectorSize()Get the buffer size (in rows).- Returns:
- buffer size
-
setVectorSize
public void setVectorSize(int vectorSize) Set the size of the buffer (in rows) used to cache data received from the Vector engine. Defaults to 1024.- Parameters:
vectorSize- buffer size in rows
-
getMaxErrors
public int getMaxErrors()Get the maximum number of errors allowed.- Returns:
- maximum errors
-
setMaxErrors
public void setMaxErrors(int maxErrors) Set the maximum number of errors allowed per stream before aborting the data read operation.- Parameters:
maxErrors- maximum errors allowed per stream
-
getTable
Get the target table name.- Returns:
- target table name
-
setTable
Set the name of the table to read.- Parameters:
tableName- target table name.
-
getUser
Get the user account name.- Returns:
- user account name
-
setUser
Set the user name.The user name and password supplied is for a user account that has write/copy access to the target table.
- Parameters:
userName- user account name
-
getPassword
Get the password.- Returns:
- password
-
setPassword
Set the user's password.The user name and password supplied is for a user account that has write/copy access to the target table.
- Parameters:
password-
-
setIncludedColumns
Set the columns which should be read from the table. These should match the column names in the table itself. If the output type is manually specified this should not be specified.- Parameters:
includedColumns- list of columns which will be read
-
getIncludedColumns
Get the columns which will be read from the table.- Returns:
- the included columns
-
setExtraProperties
Set any extra JDBC properties for the connection.- Parameters:
extraProperties- key value settings that will be applied to the JDBC connection
-
getExtraProperties
Get any extra JDBC properties for the connection.- Returns:
- the extra properties
-
setJdbcUrl
Sets the jdbc connection url that should explicitly be used. It is not required to set this in most cases.- Parameters:
jdbcUrl- url used to connect to jdbc
-
getJdbcUrl
Gets the JDBC connection url that should be explicitly used.- Returns:
- the jdbc url
-
discoverType
Discovers the output type based on this operator's configuration.- Returns:
- the discovered output type
-
compose
Description copied from class:CompositeOperatorCompose the body of this operator. Implementations should do the following:- Perform any validation of configuration, input types, etc
- Instantiate and configure sub-operators, adding them to the provided context via
the method
OperatorComposable.add(O) - Create necessary connections via the method
OperatorComposable.connect(P, P). This includes connections from the composite's input ports to sub-operators, connections between sub-operators, and connections from sub-operators output ports to the composite's output ports
- Specified by:
composein classCompositeOperator- Parameters:
ctx- the context
-