A B C D E G H I M O P Q R S T U V

A

add(Object...) - Method in class edu.byu.hbll.db.batcher.Batcher

Inserts the row into the processing queue using BlockingQueue.add(Object).

B

Batcher - Class in edu.byu.hbll.db.batcher

Provides the base logic for submitting multiple MySQL insert, update, or delete requests as a single statement, which can provide significant speed benefits for large-scale database writing.

Batcher(Batcher.Builder<?>) - Constructor for class edu.byu.hbll.db.batcher.Batcher

Constructs a new Batcher using a Batcher.Builder as a template

Batcher.Builder<T extends Batcher.Builder<?>> - Class in edu.byu.hbll.db.batcher

Utility class for building Batcher objects with custom behavioral tweaks.

build() - Method in class edu.byu.hbll.db.batcher.Deleter.Builder

Builds a new Deleter.

build() - Method in class edu.byu.hbll.db.batcher.Inserter.Builder

Builds a new Inserter.

build() - Method in class edu.byu.hbll.db.TemporaryDatabase.Builder

Builds a new TemporaryDatabase instance using the current builder state as a template

build(Path) - Method in class edu.byu.hbll.db.TemporaryDatabase.Builder

Builds a new TemporaryDatabase instance using the current builder state as a template

build(String) - Method in class edu.byu.hbll.db.TemporaryDatabase.Builder

Builds a new TemporaryDatabase instance using the current builder state as a template

buildAndStart() - Method in class edu.byu.hbll.db.batcher.Deleter.Builder

Builds and starts a new Deleter in a new thread.

buildAndStart(ThreadFactory) - Method in class edu.byu.hbll.db.batcher.Deleter.Builder

Builds and starts a new Deleter in a new thread provided by the provided ThreadFactory.

buildAndStart() - Method in class edu.byu.hbll.db.batcher.Inserter.Builder

Builds and starts a new Inserter in a new thread.

buildAndStart(ThreadFactory) - Method in class edu.byu.hbll.db.batcher.Inserter.Builder

Builds and starts a new Inserter in a new thread provided by the provided ThreadFactory.

Builder(DataSource, String, String...) - Constructor for class edu.byu.hbll.db.batcher.Batcher.Builder

Constructs a new builder for the defined MySQL database and table

Builder(DataSource, String, String...) - Constructor for class edu.byu.hbll.db.batcher.Deleter.Builder

Constructs a new deleter builder for the defined MySQL database and table

Builder(DataSource, String, String...) - Constructor for class edu.byu.hbll.db.batcher.Inserter.Builder

Constructs a new builder for the defined MySQL database and table

Builder() - Constructor for class edu.byu.hbll.db.TemporaryDatabase.Builder

C

close() - Method in class edu.byu.hbll.db.TemporaryDatabase

Destroys the temporary database represented by this object

columnNames - Variable in class edu.byu.hbll.db.batcher.Batcher

columns - Variable in class edu.byu.hbll.db.batcher.Batcher.Builder

The MySQL columns/fields to be modified by the Batcher

columnString - Variable in class edu.byu.hbll.db.batcher.Batcher

columnTypes - Variable in class edu.byu.hbll.db.batcher.Batcher

D

dataSource - Variable in class edu.byu.hbll.db.batcher.Batcher.Builder

The DataSource to use for connecting to the MySQL database

dataSource - Variable in class edu.byu.hbll.db.batcher.Batcher

DEADLOCK_RETRIES - Static variable in class edu.byu.hbll.db.batcher.Batcher

The number of attempts to make in case a SQL operation returns a deadlock error.

DEADLOCK_SLEEP - Static variable in class edu.byu.hbll.db.batcher.Batcher

The number of milliseconds to wait between retries in case a SQL operation returns a deadlock error.

DEFAULT_HOST - Static variable in class edu.byu.hbll.db.TemporaryDatabase.Builder

DEFAULT_MAX_BATCH_DELAY - Static variable in class edu.byu.hbll.db.batcher.Batcher

