Skip to content

Delete Values By Score Range

Description

This operation deletes all items with a score between the specified minimum and maximum boundaries.

Method

[[[Backendless.shared hive:(NSString *)hiveName] sortedSetStore:(NSString *)keyName] deleteValuesByScoreWithOptions:(SortedSetFilter *)options responseHandler:^(NSInteger)responseHandler errorHandler:^(Fault *)errorHandler];

Backendless.shared.hive(hiveName: String).sortedSetStore(keyName: String).deleteValuesByScore(options: SortedSetFilter, responseHandler: ((Int) -> Void)!, errorHandler: ((Fault) -> Void)!)

where:

Argument                Description
hiveName Name of a hive where the operation is performed. String value.
keyName Key name identifying a sorted-set. String value.
options Is the SortedSetFilter object, consisting of parameters that control the behavior of this operation. See the description below.

SortedSetFilter is an object with the following structure:

@interface SortedSetFilter : NSObject

@property (nonatomic) double minScore;
@property (nonatomic) double maxScore;
@property (nonatomic) enum SortedSetBound minBound;
@property (nonatomic) enum SortedSetBound maxBound;

@end

@objcMembers public class SortedSetFilter: NSObject {
    public var minScore = 0.0
    public var maxScore = 0.0
    public var minBound = SortedSetBound.include
    public var maxBound = SortedSetBound.include
}

where:

Argument                Description
minScore/maxScore Minimum and maximum value of the scores to identify the items to delete. To control whether the specified score values are included or excluded from the range, use the minBound/maxBound parameters.
minBound/maxBound Optional parameters. Available options are:
Include - Includes value specified in the corresponding minScore/maxScore parameter into the range.
Exclude - Excludes value specified in the corresponding minScore/maxScore parameter from the range.
Infinity - Ignores the corresponding minScore/maxScore parameter and includes all consecutive score values that come before/after the defined score range. For example, if minBound is set to Infinity and maxScore is set to 5, the query will include all values with scores less than 5.

Return Value

The number of deleted items.

Example

The example below deletes all values in score range from 1 to 20. The minBound parameter is Include, as a result the score of 1 is included in the range. The maxBound parameter is set to Exclude, as a result, the value of 20 is excluded from the range.

SortedSetFilter *options = [SortedSetFilter new];
options.minScore = 0;
options.maxScore = 20;
options.minBound = SortedSetBoundInclude;
options.maxBound = SortedSetBoundExclude;

[[[Backendless.shared hive:@"leaderboard"] sortedSetStore:@"players"] deleteValuesByScoreWithOptions:options responseHandler:^(NSInteger response) {
    // handle response
} errorHandler:^(Fault *fault) {
    // handle error
}];

let options = SortedSetFilter()
options.minScore = 0
options.maxScore = 20
options.minBound = .include
options.maxBound = .exclude

Backendless.shared.hive("leaderboard").sortedSetStore("players").deleteValuesByScore(options: options, responseHandler: { response in
    // handle response
}, errorHandler: { fault in
    // handle error
})

where:

Argument                Description
"leaderboard" Name of a hive where the operation is performed.
"players" Key name identifying a sorted set.

Codeless Reference

sorted_set_api_delete_values_by_score_range

where:

Argument                Description
hive name Name of a hive where the operation is performed.
key name Key name identifying a sorted set.
min/max score Minimum and maximum value of the scores to identify the items to delete. To control whether the specified score values are included or excluded from the range, use the min/max bound parameters.
min/max bound Parameters that control the presence of the first and last values in the range. Each parameter has three options:

Include - Includes value specified in the corresponding min score/max score parameter into the range.

Exclude - Excludes value specified in the corresponding min score/max score parameter from the range.

Infinity - Ignores the corresponding min score/max score parameter and includes all consecutive score values that come before/after the defined score range. For example, if min bound is set to Infinity and max score is set to 5, the query will include all values with scores less than 5.

These parameters default to Include.

Returns the number of deleted items.

Consider the following Sorted Set storage:
sorted_set_api_example_all_blocks

The example below deletes all values in score range from 0 to 5. Considering the sorted set (i.e. "players") presented above only two values are deleted since "Bobby" has the score of 3 and "John" has the score of 5; These two values fall into the specified score range.
sorted_set_api_example_delete_values_by_score_range

The sorted set will look as shown below after the Codeless logic runs.
sorted_set_api_example_delete_values_by_rank_range_2