35 lines
1.5 KiB
TypeScript
35 lines
1.5 KiB
TypeScript
|
import { CommandParser } from '@redis/client/dist/lib/client/parser';
|
||
|
|
import { RedisArgument, ReplyUnion, NumberReply } from '@redis/client/dist/lib/RESP/types';
|
||
|
|
import { AggregateRawReply, AggregateReply, FtAggregateOptions } from './AGGREGATE';
|
||
|
|
export interface FtAggregateWithCursorOptions extends FtAggregateOptions {
|
||
|
|
COUNT?: number;
|
||
|
|
MAXIDLE?: number;
|
||
|
|
}
|
||
|
|
type AggregateWithCursorRawReply = [
|
||
|
|
result: AggregateRawReply,
|
||
|
|
cursor: NumberReply
|
||
|
|
];
|
||
|
|
export interface AggregateWithCursorReply extends AggregateReply {
|
||
|
|
cursor: NumberReply;
|
||
|
|
}
|
||
|
|
declare const _default: {
|
||
|
|
readonly IS_READ_ONLY: false;
|
||
|
|
/**
|
||
|
|
* Performs an aggregation with a cursor for retrieving large result sets.
|
||
|
|
* @param parser - The command parser
|
||
|
|
* @param index - Name of the index to query
|
||
|
|
* @param query - The aggregation query
|
||
|
|
* @param options - Optional parameters:
|
||
|
|
* - All options supported by FT.AGGREGATE
|
||
|
|
* - COUNT: Number of results to return per cursor fetch
|
||
|
|
* - MAXIDLE: Maximum idle time for cursor in milliseconds
|
||
|
|
*/
|
||
|
|
readonly parseCommand: (this: void, parser: CommandParser, index: RedisArgument, query: RedisArgument, options?: FtAggregateWithCursorOptions) => void;
|
||
|
|
readonly transformReply: {
|
||
|
|
readonly 2: (reply: AggregateWithCursorRawReply) => AggregateWithCursorReply;
|
||
|
|
readonly 3: () => ReplyUnion;
|
||
|
|
};
|
||
|
|
readonly unstableResp3: true;
|
||
|
|
};
|
||
|
|
export default _default;
|
||
|
|
//# sourceMappingURL=AGGREGATE_WITHCURSOR.d.ts.map
|