36 lines
1.5 KiB
TypeScript
36 lines
1.5 KiB
TypeScript
|
import { CommandParser } from '@redis/client/dist/lib/client/parser';
|
||
|
|
import { ArrayReply, RedisArgument, ReplyUnion, TuplesReply } from '@redis/client/dist/lib/RESP/types';
|
||
|
|
import { AggregateReply } from './AGGREGATE';
|
||
|
|
import { FtSearchOptions, SearchRawReply, SearchReply } from './SEARCH';
|
||
|
|
export type ProfileRawReplyResp2<T> = TuplesReply<[
|
||
|
|
T,
|
||
|
|
ArrayReply<ReplyUnion>
|
||
|
|
]>;
|
||
|
|
export interface ProfileReplyResp2 {
|
||
|
|
results: SearchReply | AggregateReply;
|
||
|
|
profile: ReplyUnion;
|
||
|
|
}
|
||
|
|
export interface ProfileOptions {
|
||
|
|
LIMITED?: true;
|
||
|
|
}
|
||
|
|
declare const _default: {
|
||
|
|
readonly NOT_KEYED_COMMAND: true;
|
||
|
|
readonly IS_READ_ONLY: true;
|
||
|
|
/**
|
||
|
|
* Profiles the execution of a search query for performance analysis.
|
||
|
|
* @param parser - The command parser
|
||
|
|
* @param index - Name of the index to profile query against
|
||
|
|
* @param query - The search query to profile
|
||
|
|
* @param options - Optional parameters:
|
||
|
|
* - LIMITED: Collect limited timing information only
|
||
|
|
* - All options supported by FT.SEARCH command
|
||
|
|
*/
|
||
|
|
readonly parseCommand: (this: void, parser: CommandParser, index: RedisArgument, query: RedisArgument, options?: ProfileOptions & FtSearchOptions) => void;
|
||
|
|
readonly transformReply: {
|
||
|
|
readonly 2: (reply: [SearchRawReply, ArrayReply<ReplyUnion>]) => ProfileReplyResp2;
|
||
|
|
readonly 3: (reply: ReplyUnion) => ReplyUnion;
|
||
|
|
};
|
||
|
|
readonly unstableResp3: true;
|
||
|
|
};
|
||
|
|
export default _default;
|
||
|
|
//# sourceMappingURL=PROFILE_SEARCH.d.ts.map
|