SortingParams

Builder Class for {@link Redis#sort(string, SortingParams) SORT} Parameters.

class SortingParams {

this();

SortingParams by(const(ubyte)[] pattern);

SortingParams nosort();

Collection!(const(ubyte)[]) getParams();

SortingParams desc();

SortingParams asc();

SortingParams limit(int start, int count);

SortingParams alpha();

SortingParams get(string[] patterns);

}

Constructors

this this(): Undocumented in source.

Members

Functions

alpha SortingParams alpha(): Sort lexicographicaly. Note that Redis is utf-8 aware assuming you set the right value for the LC_COLLATE environment variable. @return the SortingParams Object
asc SortingParams asc(): Get the Sorting in Ascending Order. This is the default order. @return the SortingParams Object
by SortingParams by(const(ubyte)[] pattern): Sort by weight in keys. Takes a pattern that is used in order to generate the key names of the weights used for sorting. Weight key names are obtained substituting the first occurrence of * with the actual value of the elements on the list. The pattern for a normal key/value pair is "field*" and for a value in a hash "field*->fieldname". @param pattern @return the SortingParams Object
desc SortingParams desc(): Get the Sorting in Descending Order. @return the sortingParams Object
get SortingParams get(string[] patterns): Retrieving external keys from the result of the search. Takes a pattern that is used in order to generate the key names of the result of sorting. The key names are obtained substituting the first occurrence of * with the actual value of the elements on the list. The pattern for a normal key/value pair is "field*" and for a value in a hash "field*->fieldname". To get the list itself use the char # as pattern. @param patterns @return the SortingParams Object
getParams Collection!(const(ubyte)[]) getParams(): Undocumented in source. Be warned that the author may not have intended to support it.
limit SortingParams limit(int start, int count): Limit the Numbers of returned Elements. @param start is zero based @param count @return the SortingParams Object
nosort SortingParams nosort(): No sorting. This is useful if you want to retrieve a external key (using {@link #get(string...) GET}) but you don't want the sorting overhead. @return the SortingParams Object

SortingParams

Constructors

Members

Functions

Meta

Source