ai.grakn.client

Class LoaderClient

java.lang.Object

ai.grakn.client.LoaderClient

public class LoaderClient
extends Object

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

Author:

alexandraorth

Constructor Summary

Constructors

Constructor and Description
LoaderClient(String keyspace, String uri)
LoaderClient(String keyspace, String uri, java.util.function.Consumer<mjson.Json> onCompletionOfTask)

Method Summary

Modifier and Type	Method and Description
void	add(InsertQuery query) Add an insert query to the queue.
void	flush() Load any remaining batches in the queue.
LoaderClient	setBatchSize(int size) Set the size of the each transaction in terms of number of vars.
LoaderClient	setNumberActiveTasks(int size) Number of active tasks running on the server at any one time.
void	waitToFinish() Wait for all of the submitted tasks to have been completed TODO If the submitted tasks are never marked as COMPLETED/STOPPED/FAILED this TODO wait will hang forever.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoaderClient

public LoaderClient(String keyspace,
                    String uri)

LoaderClient

public LoaderClient(String keyspace,
                    String uri,
                    java.util.function.Consumer<mjson.Json> onCompletionOfTask)

Method Detail

setBatchSize

public LoaderClient setBatchSize(int size)

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

Parameters:

size - number of vars in each transaction

setNumberActiveTasks

public LoaderClient 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(InsertQuery) 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(InsertQuery query)

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

Parameters:

query - insert query to be executed

flush

public void flush()

Load any remaining batches in the queue.

waitToFinish

public void waitToFinish()

Wait for all of the submitted tasks to have been completed TODO If the submitted tasks are never marked as COMPLETED/STOPPED/FAILED this TODO wait will hang forever. We may want to consider adding a timeout