GitHub

Operations

Sorted Set

Sorted Set is an easy to use NoSQL database that you can put your records in order.

  • You cannot add more than 25 keys in parallel.
  • You cannot get more than 100 keys in parallel.
  • You cannot remove more than 25 keys in parallel.
  • You cannot run more than 10 queries in parallel.
interface GetFromSortedSet {
    setName: string
    sortKey: string
}
interface RemoveFromSortedSet {
    setName: string
    sortKey: string
}
interface AddToSortedSet {
    setName: string
    sortKey: string
    data: Record<string, unknown>
}
interface QuerySortedSet {
    setName: string
    beginsWith?: string
    greaterOrEqual?: string
    lessOrEqual?: string
    reverse?: boolean
    nextToken?: string
    limit?: number
}


interface OperationResponse {
    success: boolean
    data?: any
    error?: string
}


async function addToSortedSet(input: AddToSortedSet): Promise<OperationResponse | undefined> {
    // ...
}
async function getFromSortedSet(input: GetFromSortedSet): Promise<OperationResponse | undefined> {
    // ...
}
async function removeFromSortedSet(input: RemoveFromSortedSet): Promise<OperationResponse | undefined> {
    // ...
}
async function querySortedSet(input: QuerySortedSet): Promise<OperationResponse | undefined> {
    // ...
}

Usage

import RDK from '@retter/rdk'


const rdk = new RDK()


await rdk.addToSortedSet({ setName: 'my-set', sortKey: 'my-sort-key', data: { key: 'value' } })
await rdk.getFromSortedSet({ setName: 'my-set', sortKey: 'my-sort-key' })
await rdk.querySortedSet({ setName: 'my-set', beginsWith: 'my', limit: 10 })
await rdk.removeFromSortedSet({ setName: 'my-set', sortKey: 'my-sort-key' })


await rdk.pipeline()
    .addToSortedSet({ setName: 'my-set', sortKey: 'my-sort-key', data: { key: 'value' } })
    .getFromSortedSet({ setName: 'my-set', sortKey: 'my-sort-key' })
    .querySortedSet({ setName: 'my-set', beginsWith: 'my', limit: 10 })
    .removeFromSortedSet({ setName: 'my-set', sortKey: 'my-sort-key' })
    .send()

API Reference

Add To Sorted Set Input

ParameterTypeRequiredDescription
setNamestringtrueSet's name
sortKeystringtrueSort key
dataRecord<string, any>trueData

Get From Sorted Set Input

ParameterTypeRequiredDescription
setNamestringtrueSet's name
sortKeystringtrueSort key

Remove From Sorted Set Input

ParameterTypeRequiredDescription
setNamestringtrueSet's name
sortKeystringtrueSort key

Query Sorted Set Input

ParameterTypeRequiredDescription
setNamestringtrueSet's name
beginsWithstringfalseComparison filter for sort key
greaterOrEqualstringfalseComparison filter for sort key
lessOrEqualstringfalseComparison filter for sort key
reversebooleanfalseFlag to decide whether to scan data backwards or not
nextTokenstringfalsePagination token
limitnumberfalseLimits the number of records in the result

Operation Output

ParameterTypeRequiredDescription
successbooleantrueReturns true if operation is successful
dataanyfalseSuccessful response
errorstringfalseReason of failure
Previous
Memory