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
public class ReadActianVector extends CompositeOperator
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 Constructor Description ReadActianVector()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidcompose(CompositionContext ctx)Compose the body of this operator.RecordTokenTypediscoverType()Discovers the output type based on this operator's configuration.StringgetDatabase()Get the database name.Map<String,String>getExtraProperties()Get any extra JDBC properties for the connection.StringgetHost()Get the server host name property.List<String>getIncludedColumns()Get the columns which will be read from the table.StringgetInstance()Get the Actian Vector instance name.StringgetJdbcUrl()Gets the JDBC connection url that should be explicitly used.intgetMaxErrors()Get the maximum number of errors allowed.RecordPortgetOutput()StringgetPassword()Get the password.intgetPort()Get the Actian Vector instance port.StringgetTable()Get the target table name.StringgetUser()Get the user account name.intgetVectorSize()Get 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.voidsetHost(String hostName)Set 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.voidsetTable(String table)Set the name of the table to read.voidsetUser(String userName)Set 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
-
-
-
-
Method Detail
-
getOutput
public RecordPort getOutput()
-
getHost
public String getHost()
Get the server host name property.- Returns:
- server host name
-
setHost
public void setHost(String hostName)
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
public String getDatabase()
Get the database name.- Returns:
- database name
-
setDatabase
public void setDatabase(String database)
Set the database name. Specify the database where the target table lives.- Parameters:
databaseName- database name
-
getInstance
public String getInstance()
Get the Actian Vector instance name.- Returns:
- instance name
-
setInstance
public void setInstance(String instance)
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
public String getTable()
Get the target table name.- Returns:
- target table name
-
setTable
public void setTable(String table)
Set the name of the table to read.- Parameters:
tableName- target table name.
-
getUser
public String getUser()
Get the user account name.- Returns:
- user account name
-
setUser
public void setUser(String userName)
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
public String getPassword()
Get the password.- Returns:
- password
-
setPassword
public void setPassword(String password)
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
public void setIncludedColumns(List<String> includedColumns)
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
public List<String> getIncludedColumns()
Get the columns which will be read from the table.- Returns:
- the included columns
-
setExtraProperties
public void setExtraProperties(Map<String,String> extraProperties)
Set any extra JDBC properties for the connection.- Parameters:
extraProperties- key value settings that will be applied to the JDBC connection
-
getExtraProperties
public Map<String,String> getExtraProperties()
Get any extra JDBC properties for the connection.- Returns:
- the extra properties
-
setJdbcUrl
public void setJdbcUrl(String jdbcUrl)
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
public String getJdbcUrl()
Gets the JDBC connection url that should be explicitly used.- Returns:
- the jdbc url
-
discoverType
public RecordTokenType discoverType()
Discovers the output type based on this operator's configuration.- Returns:
- the discovered output type
-
compose
protected void compose(CompositionContext ctx)
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
-
-