com.spikeify.Spikeify Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Show all versions of core Show documentation
Simple ORM for Aerospike
package com.spikeify;
import com.aerospike.client.IAerospikeClient;
import com.aerospike.client.Key;
import com.aerospike.client.Record;
import com.spikeify.commands.*;
import java.util.Map;
/**
* This is the main class of Spikeify. All command chains start from this class.
*/
@SuppressWarnings("SameParameterValue")
public interface Spikeify {
/**
* Starts a command chain for info commands.
*
* @return the command chain
*/
InfoFetcher info();
/**
* @return configured namespace
*/
String getNamespace();
/**
* @return configured client
*/
IAerospikeClient getClient();
/**
* Starts a command chain for loading a single record.
*
* @param type
* @param type The class to map resulting record to.
* @return the command chain
*/
SingleLoader get(Class type);
/**
* Starts a command chain for loading multiple records.
*
* @param type
* @param type The class to map resulting records to.
* @param keys {@link Key}(s) to load from DB.
* @return the command chain
*/
MultiLoader getAll(Class type, Key... keys);
/**
* Starts a command chain for loading multiple records.
*
* @param type
* @param type The class to map resulting records to.
* @param userKeys User key(s) of the records to load.
* @return the command chain
*/
MultiLoader getAll(Class type, Long... userKeys);
/**
* Starts a command chain for loading multiple records.
*
* @param type
* @param type The class to map resulting records to.
* @param userKeys User key(s) of the records to load.
* @return the command chain
*/
MultiLoader getAll(Class type, String... userKeys);
/**
* @param type
* @param type entity type
* @return list of all entities
*/
ScanLoader scanAll(Class type);
/**
* Starts a command chain for creating a single record. This command fails if the records is already present in the DB.
*
* @param type
* @param key A {@link Key} of the record to create.
* @param entity The Java object to be mapped to the created record.
* @return the command chain
*/
SingleKeyUpdater create(Key key, T entity);
/**
* Starts a command chain for creating a single record. This command fails if the record already exists in the DB.
*
* @param type
* @param userKey A user key of the record to create.
* @param entity The Java object to be mapped to the created record.
* @return the command chain
*/
SingleKeyUpdater create(Long userKey, T entity);
/**
* Starts a command chain for creating a single record. This command fails if the record already exists in the DB.
*
* @param type
* @param userKey A user key of the record to create.
* @param entity The Java object to be mapped to the created record.
* @return the command chain
*/
SingleKeyUpdater create(String userKey, T entity);
/**
* Starts a command chain for creating a single record. This command fails if the record already exists in the DB.
*
* @param type
* @param entity The Java object to be mapped to the created record. The Class must contain @UserKey annotation.
* @return the command chain
*/
SingleObjectUpdater create(T entity);
/**
* Starts a command chain for creating multiple records. This command fails if any record already exists in the DB.
*
* @param keys An array of {@link Key} of the records to create.
* @param objects Java objects to be mapped to the created records.
* @return the command chain
*/
MultiKeyUpdater createAll(Key[] keys, Object[] objects);
/**
* Starts a command chain for creating multiple records. This command fails if any record already exists in the DB.
*
* @param userKeys An array of user keys of the records to create.
* @param objects Java objects to be mapped to the created records.
* @return the command chain
*/
MultiKeyUpdater createAll(Long[] userKeys, Object[] objects);
/**
* Starts a command chain for creating multiple records. This command fails if any record already exists in the DB.
*
* @param userKeys An array of user keys of the records to create.
* @param objects Java objects to be mapped to the created records.
* @return the command chain
*/
MultiKeyUpdater createAll(String[] userKeys, Object[] objects);
/**
* Starts a command chain for creating multiple records. This command fails if any record already exists in the DB.
*
* @param entity Java object(s) to be mapped to the created records. The Classes of objects must contain @UserKey annotation.
* @return the command chain
*/
MultiObjectUpdater createAll(Object... entity);
/**
* Starts a command chain for creating or updating a single record.
*
* @param type
* @param object The Java object to be mapped to the created record. The Class must contain @UserKey annotation.
* @return the command chain
*/
SingleObjectUpdater update(T object);
/**
* Starts a command chain for creating or updating a single record.
*
* @param type
* @param key A {@link Key} of the record to create or update.
* @param entity The Java object to be mapped to the created record.
* @return the command chain
*/
SingleKeyUpdater update(Key key, T entity);
/**
* Starts a command chain for creating or updating a single record.
*
* @param type
* @param key A user key of the record to create or update.
* @param entity The Java object to be mapped to the created record.
* @return the command chain
*/
SingleKeyUpdater update(Long key, T entity);
/**
* Starts a command chain for creating or updating a single record.
*
* @param type
* @param key A user key of the record to create or update.
* @param entity The Java object to be mapped to the created record.
* @return the command chain
*/
SingleKeyUpdater update(String key, T entity);
/**
* Starts a command chain for creating or updating multiple records.
*
* @param object Java object(s) to be mapped to the created records. The Classes of objects must contain @UserKey annotation.
* @return the command chain
*/
MultiObjectUpdater updateAll(Object... object);
/**
* Starts a command chain for creating or updating multiple records.
*
* @param keys An array of record keys of the records to create.
* @param objects Java objects to be mapped to the created records.
* @return the command chain
*/
MultiKeyUpdater updateAll(Key[] keys, Object[] objects);
/**
* Starts a command chain for creating or updating multiple records.
*
* @param userkeys An array of record keys of the records to create.
* @param objects Java objects to be mapped to the created records.
* @return the command chain
*/
MultiKeyUpdater updateAll(Long[] userkeys, Object[] objects);
/**
* Starts a command chain for creating or updating multiple records.
*
* @param userkeys An array of record keys of the records to create.
* @param objects Java objects to be mapped to the created records.
* @return the command chain
*/
MultiKeyUpdater updateAll(String[] userkeys, Object[] objects);
/**
* Starts a command chain for deleting a single record.
*
* @param object The Java object representing a record to be deleted. The Class must contain @UserKey annotation.
* @return the command chain
*/
SingleObjectDeleter delete(Object object);
/**
* Starts a command chain for deleting a single record.
*
* @param key A {@link Key} of the record to delete.
* @return the command chain
*/
SingleKeyDeleter delete(Key key);
/**
* Starts a command chain for deleting a single record.
*
* @param userKey A user key of the record to delete.
* @return the command chain
*/
SingleKeyDeleter delete(Long userKey);
/**
* Starts a command chain for deleting a single record.
*
* @param userKey A user key of the record to delete.
* @return the command chain
*/
SingleKeyDeleter delete(String userKey);
/**
* Starts a command chain for deleting multiple record.
*
* @param type
* @param object Java object(s) representing record(s) to be deleted. The Classes must contain @UserKey annotation.
* @return the command chain
*/
MultiObjectDeleter deleteAll(T... object);
/**
* Starts a command chain for deleting multiple record.
*
* @param keys {@link Key}(s) of the record(s) to delete.
* @return the command chain
*/
MultiKeyDeleter deleteAll(Key... keys);
/**
* Starts a command chain for deleting multiple record.
*
* @param userKeys User key(s) of the record(s) to delete.
* @return the command chain
*/
MultiKeyDeleter deleteAll(Long... userKeys);
/**
* Starts a command chain for deleting multiple record.
*
* @param userKeys User key(s) of the record(s) to delete.
* @return the command chain
*/
MultiKeyDeleter deleteAll(String... userKeys);
/**
* Starts a command chain for deleting multiple record.
*
* @param type
* @param type The class to map resulting record to.
* @param userKeys User key(s) of the record(s) to delete.
* @return the command chain
*/
MultiKeyDeleter deleteAll(Class type, Key... userKeys);
/**
* Starts a command chain for deleting multiple record.
*
* @param type
* @param type The class to map resulting record to.
* @param userKeys User key(s) of the record(s) to delete.
* @return the command chain
*/
MultiKeyDeleter deleteAll(Class type, Long... userKeys);
/**
* Starts a command chain for deleting multiple record.
*
* @param type
* @param type The class to map resulting record to.
* @param userKeys User key(s) of the record(s) to delete.
* @return the command chain
*/
MultiKeyDeleter deleteAll(Class type, String... userKeys);
/**
* Starts a command chain to start a query.
*
* @param type
* @param type The type (set name) of the records to query for.
* @return the command chain
*/
Scanner query(Class type);
/**
* Starts a command chain to execute a series of atomic commands on a single Record.
*
* @param type
* @param type The mapped class, used to derive namespace and setName.
* @return generated command
*/
SingleKeyCommander command(Class type);
/**
* Chechs if a record with given key exists in the DB.
*
* @param key Key of the record to check existence of.
* @return True if record exists, false otherwise
*/
boolean exists(Key key);
/**
* Checks if records for given keys exist in the DB.
*
* @param key Keys of the records to check existence of.
* @return Array of booleans
*/
Map exist(Key... key);
/**
* Chechs if a record with given key exists in the DB.
*
* @param type The mapped class, used to derive namespace and setName.
* @param id ID of the record to check existence of.
* @return True if record exists, false otherwise
*/
boolean exists(Class type, String id);
/**
* Checks if records for given keys exist in the DB.
*
* @param type The mapped class, used to derive namespace and setName.
* @param ids IDs of the records to check existence of.
* @return Array of booleans representing if records exist
*/
Map exist(Class type, String... ids);
/**
* Chechs if a record with given key exists in the DB.
*
* @param type The mapped class, used to derive namespace and setName.
* @param id ID of the record to check existence of.
* @return True if record exists, false otherwise
*/
boolean exists(Class type, Long id);
/**
* Checks if records for given keys exist in the DB.
*
* @param type The mapped class, used to derive namespace and setName.
* @param ids IDs of the records to check existence of.
* @return Array of booleans representing if records exist
*/
Map exist(Class type, Long... ids);
/**
* A helper method that directly maps Record to Java object.
* @param type
* @param type A Class to map to.
* @param key Key used to get the Record from DB.
* @param record A Record to be mapped.
* @return Instance of a 'type' with fields mapped to Record bins.
*/
T map(Class type, Key key, Record record);
/**
* A helper method that gets the Key of the Record that the annotated object maps to.
* @param type
* @param object An annotated object containing at least @UserKey annotation.
* @return Key of the Record that given object maps to.
*/
Key key(T object);
/**
* Delete all records with given SetName.
*
* @param namespace The namespace of the records to delete.
* @param setName The SetName of the records to delete.
*/
void truncateSet(String namespace, String setName);
/**
* Deletes all records with given Namespace and SetName.
*
* @param type The Class of the records to delete. Must contain a @SetName on class definition.
*/
void truncateSet(Class type);
/**
* Deletes all records within given namespace.
*
* @param namespace The namespace of the records to delete.
*/
void truncateNamespace(String namespace);
/**
* Drops all indexes within given namespace.
*
* @param namespace The namespace where to drop indexes.
*/
void dropIndexesInNamespace(String namespace);
/**
* Drops all indexes within given set.
*
* @param namespace The namespace where to drop indexes.
* @param setName The setName where to drop indexes.
*/
void dropIndexesInNamespace(String namespace, String setName);
/**
* A lightweight "transaction" helper that builds upon the Aerospike's record versioning functionality.
* Within a unit of work you can execute a number of get and update operations.
* If the version of the record for any update operation mismatches, this update operation is aborted and the whole unit of work is retried.
* Note: this are NOT true (serialized) transactions, because:
*
* - Does not take into account the read records that changed during transaction.
* - Aborts the transaction on ANY mismatched update operation, but does not rollback update operations that happened beforehand.
*
* Best practice: make a series of read operations and then only one update operation.
* @param type
* @param retries Number of retries of transaction operation. A sensible number would be 5.
* @param work An IDEMPOTENT unit of work (series of DB operations) that will be transactionally executed.
* In case of failure, the whole set of operations will be executed again,
* hence the need fot this set of operations to be IDEMPOTENT.
* @return R The result of the work performed by Work.run() method.
*/
@SuppressWarnings("UnusedReturnValue")
R transact(int retries, Work work);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy