com.algolia.search.saas

Class OfflineIndex.WriteTransaction

Object

com.algolia.search.saas.OfflineIndex.WriteTransaction

Enclosing class:

OfflineIndex

public class OfflineIndex.WriteTransaction
extends Object

A transaction to update the index. A transaction gathers all the operations that will be performed when the transaction is committed. Its purpose is twofold: 1. Avoid rebuilding the index for every individual operation, which would be astonishingly costly. 2. Avoid keeping all the necessary data in memory, e.g. by flushing added objects to temporary files on disk. A transaction can be created by calling OfflineIndex.newTransaction().

Constructor Summary

Constructors

Constructor and Description
WriteTransaction()

Method Summary

Modifier and Type	Method and Description
Request	clearIndexAsync(CompletionHandler completionHandler) Delete the index content without removing settings.
void	clearIndexSync() Delete the index content without removing settings.
Request	commitAsync(CompletionHandler completionHandler) Commit the transaction.
void	commitSync() Commit the transaction (synchronously).
Request	deleteObjectAsync(String objectID, CompletionHandler completionHandler) Delete an object.
Request	deleteObjectsAsync(Collection<String> objectIDs, CompletionHandler completionHandler) Delete multiple objects.
void	deleteObjectsSync(Collection<String> objectIDs) Delete multiple objects (synchronously).
void	deleteObjectSync(String objectID) Delete an object (synchronously).
void	finalize()
int	getId() Get this transaction's ID.
boolean	isFinished() Test whether this transaction is finished.
Request	rollbackAsync(CompletionHandler completionHandler) Roll back the current write transaction.
void	rollbackSync() Rollback the transaction.
Request	saveObjectAsync(JSONObject object, CompletionHandler completionHandler) Save an object.
Request	saveObjectsAsync(JSONArray objects, CompletionHandler completionHandler) Save multiple objects.
void	saveObjectsSync(JSONArray objects) Save multiple objects (synchronously).
void	saveObjectSync(JSONObject object) Save an object (synchronously).
Request	setSettingsAsync(JSONObject settings, CompletionHandler completionHandler) Set the index settings.
void	setSettingsSync(JSONObject settings) Set the index settings (synchronously).
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WriteTransaction

public WriteTransaction()

Method Detail

finalize

public void finalize()

Overrides:

finalize in class Object

toString

@NonNull
public String toString()

Overrides:

toString in class Object

getId

public int getId()

Get this transaction's ID.

Returns:

This transaction's ID.

isFinished

public boolean isFinished()

Test whether this transaction is finished.

Returns:

Whether this transaction is finished.

saveObjectAsync

public Request saveObjectAsync(@NonNull
                               JSONObject object,
                               CompletionHandler completionHandler)

Save an object.

Parameters:

object - Object to save. Must contain an `objectID` attribute.

completionHandler - Completion handler to be notified of the request's outcome.

Returns:

A cancellable operation.

saveObjectSync

public void saveObjectSync(@NonNull
                           JSONObject object)
                    throws AlgoliaException

Save an object (synchronously).

Parameters:

object - Object to save. Must contain an `objectID` attribute.

Throws:

AlgoliaException

saveObjectsAsync

public Request saveObjectsAsync(@NonNull
                                JSONArray objects,
                                CompletionHandler completionHandler)

Save multiple objects.

Parameters:

objects - Objects to save. Each one must contain an `objectID` attribute.

completionHandler - Completion handler to be notified of the request's outcome.

Returns:

A cancellable operation.

saveObjectsSync

public void saveObjectsSync(@NonNull
                            JSONArray objects)
                     throws AlgoliaException

Save multiple objects (synchronously).

Parameters:

objects - Objects to save. Each one must contain an `objectID` attribute.

Throws:

AlgoliaException

deleteObjectAsync

public Request deleteObjectAsync(@NonNull
                                 String objectID,
                                 CompletionHandler completionHandler)

Delete an object.

Parameters:

objectID - Identifier of object to delete.

completionHandler - Completion handler to be notified of the request's outcome.

Returns:

A cancellable operation.

deleteObjectSync

public void deleteObjectSync(@NonNull
                             String objectID)
                      throws AlgoliaException

Delete an object (synchronously).

Parameters:

objectID - Identifier of the object to delete.

Throws:

AlgoliaException

deleteObjectsAsync

public Request deleteObjectsAsync(Collection<String> objectIDs,
                                  CompletionHandler completionHandler)

Delete multiple objects.

Parameters:

objectIDs - Identifiers of objects to delete.

completionHandler - Completion handler to be notified of the request's outcome.

Returns:

A cancellable operation.

deleteObjectsSync

public void deleteObjectsSync(@NonNull
                              Collection<String> objectIDs)
                       throws AlgoliaException

Delete multiple objects (synchronously).

Parameters:

objectIDs - Identifiers of the objects to delete.

Throws:

AlgoliaException

setSettingsAsync

public Request setSettingsAsync(@NonNull
                                JSONObject settings,
                                CompletionHandler completionHandler)

Set the index settings. Please refer to our [API documentation](https://www.algolia.com/doc/swift#index-settings) for the list of supported settings.

Parameters:

settings - New settings.

completionHandler - Completion handler to be notified of the request's outcome.

Returns:

A cancellable operation.

setSettingsSync

public void setSettingsSync(@NonNull
                            JSONObject settings)
                     throws AlgoliaException

Set the index settings (synchronously). Please refer to our [API documentation](https://www.algolia.com/doc/swift#index-settings) for the list of supported settings.

Parameters:

settings - New settings.

Throws:

AlgoliaException

clearIndexAsync

public Request clearIndexAsync(CompletionHandler completionHandler)

Delete the index content without removing settings.

Parameters:

completionHandler - Completion handler to be notified of the request's outcome.

Returns:

A cancellable operation.

clearIndexSync

public void clearIndexSync()
                    throws AlgoliaException

Delete the index content without removing settings.

Throws:

AlgoliaException

commitAsync

public Request commitAsync(@NonNull
                           CompletionHandler completionHandler)

Commit the transaction. **Warning:** Cancelling the returned operation does **not** roll back the transaction. The operation is returned for lifetime management purposes only.

Parameters:

completionHandler - Completion handler to be notified of the transaction's outcome.

Returns:

A cancellable operation (see warning for important caveat).

commitSync

public void commitSync()
                throws AlgoliaException

Commit the transaction (synchronously).

Throws:

AlgoliaException

rollbackAsync

public Request rollbackAsync(CompletionHandler completionHandler)

Roll back the current write transaction. **Warning:** Cancelling the returned operation does **not** cancel the rollback. The operation is returned for lifetime management purposes only.

Parameters:

completionHandler - Completion handler to be notified of the transaction's outcome.

Returns:

A cancellable operation (see warning for important caveat).

rollbackSync

public void rollbackSync()

Rollback the transaction. The index will be left untouched.