com.aerospike.client.large

Class LargeList

java.lang.Object

com.aerospike.client.large.LargeList

public class LargeList
extends Object

Create and manage a list within a single bin.

Constructor Summary

Constructors

Constructor and Description
LargeList(AerospikeClient client, WritePolicy policy, Key key, String binName) Initialize large list operator.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(List<?> values) Add values to the list.
void	add(Value... values) Add values to list.
void	add(Value value) Add value to list.
void	destroy() Delete bin containing the list.
List<Boolean>	exists(List<Value> keyValues) Do key values exist? Return list of results in one batch call.
boolean	exists(Value keyValue) Does key value exist?
List<?>	filter(String filterModule, String filterName, Value... filterArgs) Select values from list and apply specified Lua filter.
List<?>	find(Value value) Select values from list.
List<?>	findFirst(int count) Select values from the beginning of list up to a maximum count.
List<?>	findFirst(int count, String filterModule, String filterName, Value... filterArgs) Select values from the beginning of list up to a maximum count after applying lua filter.
List<?>	findFrom(Value begin, int count) Select values from the begin key up to a maximum count.
List<?>	findFrom(Value begin, int count, String filterModule, String filterName, Value... filterArgs) Select values from the begin key up to a maximum count after applying lua filter.
List<?>	findLast(int count) Select values from the end of list up to a maximum count.
List<?>	findLast(int count, String filterModule, String filterName, Value... filterArgs) Select values from the end of list up to a maximum count after applying lua filter.
List<?>	findThenFilter(Value value, String filterModule, String filterName, Value... filterArgs) Select values from list and apply specified Lua filter.
Map<?,?>	getConfig() Return map of list configuration parameters.
List<?>	range(Value begin, Value end) Select a range of values from the large list.
List<?>	range(Value begin, Value end, int count) Select a range of values from the large list.
List<?>	range(Value begin, Value end, int count, String filterModule, String filterName, Value... filterArgs) Select a range of values from the large list, then apply a lua filter.
List<?>	range(Value begin, Value end, String filterModule, String filterName, Value... filterArgs) Select a range of values from the large list, then apply a Lua filter.
void	remove(List<?> values) Delete values from list.
void	remove(Value value) Delete value from list.
int	remove(Value begin, Value end) Delete values from list between range.
List<?>	scan() Return all objects in the list.
void	setPageSize(int pageSize) Set LDT page size.
int	size() Return size of list.
void	update(List<?> values) Update/Add each value in values list depending if key exists or not.
void	update(Value... values) Update/Add each value in array depending if key exists or not.
void	update(Value value) Update value in list if key exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

LargeList

public LargeList(AerospikeClient client,
         WritePolicy policy,
         Key key,
         String binName)

Initialize large list operator.

Parameters:

client - client

policy - generic configuration parameters, pass in null for defaults

key - unique record identifier

binName - bin name

Method Detail

add

public void add(Value value)
         throws AerospikeException

Add value to list. Fail if value's key exists and list is configured for unique keys. If value is a map, the key is identified by "key" entry. Otherwise, the value is the key. If large list does not exist, create it.

Parameters:

value - value to add

Throws:

AerospikeException

add

public void add(Value... values)
         throws AerospikeException

Add values to list. Fail if a value's key exists and list is configured for unique keys. If value is a map, the key is identified by "key" entry. Otherwise, the value is the key. If large list does not exist, create it.

Parameters:

values - values to add

Throws:

AerospikeException

add

public void add(List<?> values)
         throws AerospikeException

Add values to the list. Fail if a value's key exists and list is configured for unique keys. If value is a map, the key is identified by "key" entry. Otherwise, the value is the key. If large list does not exist, create it.

Parameters:

values - values to add

Throws:

AerospikeException

update

public void update(Value value)
            throws AerospikeException

Update value in list if key exists. Add value to list if key does not exist. If value is a map, the key is identified by "key" entry. Otherwise, the value is the key. If large list does not exist, create it.

Parameters:

value - value to update

Throws:

AerospikeException

update

public void update(Value... values)
            throws AerospikeException

Update/Add each value in array depending if key exists or not. If value is a map, the key is identified by "key" entry. Otherwise, the value is the key. If large list does not exist, create it.

Parameters:

values - values to update

Throws:

AerospikeException

update

public void update(List<?> values)
            throws AerospikeException

Update/Add each value in values list depending if key exists or not. If value is a map, the key is identified by "key" entry. Otherwise, the value is the key. If large list does not exist, create it.

Parameters:

values - values to update

Throws:

AerospikeException

remove

public void remove(Value value)
            throws AerospikeException

Delete value from list.

Parameters:

value - value to delete

Throws:

AerospikeException

remove

public void remove(List<?> values)
            throws AerospikeException

Delete values from list.

Parameters:

values - values to delete

Throws:

AerospikeException

remove

public int remove(Value begin,
         Value end)
           throws AerospikeException

Delete values from list between range.

Parameters:

begin - low value of the range (inclusive)

end - high value of the range (inclusive)

Returns:

count of entries removed

Throws:

AerospikeException

exists

public boolean exists(Value keyValue)
               throws AerospikeException

Does key value exist?

Parameters:

keyValue - key value to lookup

Throws:

AerospikeException

exists

public List<Boolean> exists(List<Value> keyValues)
                     throws AerospikeException

Do key values exist? Return list of results in one batch call.

Parameters:

keyValues - key values to lookup

Throws:

AerospikeException

find

public List<?> find(Value value)
             throws AerospikeException

Select values from list.

Parameters:

value - value to select

Returns:

list of entries selected

