com.gpudb

Class BulkInserter<T>

java.lang.Object

com.gpudb.BulkInserter<T>

Type Parameters:

T - the type of object being inserted

public class BulkInserter<T>
extends Object

Object that manages the insertion into GPUdb of large numbers of records in bulk, with automatic batch management and support for multi-head ingest. BulkInserter instances are thread safe and may be used from any number of threads simultaneously. Use the insert(Object) and insert(List) methods to queue records for insertion, and the flush() method to ensure that all queued records have been inserted.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BulkInserter.InsertException An exception that occurred during the insertion of records into GPUdb.
static class	BulkInserter.WorkerList Deprecated. This class has been superceded by com.gpudb.WorkerList.

Constructor Summary

Constructors

Constructor and Description
BulkInserter(GPUdb gpudb, String tableName, Type type, int batchSize, Map<String,String> options) Creates a BulkInserter with the specified parameters.
BulkInserter(GPUdb gpudb, String tableName, Type type, int batchSize, Map<String,String> options, WorkerList workers) Creates a BulkInserter with the specified parameters.
BulkInserter(GPUdb gpudb, String tableName, TypeObjectMap<T> typeObjectMap, int batchSize, Map<String,String> options) Creates a BulkInserter with the specified parameters.
BulkInserter(GPUdb gpudb, String tableName, TypeObjectMap<T> typeObjectMap, int batchSize, Map<String,String> options, WorkerList workers) Creates a BulkInserter with the specified parameters.

Method Summary

Modifier and Type	Method and Description
void	flush() Ensures that any queued records are inserted into GPUdb.
int	getBatchSize() Gets the batch size (the number of records to insert into GPUdb at a time).
long	getCountInserted() Gets the number of records inserted into GPUdb.
long	getCountUpdated() Gets the number of records updated (instead of inserted) in GPUdb due to primary key conflicts.
GPUdb	getGPUdb() Gets the GPUdb instance into which records will be inserted.
Map<String,String>	getOptions() Gets the optional parameters that will be passed to GPUdb while inserting.
int	getRetryCount() Gets the number of times inserts into GPUdb will be retried in the event of an error.
String	getTableName() Gets the name of the table into which records will be inserted.
void	insert(List<T> records) Queues a list of records for insertion into GPUdb.
void	insert(T record) Queues a record for insertion into GPUdb.
void	setRetryCount(int value) Sets the number of times inserts into GPUdb will be retried in the event of an error.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BulkInserter

public BulkInserter(GPUdb gpudb,
                    String tableName,
                    Type type,
                    int batchSize,
                    Map<String,String> options)
             throws GPUdbException

Creates a BulkInserter with the specified parameters.

Parameters:

gpudb - the GPUdb instance to insert records into

tableName - the table to insert records into

type - the type of records being inserted

batchSize - the number of records to insert into GPUdb at a time (records will queue until this number is reached)

options - optional parameters to pass to GPUdb while inserting

Throws:

GPUdbException - if a configuration error occurs

IllegalArgumentException - if an invalid parameter is specified

See Also:

InsertRecordsRequest.Options

BulkInserter

public BulkInserter(GPUdb gpudb,
                    String tableName,
                    Type type,
                    int batchSize,
                    Map<String,String> options,
                    WorkerList workers)
             throws GPUdbException

Creates a BulkInserter with the specified parameters.

Parameters:

gpudb - the GPUdb instance to insert records into

tableName - name of the table to insert records into

type - the type of records being inserted

batchSize - the number of records to insert into GPUdb at a time (records will queue until this number is reached); for multi-head ingest, this value is per worker

options - optional parameters to pass to GPUdb while inserting (null for no parameters)

workers - worker list for multi-head ingest (null to disable multi-head ingest)

Throws:

GPUdbException - if a configuration error occurs

IllegalArgumentException - if an invalid parameter is specified

See Also:

InsertRecordsRequest.Options

BulkInserter

public BulkInserter(GPUdb gpudb,
                    String tableName,
                    TypeObjectMap<T> typeObjectMap,
                    int batchSize,
                    Map<String,String> options)
             throws GPUdbException

Creates a BulkInserter with the specified parameters.

Parameters:

gpudb - the GPUdb instance to insert records into

tableName - name of the table to insert records into

typeObjectMap - type object map for the type of records being inserted

