Delete Values With Max Score¶

Description¶

This operation retrieves and deletes items with the highest scores from the sorted set. You can specify the number of values to retrieve and delete.

Method¶

PUT

Endpoint URL¶

Important

Make sure to replace xxxx in the domain name in the request specification below to the one assigned to your application.

https://xxxx.backendless.app/api/hive/[hive-name]/sorted-set/[key]/get-with-max-score-and-delete?count=[howMany]

where:

Argument	Description
`[hive-name]`	Name of a hive where the operation is performed.
`[key]`	Key name identifying a sorted set.
`[howMany]`	Optional parameter, if not specified, defaults to 1. Number of items to retrieve and delete.

Request Headers¶

None.

Request Body¶

None.

Response Body¶

A JSON array containing deleted score-value pairs.

Example¶

The example below deletes two items with the highest score from the sorted set.

curl --location --request PUT "https://xxxx.backendless.app/api/hive/leaderboard/sorted-set/players/get-with-max-score-and-delete?count=2"

where:

Argument	Description
`leaderboard`	Name of a hive in the system.
`players`	Name of a sorted set to retrieve and delete score-value pairs from.

Codeless Reference¶

sorted_set_api_delete_values_with_max_score

where:

Argument	Description
`hive name`	Name of a hive where the operation is performed.
`key name`	Key name identifying a sorted set.
`count`	Specify the number of values to delete from the sorted set.

Returns a list of the deleted score-value pairs.

Consider the following Sorted Set storage:
sorted_set_api_example_all_blocks

The example below deletes one value with the maximum score from the "players" sorted set. Considering the sorted set presented above, the value "Julia" is deleted since it has the highest score.
sorted_set_api_example_delete_values_with_max_score

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