Throws:

AerospikeException

findThenFilter

public List<?> findThenFilter(Value value,
                     String filterModule,
                     String filterName,
                     Value... filterArgs)
                       throws AerospikeException

Select values from list and apply specified Lua filter.

Parameters:

value - value to select

filterModule - Lua module name which contains filter function

filterName - Lua function name which applies filter to returned list

filterArgs - arguments to Lua function name

Returns:

list of entries selected

Throws:

AerospikeException

findFirst

public List<?> findFirst(int count)
                  throws AerospikeException

Select values from the beginning of list up to a maximum count. Supported by server versions >= 3.5.8.

Parameters:

count - maximum number of values to return

Returns:

list of entries selected

Throws:

AerospikeException

findFirst

public List<?> findFirst(int count,
                String filterModule,
                String filterName,
                Value... filterArgs)
                  throws AerospikeException

Select values from the beginning of list up to a maximum count after applying lua filter. Supported by server versions >= 3.5.8.

Parameters:

count - maximum number of values to return after applying lua filter

filterModule - Lua module name which contains filter function

filterName - Lua function name which applies filter to returned list

filterArgs - arguments to Lua function name

Returns:

list of entries selected

Throws:

AerospikeException

findLast

public List<?> findLast(int count)
                 throws AerospikeException

Select values from the end of list up to a maximum count. Supported by server versions >= 3.5.8.

Parameters:

count - maximum number of values to return

Returns:

list of entries selected in reverse order

Throws:

AerospikeException

findLast

public List<?> findLast(int count,
               String filterModule,
               String filterName,
               Value... filterArgs)
                 throws AerospikeException

Select values from the end of list up to a maximum count after applying lua filter. Supported by server versions >= 3.5.8.

Parameters:

count - maximum number of values to return after applying lua filter

filterModule - Lua module name which contains filter function

filterName - Lua function name which applies filter to returned list

filterArgs - arguments to Lua function name

Returns:

list of entries selected in reverse order

Throws:

AerospikeException

findFrom

public List<?> findFrom(Value begin,
               int count)
                 throws AerospikeException

Select values from the begin key up to a maximum count. Supported by server versions >= 3.5.8.

Parameters:

begin - start value (inclusive)

count - maximum number of values to return

Returns:

list of entries selected

Throws:

AerospikeException

findFrom

public List<?> findFrom(Value begin,
               int count,
               String filterModule,
               String filterName,
               Value... filterArgs)
                 throws AerospikeException

Select values from the begin key up to a maximum count after applying lua filter. Supported by server versions >= 3.5.8.

Parameters:

begin - start value (inclusive)

count - maximum number of values to return after applying lua filter

filterModule - Lua module name which contains filter function

filterName - Lua function name which applies filter to returned list

filterArgs - arguments to Lua function name

Returns:

list of entries selected in reverse order

Throws:

AerospikeException

range

public List<?> range(Value begin,
            Value end)
              throws AerospikeException

Select a range of values from the large list.

Parameters:

begin - low value of the range (inclusive)

end - high value of the range (inclusive)

Returns:

list of entries selected

Throws:

AerospikeException

range

public List<?> range(Value begin,
            Value end,
            int count)
              throws AerospikeException

Select a range of values from the large list. Supported by server versions >= 3.5.8.

Parameters:

begin - low value of the range (inclusive)

end - high value of the range (inclusive)

count - maximum number of values to return, pass in zero to obtain all values within range

Returns:

list of entries selected

Throws:

AerospikeException

range

public List<?> range(Value begin,
            Value end,
            String filterModule,
            String filterName,
            Value... filterArgs)
              throws AerospikeException

Select a range of values from the large list, then apply a Lua filter.

Parameters:

begin - low value of the range (inclusive)

end - high value of the range (inclusive)

filterModule - Lua module name which contains filter function

filterName - Lua function name which applies filter to returned list

filterArgs - arguments to Lua function name

Returns:

list of entries selected

Throws:

AerospikeException

range

public List<?> range(Value begin,
            Value end,
            int count,
            String filterModule,
            String filterName,
            Value... filterArgs)
              throws AerospikeException

Select a range of values from the large list, then apply a lua filter. Supported by server versions >= 3.5.8.

Parameters:

begin - low value of the range (inclusive)

end - high value of the range (inclusive)

count - maximum number of values to return after applying lua filter. Pass in zero to obtain all values within range.

filterModule - lua module name which contains filter function

filterName - lua function name which applies filter to returned list

filterArgs - arguments to lua function name

Returns:

list of entries selected

Throws:

AerospikeException

scan

public List<?> scan()
             throws AerospikeException

Return all objects in the list.

Throws:

AerospikeException

filter

public List<?> filter(String filterModule,
             String filterName,
             Value... filterArgs)
               throws AerospikeException

Select values from list and apply specified Lua filter.

Parameters:

filterModule - Lua module name which contains filter function

filterName - Lua function name which applies filter to returned list

filterArgs - arguments to Lua function name

Returns:

list of entries selected

Throws:

AerospikeException

destroy

public void destroy()
             throws AerospikeException

Delete bin containing the list.

Throws:

AerospikeException

size

public int size()
         throws AerospikeException

Return size of list.

Throws:

AerospikeException

getConfig

public Map<?,?> getConfig()
                   throws AerospikeException

Return map of list configuration parameters.

Throws:

AerospikeException

setPageSize

public void setPageSize(int pageSize)
                 throws AerospikeException

Set LDT page size. Supported by server versions >= 3.5.8.

Parameters:

pageSize - page size in bytes

Throws:

AerospikeException