LoadVectorwise (Dataflow Library Distribution Project 6.6.0-111 API)

java.lang.Object
- com.pervasive.datarush.operators.AbstractLogicalOperator
- - com.pervasive.datarush.operators.CompositeOperator
  - - com.pervasive.datarush.operators.io.vectorwise.LoadVectorwise

All Implemented Interfaces:

LogicalOperator, RecordSinkOperator, SinkOperator<RecordPort>
```
public class LoadVectorwise
extends CompositeOperator
implements RecordSinkOperator
```
Bulk load data into the Vectorwise database. The data can be loading using one of three available bulk loading methods:
- Using the direct load capability: this is the fastest method of loading and supports cluster execution. However direct loading is only supported on Linux & Windows 64-bit platforms. The data is formatted locally in memory and streamed to the Vectorwise server. Vector 3.5 Changes - This method can load to both Vector 3.1 and 3.5 versions. However, only one version can be loaded at a time. Sorting - When loading Vector 3.5, this plugin sorts the data based on clustered indexes. Unique Keys - When loading Vector 3.5, if Unique Keys are defined and they are same as sort keys, the plugin eliminates any duplicates and loads only unique keys.
  Limitations - When loading Vector 3.5,
  - If both unique and primary keys are defined and are not same, the loading will fail.
  - When sort key or unique key is specified, incremental loads are not supported
  - Multiple unique keys are not supported. However, a unique key can have multiple columns
- Using the vwload utility: this method is only available on the server instance where Vectorwise is installed. The data is first written into a temporary area to prepare for loading into the database.
- Using the SQL copy command: this option supports remote execution. However, the Vectorwise client must be installed and running on the machine executing the DataRush application. The data is first written into a temporary area to prepare for loading into the database.
When using the direct loading method within a cluster execution environment, the client can be executing on a platform not supported by the direct loader. However, the target execution environment must be supported by the direct loader. Currently, support is limited to Linux & Windows 64-bit platforms.

Constructor Summary

Constructors
Constructor and Description

LoadVectorwise()

