ai.grakn.client

Class BatchMutatorClient

java.lang.Object

ai.grakn.client.BatchMutatorClient

public class BatchMutatorClient
extends Object

Client to batch load qraql queries into Grakn that mutate the graph. Provides methods to batch load queries. Optionally can provide a consumer that will execute when a batch finishes loading. BatchMutatorClient will block when the configured resources are being used to execute tasks.

Author:

alexandraorth

Constructor Summary

Constructors

Constructor and Description
BatchMutatorClient(ai.grakn.Keyspace keyspace, String uri, boolean debugOn, int maxRetries)
BatchMutatorClient(ai.grakn.Keyspace keyspace, String uri, java.util.function.Consumer<TaskResult> onCompletionOfTask, boolean reportStats, boolean debugOn, int maxRetries)
BatchMutatorClient(ai.grakn.Keyspace keyspace, String uri, java.util.function.Consumer<TaskResult> onCompletionOfTask, boolean debugOn, int maxRetries)

Method Summary

Modifier and Type	Method and Description
void	add(Query query) Add an insert query to the queue.
void	close() Wait for all of the submitted tasks to have been completed
int	getBatchSize() Get the number of queries in each transaction
BatchMutatorClient	setBatchSize(int size) Set the size of the each transaction in terms of number of vars.
BatchMutatorClient	setNumberActiveTasks(int size) Number of active tasks running on the server at any one time.
BatchMutatorClient	setTaskCompletionConsumer(java.util.function.Consumer<TaskResult> onCompletionOfTask) Provide a consumer function to execute upon task completion
void	waitToFinish() Wait for all of the submitted tasks to have been completed

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchMutatorClient

public BatchMutatorClient(ai.grakn.Keyspace keyspace,
                          String uri,
                          boolean debugOn,
                          int maxRetries)

BatchMutatorClient

public BatchMutatorClient(ai.grakn.Keyspace keyspace,
                          String uri,
                          java.util.function.Consumer<TaskResult> onCompletionOfTask,
                          boolean debugOn,
                          int maxRetries)

BatchMutatorClient

public BatchMutatorClient(ai.grakn.Keyspace keyspace,
                          String uri,
                          java.util.function.Consumer<TaskResult> onCompletionOfTask,
                          boolean reportStats,
                          boolean debugOn,
                          int maxRetries)

Method Detail

setTaskCompletionConsumer

public BatchMutatorClient setTaskCompletionConsumer(java.util.function.Consumer<TaskResult> onCompletionOfTask)

Provide a consumer function to execute upon task completion

Parameters:

onCompletionOfTask - function applied to the last state of the task

setBatchSize

public BatchMutatorClient setBatchSize(int size)

Set the size of the each transaction in terms of number of vars.

Parameters:

size - number of vars in each transaction

getBatchSize

public int getBatchSize()

Get the number of queries in each transaction

Returns:

the batch size

setNumberActiveTasks

public BatchMutatorClient setNumberActiveTasks(int size)

Number of active tasks running on the server at any one time. Consider this a safeguard on system load. The Loader add(Query) method will block on the value of this field.

Parameters:

size - number of tasks to allow to run at any given time

add

public void add(Query query)

Add an insert query to the queue. This method will block while the number of currently executing tasks is equal to the set setNumberActiveTasks(int). It will become unblocked as tasks are completed.

Parameters:

query - insert query to be executed

waitToFinish

public void waitToFinish()

Wait for all of the submitted tasks to have been completed

close

public void close()

Wait for all of the submitted tasks to have been completed