Class MultiRangeBuilder

MultiRangeBuilder is a query builder that looks up multiple keys.

Hierarchy (View Summary)

RangeBuilder<{ [key: string]: string }>
- MultiRangeBuilder

Index

Constructors

Properties

callOptions namespace request

Constructors

constructor

new MultiRangeBuilder(kv: KVClient, namespace: NSApplicator): MultiRangeBuilder
Parameters
- kv: KVClient
- namespace: NSApplicator
Returns MultiRangeBuilder
Overrides RangeBuilder.constructor
- Defined in src/builder.ts:208

Properties

`Protected`callOptions

callOptions: CallOptions | undefined

`Protected` `Readonly`namespace

namespace: NSApplicator

`Protected`request

request: IRangeRequest = {}

Methods

all

all(): this
All will instruct etcd to get all keys.

Returns this
- Defined in src/builder.ts:237

buffers

buffers(): Promise<{ [key: string]: Buffer<ArrayBufferLike> }>
Runs the built request and returns the value of the returned key as a buffers.

Returns Promise<{ [key: string]: Buffer<ArrayBufferLike> }>
- Defined in src/builder.ts:315

catch

catch<R>(
onRejected: (err: any) => R | Promise<R>,
): Promise<{ [key: string]: string } | R>
catch implements Promiselike.catch()
Type Parameters
- R
Parameters
- onRejected: (err: any) => R | Promise<R>
Returns Promise<{ [key: string]: string } | R>
Inherited from RangeBuilder.catch
- Defined in src/util.ts:234

count

count(): Promise<number>
count returns the number of keys that match the query.

Returns Promise<number>
- Defined in src/builder.ts:263

`Protected`createPromise

createPromise(): Promise<{ [key: string]: string }>
Returns Promise<{ [key: string]: string }>
Overrides RangeBuilder.createPromise
- Defined in src/builder.ts:366

exec

exec(): Promise<IRangeResponse>
Runs the built request and returns the raw response from etcd.

Returns Promise<IRangeResponse>
- Defined in src/builder.ts:322

inRange

inRange(r: Rangable): this
inRange instructs the builder to get keys in the specified byte range.
Parameters
- r: Rangable
Returns this
- Defined in src/builder.ts:227

json

json(): Promise<{ [key: string]: unknown }>
Runs the built request and parses the returned keys as JSON.

Returns Promise<{ [key: string]: unknown }>
- Defined in src/builder.ts:291

keyBuffers

keyBuffers(): Promise<Buffer<ArrayBufferLike>[]>
Keys returns an array of keys matching the query, as buffers.

Returns Promise<Buffer<ArrayBufferLike>[]>
- Defined in src/builder.ts:281

keys

keys(encoding?: BufferEncoding): Promise<string[]>
Keys returns an array of keys matching the query.
Parameters
- encoding: BufferEncoding = 'utf8'
Returns Promise<string[]>
- Defined in src/builder.ts:271

limit

limit(count: number): this
Limit sets the maximum number of results to retrieve.
Parameters
- count: number
Returns this
- Defined in src/builder.ts:244

maxCreateRevision

maxCreateRevision(maxCreateRevision: string | number): this
maxCreateRevision sets the maximum create revision of keys to return.
Parameters
- maxCreateRevision: string | number
Returns this
Inherited from RangeBuilder.maxCreateRevision
- Defined in src/builder.ts:112

maxModRevision

maxModRevision(maxModRevision: string | number): this
maxModRevision sets the maximum modified revision of keys to return.
Parameters
- maxModRevision: string | number
Returns this
Inherited from RangeBuilder.maxModRevision
- Defined in src/builder.ts:96

minCreateRevision

minCreateRevision(minCreateRevision: string | number): this
minCreateRevision sets the minimum create revision of keys to return.
Parameters
- minCreateRevision: string | number
Returns this
Inherited from RangeBuilder.minCreateRevision
- Defined in src/builder.ts:104

minModRevision

minModRevision(minModRevision: string | number): this
minModRevision sets the minimum modified revision of keys to return.
Parameters
- minModRevision: string | number
Returns this
Inherited from RangeBuilder.minModRevision
- Defined in src/builder.ts:88

numbers

numbers(): Promise<{ [key: string]: number }>
Runs the built request and returns the values of keys as numbers. May resolve to NaN if the keys do not contain numbers.

Returns Promise<{ [key: string]: number }>
- Defined in src/builder.ts:307

op

op(): Promise<IRequestOp>
Returns the request op for this builder, used in transactions.

Returns Promise<IRequestOp>
Inherited from RangeBuilder.op
- Defined in src/builder.ts:128

options

options(options: CallOptions | undefined): this
Sets the GRPC call options for this request.
Parameters
- options: CallOptions | undefined
Returns this
Inherited from RangeBuilder.options
- Defined in src/builder.ts:120

prefix

prefix(value: string | Buffer<ArrayBufferLike>): this
Prefix instructs the query to scan for all keys that have the provided prefix.
Parameters
- value: string | Buffer<ArrayBufferLike>
Returns this
- Defined in src/builder.ts:220

revision

revision(rev: string | number): this
revision is the point-in-time of the key-value store to use for the range.
Parameters
- rev: string | number
Returns this
Inherited from RangeBuilder.revision
- Defined in src/builder.ts:72

serializable

serializable(serializable: boolean): this
serializable sets the range request to use serializable member-local reads.
Parameters
- serializable: boolean
Returns this
Inherited from RangeBuilder.serializable
- Defined in src/builder.ts:80

sort

sort(
target: "Key" | "Version" | "Create" | "Mod" | "Value",
order: "None" | "Ascend" | "Descend",
): this
Sort specifies how the result should be sorted.
Parameters
- target: "Key" | "Version" | "Create" | "Mod" | "Value"
- order: "None" | "Ascend" | "Descend"
Returns this
- Defined in src/builder.ts:252

stream

stream(): AsyncIterable<IRangeResponse>
Runs the built range request and yields each response chunk from the server. Chunks are not merged; header, more, and count are only meaningful on the final chunk.

Returns AsyncIterable<IRangeResponse>
- Defined in src/builder.ts:339

strings

strings(encoding?: BufferEncoding): Promise<{ [key: string]: string }>
Runs the built request and returns the value of the returned key as a string, or null if it isn't found.
Parameters
- encoding: BufferEncoding = 'utf8'
Returns Promise<{ [key: string]: string }>
- Defined in src/builder.ts:299

then

then<R, V>(
onFulfilled: (value: { [key: string]: string }) => R | Promise<R>,
onRejected?: (err: any) => V | Promise<V>,
): Promise<R | V>
then implements Promiselike.then()
Type Parameters
- R
- V
Parameters
- onFulfilled: (value: { [key: string]: string }) => R | Promise<R>
- OptionalonRejected: (err: any) => V | Promise<V>
Returns Promise<R | V>
Inherited from RangeBuilder.then
- Defined in src/util.ts:224