Constructors
Constructor and Description
`LoadVectorwise()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`compose(CompositionContext ctx)` Compose the body of this operator.
`int`	`getBufferSize()` Gets the data buffer size (in rows).
`String`	`getCharset()` Get the character set used when staging and loading for vwload method for Vectorwise operator.
`String`	`getDatabaseName()` Get the database name.
`String`	`getFinalizeTableSQL()` Retrieves the SQL statement to execute after processing all the records.
`String`	`getHost()` Get the server host name property.
`String`	`getInitializeTableSQL()` Retrieves the SQL statement to execute before processing any records.
`RecordPort`	`getInput()` Gets the record port providing the input data to the sink.
`String`	`getInstance()` Get the Vectorwise instance name.
`int`	`getMaxErrors()` Get the maximum number of errors allowed.
`LoadMethod`	`getMethod()` Get the load method in use.
`String`	`getPassword()` Get the password.
`String`	`getRejectsPath()` Get the rejects path.
`Map<String,String>`	`getRenameMapping()` Get the source to target field mapping.
`boolean`	`getRollback()` Get whether rollback is enabled or disabled.
`String`	`getSchema()` Get the target schema name.
`boolean`	`getStringTruncationError()` Get whether errors on string truncation is enabled or disabled.
`String`	`getTableName()` Get the target table name.
`String`	`getUser()` Get the user account name.
`void`	`setBufferSize(int bufferSize)` Sets the size of the data buffer (in rows) used to cache data before sending to the Vectorwise engine.
`void`	`setCharset(String charsetName)` Set the character set used for data staging and loading for vwload load method.
`void`	`setDatabaseName(String databaseName)` Set the database name.
`void`	`setFinalizeTableSQL(String finalizeTableSQL)` Sets the SQL statement to execute after processing all the records.
`void`	`setHost(String hostName)` Set the host name property.
`void`	`setInitializeTableSQL(String initializeTableSQL)` Sets the SQL statement to execute before processing any records.
`void`	`setInstance(String instance)` Set the Vectorwise instance name.
`void`	`setMaxErrors(int maxErrors)` Set the maximum number of errors allowed before rolling back the data load operation.
`void`	`setMethod(LoadMethod method)` Set the load method to use.
`void`	`setPassword(String password)` Set the user's password.
`void`	`setRejectsPath(String rejectsPath)` Set the rejects path.
`void`	`setRenameMapping(Map<String,String> renameMapping)` Set a rename mapping.
`void`	`setRollback(boolean enabled)` Enable or disable rollback processing.
`void`	`setSchema(String schema)` Set the schema for the target table.
`void`	`setStringTruncationError(boolean enableStringTruncationError)` Set whether errors on string truncation is enabled or disabled.
`void`	`setTableName(String tableName)` Set the name of the table to load.
`void`	`setUser(String userName)` Set the user name.

Methods inherited from class com.pervasive.datarush.operators.AbstractLogicalOperator
disableParallelism, getInputPorts, getOutputPorts, newInput, newInput, newOutput, newRecordInput, newRecordInput, newRecordOutput, notifyError

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pervasive.datarush.operators.LogicalOperator
disableParallelism, getInputPorts, getOutputPorts

- Constructor Detail
  - LoadVectorwise
```
public LoadVectorwise()
```
- Method Detail
  - getInput
```
public RecordPort getInput()
```
    Description copied from interface: RecordSinkOperator
    
    Gets the record port providing the input data to the sink.
    
    Specified by:
    
    getInput in interface RecordSinkOperator
    
    Specified by:
    
    getInput in interface SinkOperator<RecordPort>
    
    Returns:
    
    the input port for the sink
  - 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 Vectorwise is installed.
    
    Parameters:
    
    hostName - Vectorwise server host name
  - getInstance
```
public String getInstance()
```
    Get the Vectorwise instance name.
    
    Returns:
    
    instance name
  - setInstance
```
public void setInstance(String instance)
```
    Set the Vectorwise instance name. Defaults to "VW".
    
    Parameters:
    
    instanceName - instance name
  - getDatabaseName
```
public String getDatabaseName()
```
    Get the database name.
    
    Returns:
    
    database name
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    Set the database name. Specify the database where the target table lives.
    
    Parameters:
    
    databaseName - database name
  - getTableName
```
public String getTableName()
```
    Get the target table name.
    
    Returns:
    
    target table name
  - setTableName
```
public void setTableName(String tableName)
```
    Set the name of the table to load.
    
    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.
    When using the vwload load method, the user name is not always needed. The vwload utility has to be executed by the DBA user. 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.
    When using the vwload load method, the password is not always needed. The vwload utility has to be executed by the DBA user. The user name and password supplied is for a user account that has write/copy access to the target table.
    
    Parameters:
    
    password -
  - getRenameMapping
```
public Map<String,String> getRenameMapping()
```
    Get the source to target field mapping.
    
    Returns:
    
    the rename mapping
  - setRenameMapping
```
public void setRenameMapping(Map<String,String> renameMapping)
```
    Set a rename mapping. This should be an ordered (i.e. LinkedHashMap) mapping of names. The keys in the map represent the original names in the input record port. The values in the map represent the column names in the table. If the names are the same, the mapping is not required. Any columns that are not included in the mapping will be dropped from the input.
    This is an optional property. If not provided, the input fields are mapped to the target database table by schema order.
    
    Parameters:
    
    renameMapping - the mapping from old to new names.
  - getRejectsPath
```
public String getRejectsPath()
```
    Get the rejects path.
    
    Returns:
    
    target path name
  - setRejectsPath
```
public void setRejectsPath(String rejectsPath)
```
    Set the rejects path. Any records of the input that fail to load into the target database will be written to a file at the given path. If no rejects are encountered, the target file will not be created.
    
    Parameters:
    
    rejectsPath - target path name
  - 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 before rolling back the data load operation.
    
    Parameters:
    
    maxErrors - maximum errors allowed
  - getMethod
```
public LoadMethod getMethod()
```
    Get the load method in use.
    
    Returns:
    
    load method
  - setMethod
```
public void setMethod(LoadMethod method)
```
    Set the load method to use.
    
    Parameters:
    
    mode - load method (vwload is the default)
  - getRollback
```
public boolean getRollback()
```
    Get whether rollback is enabled or disabled.
    
    Returns:
    
    rollback setting
  - setBufferSize
```
public void setBufferSize(int bufferSize)
```
    Sets the size of the data buffer (in rows) used to cache data before sending to the Vectorwise engine. This property is applicable only for direct loads.
    
    Parameters:
    
    bufferSize - data buffer size in rows
  - getBufferSize
```
public int getBufferSize()
```
    Gets the data buffer size (in rows).
    
    Returns:
    
    data buffer size
  - setRollback
```
public void setRollback(boolean enabled)
```
    Enable or disable rollback processing. If enabled, after the maximum number of errors allowed has been encountered, the data load will be aborted and rolled back. No new data will be inserted into the target table.
    If disabled, the operation is still aborted when the maximum number of errors has been encountered. However, the data load is not rolled back. Any data successfully loaded will appear in the target table.
    
    Parameters:
    
    rollback - enable (true) or disable (false) rollback
  - getInitializeTableSQL
```
public String getInitializeTableSQL()
```
    Retrieves the SQL statement to execute before processing any records.
    
    Returns:
    
    the SQL statement to execute before processing any records
  - setInitializeTableSQL
```
public void setInitializeTableSQL(String initializeTableSQL)
```
    Sets the SQL statement to execute before processing any records. If the table does not exist this value is required, and should contain a CREATE TABLE statement to create the table.
    This statement is executed only once, regardless of #partitionCount.
    
    Parameters:
    
    initializeTableSQL - the SQL statement to execute before processing any records
  - getFinalizeTableSQL
```
public String getFinalizeTableSQL()
```
    Retrieves the SQL statement to execute after processing all the records.
    
    Returns:
    
    the SQL statement to execute after processing all the records
  - setFinalizeTableSQL
```
public void setFinalizeTableSQL(String finalizeTableSQL)
```
    Sets the SQL statement to execute after processing all the records. One example use is a CREATE INDEX statement.
    This statement is executed only once, regardless of #partitionCount.
    
    Parameters:
    
    finalizeTableSQL - the SQL statement to execute after processing all the records
  - getStringTruncationError
```
public boolean getStringTruncationError()
```
    Get whether errors on string truncation is enabled or disabled.
    
    Returns:
    
    string truncation error setting
  - setStringTruncationError
```
public void setStringTruncationError(boolean enableStringTruncationError)
```
    Set whether errors on string truncation is enabled or disabled.
    
    Parameters:
    
    stringTruncationError - enable(true) or disable(false) errors on string truncation
  - setSchema
```
public void setSchema(String schema)
```
    Set the schema for the target table. This is only required when using the DIRECT method of loading and a user/password is not required. The schema is used to generate the actual table name within the Vector system.
    
    Parameters:
    
    schema - schema of the target table
  - getSchema
```
public String getSchema()
```
    Get the target schema name.
    
    Returns:
    
    schema of the target table
  - setCharset
```
public void setCharset(String charsetName)
```
    Set the character set used for data staging and loading for vwload load method.
    
    Parameters:
    
    charsetName - character set used when staging and loading for vwload method
  - getCharset
```
public String getCharset()
```
    Get the character set used when staging and loading for vwload method for Vectorwise operator.
    
    Returns:
    
    charset used when staging and loading data for vwload method
  - compose
```
protected void compose(CompositionContext ctx)
```
    Description copied from class: CompositeOperator
    Compose the body of this operator. Implementations should do the following:
    1. Perform any validation of configuration, input types, etc
    2. Instantiate and configure sub-operators, adding them to the provided context via the method OperatorComposable.add(O)
    3. 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:
    
    compose in class CompositeOperator
    
    Parameters:
    
    ctx - the context

Class LoadVectorwise

Constructor Summary

Method Summary

Methods inherited from class com.pervasive.datarush.operators.AbstractLogicalOperator

Methods inherited from class java.lang.Object

Methods inherited from interface com.pervasive.datarush.operators.LogicalOperator

Constructor Detail

LoadVectorwise

Method Detail

getInput

getHost

setHost

getInstance

setInstance

getDatabaseName

setDatabaseName

getTableName

setTableName

getUser

setUser

getPassword

setPassword

getRenameMapping

setRenameMapping

getRejectsPath

setRejectsPath

getMaxErrors

setMaxErrors

getMethod

setMethod

getRollback

setBufferSize

getBufferSize

setRollback

getInitializeTableSQL

setInitializeTableSQL

getFinalizeTableSQL

setFinalizeTableSQL

getStringTruncationError

setStringTruncationError

setSchema

getSchema

setCharset

getCharset

compose