org.onosproject.store.service

Interface DatabaseService

public interface DatabaseService

Service interface for a strongly consistent and durable key value data store.

Method Summary

Modifier and Type	Method and Description
BatchReadResult	batchRead(BatchReadRequest batchRequest) Performs a batch read operation and returns the results.
BatchWriteResult	batchWrite(BatchWriteRequest batchRequest) Performs a batch write operation and returns the results.
VersionedValue	get(String tableName, String key) Reads the specified key.
Map<String,VersionedValue>	getAll(String tableName) Reads the whole table.
VersionedValue	put(String tableName, String key, byte[] value) Associate the key with a value.
boolean	putIfAbsent(String tableName, String key, byte[] value) If the specified key is not already associated with a value, associate it with the given value.
boolean	putIfValueMatches(String tableName, String key, byte[] oldValue, byte[] newValue) Replaces the entry for a key only if currently mapped to a given value.
boolean	putIfVersionMatches(String tableName, String key, byte[] value, long version) Sets the key to the specified value if the version in the database (for that key) matches the specified version.
VersionedValue	remove(String tableName, String key) Removes the key (and associated value).
boolean	removeIfValueMatches(String tableName, String key, byte[] value) Removes the key (and associated value) if the value in the database matches specified value.
boolean	removeIfVersionMatches(String tableName, String key, long version) Removes the key (and associated value) if the version in the database matches specified version.

Method Detail

get

VersionedValue get(String tableName,
                   String key)

Reads the specified key.

Parameters:

tableName - name of the table associated with this operation.

key - key to read.

Returns:

value (and version) associated with this key. This calls returns null if the key does not exist.

getAll

Map<String,VersionedValue> getAll(String tableName)

Reads the whole table.

Parameters:

tableName - name of the table associated with this operation.

Returns:

the whole table

put

VersionedValue put(String tableName,
                   String key,
                   byte[] value)

Associate the key with a value.

Parameters:

tableName - table name in which this key/value resides.

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key.

putIfAbsent

boolean putIfAbsent(String tableName,
                    String key,
                    byte[] value)

If the specified key is not already associated with a value, associate it with the given value.

Parameters:

tableName - table name in which this key/value resides.

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

true if put was successful, false if there is already a value associated with this key

putIfVersionMatches

boolean putIfVersionMatches(String tableName,
                            String key,
                            byte[] value,
                            long version)

Sets the key to the specified value if the version in the database (for that key) matches the specified version.

Parameters:

tableName - name of table associated with this operation.

key - key

value - value

version - version that should present in the database for the put to be successful.

Returns:

true if put was successful, false if there version in database is different from what is specified.

putIfValueMatches

boolean putIfValueMatches(String tableName,
                          String key,
                          byte[] oldValue,
                          byte[] newValue)

Replaces the entry for a key only if currently mapped to a given value.

Parameters:

tableName - name of table associated with this operation.

key - with which the specified value is associated

oldValue - value expected to be associated with the specified key

newValue - value to be associated with the specified key

Returns:

true if put was successful, false if there version in database is different from what is specified.

remove

VersionedValue remove(String tableName,
                      String key)

Removes the key (and associated value).

Parameters:

tableName - name of table associated with this operation.

key - key to remove

Returns:

value previously associated with the key. This call returns null if the key does not exist.

removeIfVersionMatches

boolean removeIfVersionMatches(String tableName,
                               String key,
                               long version)

Removes the key (and associated value) if the version in the database matches specified version.

Parameters:

tableName - name of table associated with this operation.

key - key to remove

version - version that should present in the database for the remove to be successful.

Returns:

true if remove was successful, false if there version in database is different from what is specified.

removeIfValueMatches

boolean removeIfValueMatches(String tableName,
                             String key,
                             byte[] value)

Removes the key (and associated value) if the value in the database matches specified value.

Parameters:

tableName - name of table associated with this operation.

key - key to remove

value - value that should present in the database for the remove to be successful.

Returns:

true if remove was successful, false if there value in database is different from what is specified.

batchRead

BatchReadResult batchRead(BatchReadRequest batchRequest)

Performs a batch read operation and returns the results.

Parameters:

batchRequest - batch request.

Returns:

result of the batch operation.

batchWrite

BatchWriteResult batchWrite(BatchWriteRequest batchRequest)

Performs a batch write operation and returns the results. This method provides transactional semantics. Either all writes succeed or none do. Even a single write failure would cause the entire batch to be aborted. In the case of unsuccessful operation, the batch result can be inspected to determine which operation(s) caused the batch to fail.

Parameters:

batchRequest - batch request.

Returns:

result of the batch operation.