The default duration of time to wait once the Batcher has become non-empty (i.e.

DEFAULT_MAX_BATCH_SIZE - Static variable in class edu.byu.hbll.db.batcher.Batcher

The default maximum number of rows that will be inserted/updated/deleted in the database during a single SQL operation.

DEFAULT_PASSWORD - Static variable in class edu.byu.hbll.db.TemporaryDatabase.Builder

DEFAULT_PORT - Static variable in class edu.byu.hbll.db.TemporaryDatabase.Builder

DEFAULT_QUEUE_SIZE - Static variable in class edu.byu.hbll.db.batcher.Batcher

By default, Batcher will store up to this many candidate rows.

DEFAULT_USER - Static variable in class edu.byu.hbll.db.TemporaryDatabase.Builder

Deleter - Class in edu.byu.hbll.db.batcher

Deleter enables asynchronous and rapid deletion of rows in a MySQL table given column values.

Deleter.Builder - Class in edu.byu.hbll.db.batcher

Utility class for building Deleter objects with custom behavioral tweaks.

E

edu.byu.hbll.db - package edu.byu.hbll.db

edu.byu.hbll.db.batcher - package edu.byu.hbll.db.batcher

execute(Object...) - Method in class edu.byu.hbll.db.batcher.Batcher

Prepares and executes a single batch insert/update/delete statement as defined by the implementation-specific Batcher.prepareSql(java.util.Collection<? extends java.lang.Object>) method.

execute(Collection<? extends Object>) - Method in class edu.byu.hbll.db.batcher.Batcher

Prepares and executes a single batch insert/update/delete statement as defined by the implementation-specific prepareSql method.

G

getDataSource() - Method in class edu.byu.hbll.db.TemporaryDatabase

Retrieves a DataSource pointing to the temporary database

getQueue() - Method in class edu.byu.hbll.db.batcher.Batcher

H

host(String) - Method in class edu.byu.hbll.db.TemporaryDatabase.Builder

Changes the MySQL host where the temporary database will be created; the default value is "localhost"

I

Inserter - Class in edu.byu.hbll.db.batcher

Implementation of Batcher that inserts submitted values as new rows in the corresponding table.

Inserter.Builder - Class in edu.byu.hbll.db.batcher

Utility class for building Inserter objects with custom behavioral tweaks.

M

maxBatchDelay - Variable in class edu.byu.hbll.db.batcher.Batcher.Builder

The maximum duration of time to wait for the Batcher queue to reach its maximum batch size after at least one row candidate is pending submission to the database.

maxBatchDelay(Duration) - Method in class edu.byu.hbll.db.batcher.Batcher.Builder

Defines the maximum duration of time to wait for the Batcher queue to reach its maximum batch size after at least one row candidate is pending submission to the database.

maxBatchDelay - Variable in class edu.byu.hbll.db.batcher.Batcher

maxBatchSize - Variable in class edu.byu.hbll.db.batcher.Batcher.Builder

The maximum number of rows that the resulting Batcher will submit in a single query.

maxBatchSize(int) - Method in class edu.byu.hbll.db.batcher.Batcher.Builder

Defines the maximum number of rows that the resulting Batcher will submit in a single query.

maxBatchSize - Variable in class edu.byu.hbll.db.batcher.Batcher

O

offer(Object...) - Method in class edu.byu.hbll.db.batcher.Batcher

Inserts the row into the processing queue using BlockingQueue.offer(Object).

offer(Duration, Object...) - Method in class edu.byu.hbll.db.batcher.Batcher

Inserts the row into the processing queue using BlockingQueue.offer(Object, long, TimeUnit).

onUpdate - Variable in class edu.byu.hbll.db.batcher.Inserter.Builder

onUpdate(String) - Method in class edu.byu.hbll.db.batcher.Inserter.Builder

Optional.

onUpdate - Variable in class edu.byu.hbll.db.batcher.Inserter

onUpdateIf - Variable in class edu.byu.hbll.db.batcher.Inserter.Builder

onUpdateIf(String) - Method in class edu.byu.hbll.db.batcher.Inserter.Builder

Optional.

onUpdateIf - Variable in class edu.byu.hbll.db.batcher.Inserter

P

password(String) - Method in class edu.byu.hbll.db.TemporaryDatabase.Builder

Sets the password that will connect to the MySQL server; the default value is null

port(int) - Method in class edu.byu.hbll.db.TemporaryDatabase.Builder

Changes the port that will be used to connect to the MySQL server; the default value is 3306

prepareSql(Collection<? extends Object>) - Method in class edu.byu.hbll.db.batcher.Batcher

Defines the SQL statement to be executed during each batch operation.

prepareSql(Collection<? extends Object>) - Method in class edu.byu.hbll.db.batcher.Deleter

Prepares the SQL responsible for performing a batch of deletes.

prepareSql(Collection<? extends Object>) - Method in class edu.byu.hbll.db.batcher.Inserter

Defines the insertion statement to be run by each execution of the batcher

put(Object...) - Method in class edu.byu.hbll.db.batcher.Batcher

Inserts the row into the processing queue using BlockingQueue.put(Object).

Q

queue - Variable in class edu.byu.hbll.db.batcher.Batcher.Builder

If not null at build time, this BlockingQueue will be used in place of the default BlockingQueue to backend the resulting Batcher.

queue(BlockingQueue<Object[]>) - Method in class edu.byu.hbll.db.batcher.Batcher.Builder

Defines a custom BlockingQueue for the resulting Batcher instance to use.

queue - Variable in class edu.byu.hbll.db.batcher.Batcher

queueSize - Variable in class edu.byu.hbll.db.batcher.Batcher.Builder

Defines the maximum capacity of the resulting Batcher.

queueSize(int) - Method in class edu.byu.hbll.db.batcher.Batcher.Builder

Defines the maximum capacity of the resulting Batcher.

R

run() - Method in class edu.byu.hbll.db.batcher.Batcher

S

shutdown() - Method in class edu.byu.hbll.db.batcher.Batcher

Instructs the Batcher to begin its shutdown procedure.

T

tableName - Variable in class edu.byu.hbll.db.batcher.Batcher.Builder

The table name of the MySQL table to be modified by the Batcher

tableName - Variable in class edu.byu.hbll.db.batcher.Batcher

TemporaryDatabase - Class in edu.byu.hbll.db

Creates a temporary MySQL database that can be subsequently destroyed upon close().

TemporaryDatabase.Builder - Class in edu.byu.hbll.db

U

untypedColumns(String...) - Static method in class edu.byu.hbll.db.batcher.Batcher.Builder

Converts zero or more column names in to a Map such that for each element of the map: key : column name value : null

user(String) - Method in class edu.byu.hbll.db.TemporaryDatabase.Builder

Sets the user that will connect to the MySQL server; the default value is test

V

valuePlaceholder - Variable in class edu.byu.hbll.db.batcher.Inserter

A B C D E G H I M O P Q R S T U V