-
Notifications
You must be signed in to change notification settings - Fork 52
/
GlideClusterClient.ts
1554 lines (1485 loc) · 57.3 KB
/
GlideClusterClient.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
*/
import { ClusterScanCursor, Script } from "glide-rs";
import * as net from "net";
import {
BaseClient,
BaseClientConfiguration,
Decoder,
DecoderOption,
GlideRecord,
GlideReturnType,
GlideString,
PubSubMsg,
convertGlideRecordToRecord,
} from "./BaseClient";
import {
FlushMode,
FunctionListOptions,
FunctionListResponse,
FunctionRestorePolicy,
FunctionStatsSingleResponse,
InfoOptions,
LolwutOptions,
ScanOptions,
createClientGetName,
createClientId,
createConfigGet,
createConfigResetStat,
createConfigRewrite,
createConfigSet,
createCopy,
createCustomCommand,
createDBSize,
createEcho,
createFCall,
createFCallReadOnly,
createFlushAll,
createFlushDB,
createFunctionDelete,
createFunctionDump,
createFunctionFlush,
createFunctionKill,
createFunctionList,
createFunctionLoad,
createFunctionRestore,
createFunctionStats,
createInfo,
createLastSave,
createLolwut,
createPing,
createPubSubShardNumSub,
createPublish,
createPubsubShardChannels,
createRandomKey,
createScriptExists,
createScriptFlush,
createScriptKill,
createTime,
createUnWatch,
} from "./Commands";
import { command_request, connection_request } from "./ProtobufMessage";
import { ClusterTransaction } from "./Transaction";
/** An extension to command option types with {@link Routes}. */
export interface RouteOption {
/**
* Specifies the routing configuration for the command.
* The client will route the command to the nodes defined by `route`.
*/
route?: Routes;
}
/**
* Represents a manually configured interval for periodic checks.
*/
export interface PeriodicChecksManualInterval {
/**
* The duration in seconds for the interval between periodic checks.
*/
duration_in_sec: number;
}
/**
* Periodic checks configuration.
*/
export type PeriodicChecks =
/**
* Enables the periodic checks with the default configurations.
*/
| "enabledDefaultConfigs"
/**
* Disables the periodic checks.
*/
| "disabled"
/**
* Manually configured interval for periodic checks.
*/
| PeriodicChecksManualInterval;
/* eslint-disable-next-line @typescript-eslint/no-namespace */
export namespace GlideClusterClientConfiguration {
/**
* Enum representing pubsub subscription modes.
* @see {@link https://valkey.io/docs/topics/pubsub/|Valkey PubSub Documentation} for more details.
*/
export enum PubSubChannelModes {
/**
* Use exact channel names.
*/
Exact = 0,
/**
* Use channel name patterns.
*/
Pattern = 1,
/**
* Use sharded pubsub. Available since Valkey version 7.0.
*/
Sharded = 2,
}
export interface PubSubSubscriptions {
/**
* Channels and patterns by modes.
*/
channelsAndPatterns: Partial<Record<PubSubChannelModes, Set<string>>>;
/**
* Optional callback to accept the incoming messages.
*/
/* eslint-disable-next-line @typescript-eslint/no-explicit-any */
callback?: (msg: PubSubMsg, context: any) => void;
/**
* Arbitrary context to pass to the callback.
*/
/* eslint-disable-next-line @typescript-eslint/no-explicit-any */
context?: any;
}
}
export type GlideClusterClientConfiguration = BaseClientConfiguration & {
/**
* Configure the periodic topology checks.
* These checks evaluate changes in the cluster's topology, triggering a slot refresh when detected.
* Periodic checks ensure a quick and efficient process by querying a limited number of nodes.
* If not set, `enabledDefaultConfigs` will be used.
*/
periodicChecks?: PeriodicChecks;
/**
* PubSub subscriptions to be used for the client.
* Will be applied via SUBSCRIBE/PSUBSCRIBE/SSUBSCRIBE commands during connection establishment.
*/
pubsubSubscriptions?: GlideClusterClientConfiguration.PubSubSubscriptions;
};
/**
* If the command's routing is to one node we will get T as a response type,
* otherwise, we will get a dictionary of address: nodeResponse, address is of type string and nodeResponse is of type T.
*/
export type ClusterResponse<T> = T | Record<string, T>;
/**
* @internal
* Type which returns GLIDE core for commands routed to multiple nodes.
* Should be converted to {@link ClusterResponse}.
*/
type ClusterGlideRecord<T> = GlideRecord<T> | T;
/**
* @internal
* Convert {@link ClusterGlideRecord} to {@link ClusterResponse}.
*
* @param res - Value received from Glide core.
* @param isRoutedToSingleNodeByDefault - Default routing policy.
* @param route - The route.
* @returns Converted value.
*/
function convertClusterGlideRecord<T>(
res: ClusterGlideRecord<T>,
isRoutedToSingleNodeByDefault: boolean,
route?: Routes,
): ClusterResponse<T> {
const isSingleNodeResponse =
// route not given and command is routed by default to a random node
(!route && isRoutedToSingleNodeByDefault) ||
// or route is given and it is a single node route
(Boolean(route) && route !== "allPrimaries" && route !== "allNodes");
return isSingleNodeResponse
? (res as T)
: convertGlideRecordToRecord(res as GlideRecord<T>);
}
export interface SlotIdTypes {
/**
* `replicaSlotId` overrides the `readFrom` configuration. If it's used the request
* will be routed to a replica, even if the strategy is `alwaysFromPrimary`.
*/
type: "primarySlotId" | "replicaSlotId";
/**
* Slot number. There are 16384 slots in a Valkey cluster, and each shard manages a slot range.
* Unless the slot is known, it's better to route using `SlotKeyTypes`
*/
id: number;
}
export interface SlotKeyTypes {
/**
* `replicaSlotKey` overrides the `readFrom` configuration. If it's used the request
* will be routed to a replica, even if the strategy is `alwaysFromPrimary`.
*/
type: "primarySlotKey" | "replicaSlotKey";
/**
* The request will be sent to nodes managing this key.
*/
key: string;
}
/// Route command to specific node.
export interface RouteByAddress {
type: "routeByAddress";
/**
*The endpoint of the node. If `port` is not provided, should be in the `${address}:${port}` format, where `address` is the preferred endpoint as shown in the output of the `CLUSTER SLOTS` command.
*/
host: string;
/**
* The port to access on the node. If port is not provided, `host` is assumed to be in the format `${address}:${port}`.
*/
port?: number;
}
export type Routes =
| SingleNodeRoute
/**
* Route request to all primary nodes.
*/
| "allPrimaries"
/**
* Route request to all nodes.
*/
| "allNodes";
export type SingleNodeRoute =
/**
* Route request to a random node.
*/
| "randomNode"
/**
* Route request to the node that contains the slot with the given id.
*/
| SlotIdTypes
/**
* Route request to the node that contains the slot that the given key matches.
*/
| SlotKeyTypes
| RouteByAddress;
/**
* Client used for connection to cluster servers.
*
* @see For full documentation refer to {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#cluster|Valkey Glide Wiki}.
*/
export class GlideClusterClient extends BaseClient {
/**
* @internal
*/
protected createClientRequest(
options: GlideClusterClientConfiguration,
): connection_request.IConnectionRequest {
const configuration = super.createClientRequest(options);
configuration.clusterModeEnabled = true;
// "enabledDefaultConfigs" is the default configuration and doesn't need setting
if (
options.periodicChecks !== undefined &&
options.periodicChecks !== "enabledDefaultConfigs"
) {
if (options.periodicChecks === "disabled") {
configuration.periodicChecksDisabled =
connection_request.PeriodicChecksDisabled.create();
} else {
configuration.periodicChecksManualInterval =
connection_request.PeriodicChecksManualInterval.create({
durationInSec: options.periodicChecks.duration_in_sec,
});
}
}
this.configurePubsub(options, configuration);
return configuration;
}
public static async createClient(
options: GlideClusterClientConfiguration,
): Promise<GlideClusterClient> {
return await super.createClientInternal(
options,
(socket: net.Socket, options?: GlideClusterClientConfiguration) =>
new GlideClusterClient(socket, options),
);
}
static async __createClient(
options: BaseClientConfiguration,
connectedSocket: net.Socket,
): Promise<GlideClusterClient> {
return super.__createClientInternal(
options,
connectedSocket,
(socket, options) => new GlideClusterClient(socket, options),
);
}
/**
* @internal
*/
protected scanOptionsToProto(
cursor: string,
options?: ScanOptions,
): command_request.ClusterScan {
const command = command_request.ClusterScan.create();
command.cursor = cursor;
if (options?.match) {
command.matchPattern = Buffer.from(options.match);
}
if (options?.count) {
command.count = options.count;
}
if (options?.type) {
command.objectType = options.type;
}
return command;
}
/**
* @internal
*/
protected createClusterScanPromise(
cursor: ClusterScanCursor,
options?: ScanOptions & DecoderOption,
): Promise<[ClusterScanCursor, GlideString[]]> {
// separate decoder option from scan options
const { decoder, ...scanOptions } = options || {};
const cursorId = cursor.getCursor();
const command = this.scanOptionsToProto(cursorId, scanOptions);
return this.createWritePromise(command, { decoder });
}
/**
* Incrementally iterates over the keys in the Cluster.
*
* This command is similar to the `SCAN` command but designed for Cluster environments.
* It uses a {@link ClusterScanCursor} object to manage iterations.
*
* For each iteration, use the new cursor object to continue the scan.
* Using the same cursor object for multiple iterations may result in unexpected behavior.
*
* For more information about the Cluster Scan implementation, see
* {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#cluster-scan | Cluster Scan}.
*
* This method can iterate over all keys in the database from the start of the scan until it ends.
* The same key may be returned in multiple scan iterations.
* The API does not accept `route` as it go through all slots in the cluster.
*
* @see {@link https://valkey.io/commands/scan/ | valkey.io} for more details.
*
* @param cursor - The cursor object that wraps the scan state.
* To start a new scan, create a new empty `ClusterScanCursor` using {@link ClusterScanCursor}.
* @param options - (Optional) The scan options, see {@link ScanOptions} and {@link DecoderOption}.
* @returns A Promise resolving to an array containing the next cursor and an array of keys,
* formatted as [`ClusterScanCursor`, `string[]`].
*
* @example
* ```typescript
* // Iterate over all keys in the cluster
* await client.mset([{key: "key1", value: "value1"}, {key: "key2", value: "value2"}, {key: "key3", value: "value3"}]);
* let cursor = new ClusterScanCursor();
* const allKeys: GlideString[] = [];
* let keys: GlideString[] = [];
* while (!cursor.isFinished()) {
* [cursor, keys] = await client.scan(cursor, { count: 10 });
* allKeys.push(...keys);
* }
* console.log(allKeys); // ["key1", "key2", "key3"]
*
* // Iterate over keys matching a pattern
* await client.mset([{key: "key1", value: "value1"}, {key: "key2", value: "value2"}, {key: "notMykey", value: "value3"}, {key: "somethingElse", value: "value4"}]);
* let cursor = new ClusterScanCursor();
* const matchedKeys: GlideString[] = [];
* while (!cursor.isFinished()) {
* const [cursor, keys] = await client.scan(cursor, { match: "*key*", count: 10 });
* matchedKeys.push(...keys);
* }
* console.log(matchedKeys); // ["key1", "key2", "notMykey"]
*
* // Iterate over keys of a specific type
* await client.mset([{key: "key1", value: "value1"}, {key: "key2", value: "value2"}, {key: "key3", value: "value3"}]);
* await client.sadd("thisIsASet", ["value4"]);
* let cursor = new ClusterScanCursor();
* const stringKeys: GlideString[] = [];
* while (!cursor.isFinished()) {
* const [cursor, keys] = await client.scan(cursor, { type: object.STRING });
* stringKeys.push(...keys);
* }
* console.log(stringKeys); // ["key1", "key2", "key3"]
* ```
*/
public async scan(
cursor: ClusterScanCursor,
options?: ScanOptions & DecoderOption,
): Promise<[ClusterScanCursor, GlideString[]]> {
return this.createClusterScanPromise(cursor, options);
}
/** Executes a single command, without checking inputs. Every part of the command, including subcommands,
* should be added as a separate value in args.
* The command will be routed automatically based on the passed command's default request policy, unless `route` is provided,
* in which case the client will route the command to the nodes defined by `route`.
*
* Note: An error will occur if the string decoder is used with commands that return only bytes as a response.
*
* @see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#custom-command|Glide for Valkey Wiki} for details on the restrictions and limitations of the custom command API.
*
* @param args - A list including the command name and arguments for the custom command.
* @param options - (Optional) See {@link RouteOption} and {@link DecoderOption}
* @returns The executed custom command return value.
*
* @example
* ```typescript
* // Example usage of customCommand method to retrieve pub/sub clients with routing to all primary nodes
* const result = await client.customCommand(["CLIENT", "LIST", "TYPE", "PUBSUB"], {route: "allPrimaries", decoder: Decoder.String});
* console.log(result); // Output: Returns a list of all pub/sub clients
* ```
*/
public async customCommand(
args: GlideString[],
options?: RouteOption & DecoderOption,
): Promise<ClusterResponse<GlideReturnType>> {
const command = createCustomCommand(args);
return super.createWritePromise(command, options);
}
/**
* Execute a transaction by processing the queued commands.
*
* @see {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#transaction|Valkey Glide Wiki} for details on Valkey Transactions.
*
* @param transaction - A {@link ClusterTransaction} object containing a list of commands to be executed.
*
* @param options - (Optional) Additional parameters:
* - (Optional) `route`: If `route` is not provided, the transaction will be routed to the slot owner of the first key found in the transaction.
* If no key is found, the command will be sent to a random node.
* If `route` is provided, the client will route the command to the nodes defined by `route`.
* - (Optional) `decoder`: See {@link DecoderOption}.
* @returns A list of results corresponding to the execution of each command in the transaction.
* If a command returns a value, it will be included in the list. If a command doesn't return a value,
* the list entry will be `null`.
* If the transaction failed due to a `WATCH` command, `exec` will return `null`.
*/
public async exec(
transaction: ClusterTransaction,
options?: {
route?: SingleNodeRoute;
} & DecoderOption,
): Promise<GlideReturnType[] | null> {
return this.createWritePromise<GlideReturnType[] | null>(
transaction.commands,
options,
).then((result) =>
this.processResultWithSetCommands(
result,
transaction.setCommandsIndexes,
),
);
}
/**
* Pings the server.
*
* The command will be routed to all primary nodes, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/ping/|valkey.io} for details.
*
* @param options - (Optional) Additional parameters:
* - (Optional) `message` : a message to include in the `PING` command.
* + If not provided, the server will respond with `"PONG"`.
* + If provided, the server will respond with a copy of the message.
* - (Optional) `route`: see {@link RouteOption}.
* - (Optional) `decoder`: see {@link DecoderOption}.
* @returns `"PONG"` if `message` is not provided, otherwise return a copy of `message`.
*
* @example
* ```typescript
* // Example usage of ping method without any message
* const result = await client.ping();
* console.log(result); // Output: 'PONG'
* ```
*
* @example
* ```typescript
* // Example usage of ping method with a message
* const result = await client.ping("Hello");
* console.log(result); // Output: 'Hello'
* ```
*/
public async ping(
options?: {
message?: GlideString;
} & RouteOption &
DecoderOption,
): Promise<GlideString> {
return this.createWritePromise(createPing(options?.message), options);
}
/**
* Gets information and statistics about the server.
*
* The command will be routed to all primary nodes, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/info/|valkey.io} for details.
*
* @param options - (Optional) Additional parameters:
* - (Optional) `sections`: a list of {@link InfoOptions} values specifying which sections of information to retrieve.
* When no parameter is provided, {@link InfoOptions.Default|Default} is assumed.
* - (Optional) `route`: see {@link RouteOption}.
* @returns A string containing the information for the sections requested.
* When specifying a route other than a single node,
* it returns a dictionary where each address is the key and its corresponding node response is the value.
*/
public async info(
options?: { sections?: InfoOptions[] } & RouteOption,
): Promise<ClusterResponse<string>> {
return this.createWritePromise<ClusterGlideRecord<string>>(
createInfo(options?.sections),
{ decoder: Decoder.String, ...options },
).then((res) => convertClusterGlideRecord(res, false, options?.route));
}
/**
* Gets the name of the connection to which the request is routed.
*
* The command will be routed to a random node, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/client-getname/|valkey.io} for details.
*
* @param options - (Optional) See {@link RouteOption} and {@link DecoderOption}.
*
* @returns - The name of the client connection as a string if a name is set, or `null` if no name is assigned.
* When specifying a route other than a single node, it returns a dictionary where each address is the key and
* its corresponding node response is the value.
*
* @example
* ```typescript
* // Example usage of client_getname method
* const result = await client.client_getname();
* console.log(result); // Output: 'Connection Name'
* ```
*
* @example
* ```typescript
* // Example usage of clientGetName method with routing to all nodes
* const result = await client.clientGetName('allNodes');
* console.log(result); // Output: {'addr': 'Connection Name', 'addr2': 'Connection Name', 'addr3': 'Connection Name'}
* ```
*/
public async clientGetName(
options?: RouteOption & DecoderOption,
): Promise<ClusterResponse<GlideString | null>> {
return this.createWritePromise<ClusterGlideRecord<GlideString | null>>(
createClientGetName(),
options,
).then((res) => convertClusterGlideRecord(res, true, options?.route));
}
/**
* Rewrites the configuration file with the current configuration.
*
* The command will be routed to a all nodes, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/config-rewrite/|valkey.io} for details.
*
* @param options - (Optional) See {@link RouteOption}.
* @returns `"OK"` when the configuration was rewritten properly. Otherwise, an error is thrown.
*
* @example
* ```typescript
* // Example usage of configRewrite command
* const result = await client.configRewrite();
* console.log(result); // Output: 'OK'
* ```
*/
public async configRewrite(options?: RouteOption): Promise<"OK"> {
return this.createWritePromise(createConfigRewrite(), {
decoder: Decoder.String,
...options,
});
}
/**
* Resets the statistics reported by the server using the `INFO` and `LATENCY HISTOGRAM` commands.
*
* The command will be routed to all nodes, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/config-resetstat/|valkey.io} for details.
*
* @param options - (Optional) See {@link RouteOption}.
* @returns always `"OK"`.
*
* @example
* ```typescript
* // Example usage of configResetStat command
* const result = await client.configResetStat();
* console.log(result); // Output: 'OK'
* ```
*/
public async configResetStat(options?: RouteOption): Promise<"OK"> {
return this.createWritePromise(createConfigResetStat(), {
decoder: Decoder.String,
...options,
});
}
/**
* Returns the current connection ID.
*
* The command will be routed to a random node, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/client-id/|valkey.io} for details.
*
* @param options - (Optional) See {@link RouteOption}.
* @returns The ID of the connection. When specifying a route other than a single node,
* it returns a dictionary where each address is the key and its corresponding node response is the value.
*
* @example
* ```typescript
* const result = await client.clientId();
* console.log("Connection id: " + result);
* ```
*/
public async clientId(
options?: RouteOption,
): Promise<ClusterResponse<number>> {
return this.createWritePromise<ClusterGlideRecord<number>>(
createClientId(),
options,
).then((res) => convertClusterGlideRecord(res, true, options?.route));
}
/**
* Reads the configuration parameters of the running server.
*
* The command will be routed to a random node, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/config-get/|valkey.io} for details.
*
* @param parameters - A list of configuration parameter names to retrieve values for.
* @param options - (Optional) See {@link RouteOption} and {@link DecoderOption}.
*
* @returns A map of values corresponding to the configuration parameters. When specifying a route other than a single node,
* it returns a dictionary where each address is the key and its corresponding node response is the value.
*
* @example
* ```typescript
* // Example usage of config_get method with a single configuration parameter with routing to a random node
* const result = await client.config_get(["timeout"], "randomNode");
* console.log(result); // Output: {'timeout': '1000'}
* ```
*
* @example
* ```typescript
* // Example usage of configGet method with multiple configuration parameters
* const result = await client.configGet(["timeout", "maxmemory"]);
* console.log(result); // Output: {'timeout': '1000', 'maxmemory': '1GB'}
* ```
*/
public async configGet(
parameters: string[],
options?: RouteOption & DecoderOption,
): Promise<ClusterResponse<Record<string, GlideString>>> {
return this.createWritePromise<
ClusterGlideRecord<GlideRecord<GlideString>>
>(createConfigGet(parameters), options).then((res) =>
convertGlideRecordToRecord(res as GlideRecord<string>),
);
}
/**
* Sets configuration parameters to the specified values.
*
* The command will be routed to all nodes, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/config-set/|valkey.io} for details.
*
* @param parameters - A map consisting of configuration parameters and their respective values to set.
* @param options - (Optional) See {@link RouteOption}.
* @returns "OK" when the configuration was set properly. Otherwise an error is thrown.
*
* @example
* ```typescript
* // Example usage of configSet method to set multiple configuration parameters
* const result = await client.configSet({ timeout: "1000", maxmemory, "1GB" });
* console.log(result); // Output: 'OK'
* ```
*/
public async configSet(
parameters: Record<string, GlideString>,
options?: RouteOption,
): Promise<"OK"> {
return this.createWritePromise(createConfigSet(parameters), {
decoder: Decoder.String,
...options,
});
}
/**
* Echoes the provided `message` back.
*
* The command will be routed to a random node, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/echo/|valkey.io} for details.
*
* @param message - The message to be echoed back.
* @param options - (Optional) See {@link RouteOption} and {@link DecoderOption}.
* @returns The provided `message`. When specifying a route other than a single node,
* it returns a dictionary where each address is the key and its corresponding node response is the value.
*
* @example
* ```typescript
* // Example usage of the echo command
* const echoedMessage = await client.echo("valkey-glide");
* console.log(echoedMessage); // Output: "valkey-glide"
* ```
* @example
* ```typescript
* // Example usage of the echo command with routing to all nodes
* const echoedMessage = await client.echo("valkey-glide", "allNodes");
* console.log(echoedMessage); // Output: {'addr': 'valkey-glide', 'addr2': 'valkey-glide', 'addr3': 'valkey-glide'}
* ```
*/
public async echo(
message: GlideString,
options?: RouteOption & DecoderOption,
): Promise<ClusterResponse<GlideString>> {
return this.createWritePromise<ClusterGlideRecord<GlideString>>(
createEcho(message),
options,
).then((res) => convertClusterGlideRecord(res, true, options?.route));
}
/**
* Returns the server time.
*
* The command will be routed to a random node, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/time/|valkey.io} for details.
*
* @param options - (Optional) See {@link RouteOption}.
*
* @returns The current server time as an `array` with two items:
* - A Unix timestamp,
* - The amount of microseconds already elapsed in the current second.
*
* When specifying a route other than a single node, it returns a dictionary where each address is the key and
* its corresponding node response is the value.
*
* @example
* ```typescript
* // Example usage of time method without any argument
* const result = await client.time();
* console.log(result); // Output: ['1710925775', '913580']
* ```
*
* @example
* ```typescript
* // Example usage of time method with routing to all nodes
* const result = await client.time('allNodes');
* console.log(result); // Output: {'addr': ['1710925775', '913580'], 'addr2': ['1710925775', '913580'], 'addr3': ['1710925775', '913580']}
* ```
*/
public async time(
options?: RouteOption,
): Promise<ClusterResponse<[string, string]>> {
return this.createWritePromise<ClusterGlideRecord<[string, string]>>(
createTime(),
options,
).then((res) => convertClusterGlideRecord(res, true, options?.route));
}
/**
* Copies the value stored at the `source` to the `destination` key. When `replace` is `true`,
* removes the `destination` key first if it already exists, otherwise performs no action.
*
* @see {@link https://valkey.io/commands/copy/|valkey.io} for details.
* @remarks When in cluster mode, `source` and `destination` must map to the same hash slot.
* @remarks Since Valkey version 6.2.0.
*
* @param source - The key to the source value.
* @param destination - The key where the value should be copied to.
* @param options - (Optional) Additional parameters:
* - (Optional) `replace`: if `true`, the `destination` key should be removed before copying the
* value to it. If not provided, no action will be performed if the key already exists.
* @returns `true` if `source` was copied, `false` if the `source` was not copied.
*
* @example
* ```typescript
* const result = await client.copy("set1", "set2", { replace: true });
* console.log(result); // Output: true - "set1" was copied to "set2".
* ```
*/
public async copy(
source: GlideString,
destination: GlideString,
options?: { replace?: boolean },
): Promise<boolean> {
return this.createWritePromise(
createCopy(source, destination, options),
);
}
/**
* Displays a piece of generative computer art and the server version.
*
* The command will be routed to a random node, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/lolwut/|valkey.io} for details.
*
* @param options - (Optional) The LOLWUT options - see {@link LolwutOptions} and {@link RouteOption}.
* @returns A piece of generative computer art along with the current server version.
*
* @example
* ```typescript
* const response = await client.lolwut({ version: 6, parameters: [40, 20] }, "allNodes");
* console.log(response); // Output: "Valkey ver. 7.2.3" - Indicates the current server version.
* ```
*/
public async lolwut(
options?: LolwutOptions & RouteOption,
): Promise<ClusterResponse<string>> {
return this.createWritePromise<ClusterGlideRecord<string>>(
createLolwut(options),
options,
).then((res) => convertClusterGlideRecord(res, true, options?.route));
}
/**
* Invokes a previously loaded function.
*
* The command will be routed to a random node, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/fcall/|valkey.io} for details.
* @remarks Since Valkey version 7.0.0.
*
* @param func - The function name.
* @param args - A list of `function` arguments and it should not represent names of keys.
* @param options - (Optional) See {@link RouteOption} and {@link DecoderOption}.
* @returns The invoked function's return value.
*
* @example
* ```typescript
* const response = await client.fcallWithRoute("Deep_Thought", [], "randomNode");
* console.log(response); // Output: Returns the function's return value.
* ```
*/
public async fcallWithRoute(
func: GlideString,
args: GlideString[],
options?: RouteOption & DecoderOption,
): Promise<ClusterResponse<GlideReturnType>> {
return this.createWritePromise<ClusterGlideRecord<GlideReturnType>>(
createFCall(func, [], args),
options,
).then((res) => convertClusterGlideRecord(res, true, options?.route));
}
/**
* Invokes a previously loaded read-only function.
*
* The command will be routed to a random node, unless `route` is provided.
*
* @see {@link https://valkey.io/commands/fcall/|valkey.io} for details.
* @remarks Since Valkey version 7.0.0.
*
* @param func - The function name.
* @param args - A list of `function` arguments and it should not represent names of keys.
* @param options - (Optional) See {@link RouteOption} and {@link DecoderOption}.
* @returns The invoked function's return value.
*
* @example
* ```typescript
* const response = await client.fcallReadonlyWithRoute("Deep_Thought", ["Answer", "to", "the", "Ultimate",
* "Question", "of", "Life,", "the", "Universe,", "and", "Everything"], "randomNode");
* console.log(response); // Output: 42 # The return value on the function that was execute.
* ```
*/
public async fcallReadonlyWithRoute(
func: GlideString,
args: GlideString[],
options?: RouteOption & DecoderOption,
): Promise<ClusterResponse<GlideReturnType>> {
return this.createWritePromise<ClusterGlideRecord<GlideReturnType>>(
createFCallReadOnly(func, [], args),
options,
).then((res) => convertClusterGlideRecord(res, true, options?.route));
}
/**
* Deletes a library and all its functions.
*
* @see {@link https://valkey.io/commands/function-delete/|valkey.io} for details.
* @remarks Since Valkey version 7.0.0.
*
* @param libraryCode - The library name to delete.
* @param route - (Optional) The command will be routed to all primary node, unless `route` is provided, in which
* case the client will route the command to the nodes defined by `route`.
* @returns A simple `"OK"` response.
*
* @example
* ```typescript
* const result = await client.functionDelete("libName");
* console.log(result); // Output: 'OK'
* ```
*/
public async functionDelete(
libraryCode: GlideString,
options?: RouteOption,
): Promise<"OK"> {
return this.createWritePromise(createFunctionDelete(libraryCode), {
decoder: Decoder.String,
...options,
});
}
/**
* Loads a library to Valkey.
*
* @see {@link https://valkey.io/commands/function-load/|valkey.io} for details.
* @remarks Since Valkey version 7.0.0.
*
* @param libraryCode - The source code that implements the library.
* @param options - (Optional) Additional parameters:
* - (Optional) `replace`: whether the given library should overwrite a library with the same name if it
* already exists.
* - (Optional) `route`: see {@link RouteOption}.
* - (Optional) `decoder`: see {@link DecoderOption}.
* @returns The library name that was loaded.
*
* @example
* ```typescript
* const code = "#!lua name=mylib \n redis.register_function('myfunc', function(keys, args) return args[1] end)";
* const result = await client.functionLoad(code, true, 'allNodes');
* console.log(result); // Output: 'mylib'
* ```
*/
public async functionLoad(
libraryCode: GlideString,
options?: {
replace?: boolean;
} & RouteOption &
DecoderOption,
): Promise<GlideString> {
return this.createWritePromise(
createFunctionLoad(libraryCode, options?.replace),
options,
);
}
/**
* Deletes all function libraries.
*
* @see {@link https://valkey.io/commands/function-flush/|valkey.io} for details.
* @remarks Since Valkey version 7.0.0.
*
* @param options - (Optional) Additional parameters:
* - (Optional) `mode`: the flushing mode, could be either {@link FlushMode.SYNC} or {@link FlushMode.ASYNC}.
* - (Optional) `route`: see {@link RouteOption}.
* @returns A simple `"OK"` response.
*
* @example
* ```typescript
* const result = await client.functionFlush(FlushMode.SYNC);
* console.log(result); // Output: 'OK'
* ```
*/
public async functionFlush(
options?: {
mode?: FlushMode;
} & RouteOption,
): Promise<"OK"> {
return this.createWritePromise(createFunctionFlush(options?.mode), {
decoder: Decoder.String,
...options,
});