batchSize - the number of records to insert into GPUdb at a time (records will queue until this number is reached)

options - optional parameters to pass to GPUdb while inserting (null for no parameters)

Throws:

GPUdbException - if a configuration error occurs

IllegalArgumentException - if an invalid parameter is specified

See Also:

InsertRecordsRequest.Options

BulkInserter

public BulkInserter(GPUdb gpudb,
                    String tableName,
                    TypeObjectMap<T> typeObjectMap,
                    int batchSize,
                    Map<String,String> options,
                    WorkerList workers)
             throws GPUdbException

Creates a BulkInserter with the specified parameters.

Parameters:

gpudb - the GPUdb instance to insert records into

tableName - name of the table to insert records into

typeObjectMap - type object map for the type of records being inserted

batchSize - the number of records to insert into GPUdb at a time (records will queue until this number is reached); for multi-head ingest, this value is per worker

options - optional parameters to pass to GPUdb while inserting (null for no parameters)

workers - worker list for multi-head ingest (null to disable multi-head ingest)

Throws:

GPUdbException - if a configuration error occurs

IllegalArgumentException - if an invalid parameter is specified

See Also:

InsertRecordsRequest.Options

Method Detail

getGPUdb

public GPUdb getGPUdb()

Gets the GPUdb instance into which records will be inserted.

Returns:

the GPUdb instance into which records will be inserted

getTableName

public String getTableName()

Gets the name of the table into which records will be inserted.

Returns:

the name of the table into which records will be inserted

getBatchSize

public int getBatchSize()

Gets the batch size (the number of records to insert into GPUdb at a time). For multi-head ingest this value is per worker.

Returns:

the batch size

getOptions

public Map<String,String> getOptions()

Gets the optional parameters that will be passed to GPUdb while inserting.

Returns:

the optional parameters that will be passed to GPUdb while inserting

See Also:

InsertRecordsRequest.Options

getRetryCount

public int getRetryCount()

Gets the number of times inserts into GPUdb will be retried in the event of an error. After this many retries, BulkInserter.InsertException will be thrown.

Returns:

the number of retries

See Also:

setRetryCount(int)

setRetryCount

public void setRetryCount(int value)

Sets the number of times inserts into GPUdb will be retried in the event of an error. After this many retries, BulkInserter.InsertException will be thrown.

Parameters:

value - the number of retries

Throws:

IllegalArgumentException - if value is less than zero

See Also:

getRetryCount()

getCountInserted

public long getCountInserted()

Gets the number of records inserted into GPUdb. Excludes records that are currently queued but not yet inserted and records not inserted due to primary key conflicts.

Returns:

the number of records inserted

getCountUpdated

public long getCountUpdated()

Gets the number of records updated (instead of inserted) in GPUdb due to primary key conflicts.

Returns:

the number of records updated

flush

public void flush()
           throws BulkInserter.InsertException

Ensures that any queued records are inserted into GPUdb. If an error occurs while inserting the records from any queue, the records will no longer be in that queue nor in GPUdb; catch BulkInserter.InsertException to get the list of records that were being inserted if needed (for example, to retry). Other queues may also still contain unflushed records if this occurs.

Throws:

BulkInserter.InsertException - if an error occurs while inserting

insert

public void insert(T record)
            throws BulkInserter.InsertException

Queues a record for insertion into GPUdb. If the queue reaches the batch size, all records in the queue will be inserted into GPUdb before the method returns. If an error occurs while inserting the records, the records will no longer be in the queue nor in GPUdb; catch BulkInserter.InsertException to get the list of records that were being inserted if needed (for example, to retry).

Parameters:

record - the record to insert

Throws:

GPUdbException - if an error occurs while calculating shard/primary keys

BulkInserter.InsertException - if an error occurs while inserting

insert

public void insert(List<T> records)
            throws BulkInserter.InsertException

Queues a list of records for insertion into GPUdb. If any queue reaches the batch size, all records in that queue will be inserted into GPUdb before the method returns. If an error occurs while inserting the queued records, the records will no longer be in that queue nor in GPUdb; catch BulkInserter.InsertException to get the list of records that were being inserted (including any from the queue in question and any remaining in the list not yet queued) if needed (for example, to retry). Note that depending on the number of records, multiple calls to GPUdb may occur.

Parameters:

records - the records to insert

Throws:

BulkInserter.InsertException - if an error occurs while inserting