Skip to content

Commit 10786b9

Browse files
andy-stark-redisandy-stark-redis
committed
DOC-6268 query engne commands
1 parent c64b0b3 commit 10786b9

27 files changed

+4877
-0
lines changed

‎data/command-api-mapping/FT.AGGREGATE.json‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
{
2+
"api_calls": {
3+
"redis_py": [
4+
{
5+
"signature": "aggregate(query: Union[str, Query], query_params: Optional[Dict[str, Union[str, int, float]]] = None)",
6+
"params": [
7+
{
8+
"name": "query",
9+
"type": "Union[str, Query]",
10+
"description": "The aggregation query"
11+
},
12+
{
13+
"name": "query_params",
14+
"type": "Optional[Dict[str, Union[str, int, float]]]",
15+
"description": "Optional query parameters"
16+
}
17+
],
18+
"returns": {
19+
"type": "AggregateResult",
20+
"description": "The aggregation results"
21+
}
22+
}
23+
],
24+
"jedis": [
25+
{
26+
"signature": "AggregationResult ftAggregate(String indexName, AggregationBuilder aggr)",
27+
"params": [
28+
{
29+
"name": "indexName",
30+
"type": "String",
31+
"description": "The index name"
32+
},
33+
{
34+
"name": "aggr",
35+
"type": "AggregationBuilder",
36+
"description": "The aggregation builder"
37+
}
38+
],
39+
"returns": {
40+
"type": "AggregationResult",
41+
"description": "The aggregation results"
42+
}
43+
}
44+
],
45+
"lettuce_sync": [],
46+
"lettuce_async": [],
47+
"lettuce_reactive": [],
48+
"go-redis": [
49+
{
50+
"signature": "FTAggregate(ctx context.Context, index string, query string)",
51+
"params": [
52+
{
53+
"name": "ctx",
54+
"type": "context.Context",
55+
"description": ""
56+
},
57+
{
58+
"name": "index",
59+
"type": "string",
60+
"description": "The index name"
61+
},
62+
{
63+
"name": "query",
64+
"type": "string",
65+
"description": "The aggregation query"
66+
}
67+
],
68+
"returns": {
69+
"type": "*MapStringInterfaceCmd",
70+
"description": "The aggregation results"
71+
}
72+
},
73+
{
74+
"signature": "FTAggregateWithArgs(ctx context.Context, index string, query string, options *FTAggregateOptions)",
75+
"params": [
76+
{
77+
"name": "ctx",
78+
"type": "context.Context",
79+
"description": ""
80+
},
81+
{
82+
"name": "index",
83+
"type": "string",
84+
"description": "The index name"
85+
},
86+
{
87+
"name": "query",
88+
"type": "string",
89+
"description": "The aggregation query"
90+
},
91+
{
92+
"name": "options",
93+
"type": "*FTAggregateOptions",
94+
"description": "Aggregation options"
95+
}
96+
],
97+
"returns": {
98+
"type": "*AggregateCmd",
99+
"description": "The aggregation results"
100+
}
101+
}
102+
],
103+
"node_redis": [
104+
{
105+
"signature": "AGGREGATE(index: RedisArgument, query: RedisArgument, options?: FTAggregateOptions)",
106+
"params": [
107+
{
108+
"name": "index",
109+
"type": "RedisArgument",
110+
"description": "The index name"
111+
},
112+
{
113+
"name": "query",
114+
"type": "RedisArgument",
115+
"description": "The aggregation query"
116+
},
117+
{
118+
"name": "options",
119+
"type": "FTAggregateOptions",
120+
"description": "Optional aggregation options"
121+
}
122+
],
123+
"returns": {
124+
"type": "Promise<AggregateResult>",
125+
"description": "The aggregation results"
126+
}
127+
}
128+
],
129+
"ioredis": [],
130+
"redis_rs_sync": [],
131+
"redis_rs_async": [],
132+
"nredisstack_sync": [
133+
{
134+
"signature": "AggregationResult Aggregate(string index, AggregationRequest query)",
135+
"params": [
136+
{
137+
"name": "index",
138+
"type": "string",
139+
"description": "The index name"
140+
},
141+
{
142+
"name": "query",
143+
"type": "AggregationRequest",
144+
"description": "The aggregation query"
145+
}
146+
],
147+
"returns": {
148+
"type": "AggregationResult",
149+
"description": "The aggregation results"
150+
}
151+
}
152+
],
153+
"nredisstack_async": [
154+
{
155+
"signature": "Task<AggregationResult> AggregateAsync(string index, AggregationRequest query)",
156+
"params": [
157+
{
158+
"name": "index",
159+
"type": "string",
160+
"description": "The index name"
161+
},
162+
{
163+
"name": "query",
164+
"type": "AggregationRequest",
165+
"description": "The aggregation query"
166+
}
167+
],
168+
"returns": {
169+
"type": "Task<AggregationResult>",
170+
"description": "The aggregation results"
171+
}
172+
}
173+
],
174+
"php": [
175+
{
176+
"signature": "ftaggregate(string $index, string $query, ?AggregateArguments $arguments = null)",
177+
"params": [
178+
{
179+
"name": "$index",
180+
"type": "string",
181+
"description": "The index name"
182+
},
183+
{
184+
"name": "$query",
185+
"type": "string",
186+
"description": "The aggregation query"
187+
},
188+
{
189+
"name": "$arguments",
190+
"type": "?AggregateArguments",
191+
"description": "Optional aggregation arguments"
192+
}
193+
],
194+
"returns": {
195+
"type": "array",
196+
"description": "The aggregation results"
197+
}
198+
}
199+
]
200+
}
201+
}
202+

‎data/command-api-mapping/FT.ALIASADD.json‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
{
2+
"api_calls": {
3+
"redis_py": [
4+
{
5+
"signature": "aliasadd(alias: str)",
6+
"params": [
7+
{
8+
"name": "alias",
9+
"type": "str",
10+
"description": "The alias name to add"
11+
}
12+
],
13+
"returns": {
14+
"type": "str",
15+
"description": "OK on success"
16+
}
17+
}
18+
],
19+
"jedis": [
20+
{
21+
"signature": "String ftAliasAdd(String aliasName, String indexName)",
22+
"params": [
23+
{
24+
"name": "aliasName",
25+
"type": "String",
26+
"description": "The alias name"
27+
},
28+
{
29+
"name": "indexName",
30+
"type": "String",
31+
"description": "The index name"
32+
}
33+
],
34+
"returns": {
35+
"type": "String",
36+
"description": "OK on success"
37+
}
38+
}
39+
],
40+
"lettuce_sync": [],
41+
"lettuce_async": [],
42+
"lettuce_reactive": [],
43+
"go-redis": [
44+
{
45+
"signature": "FTAliasAdd(ctx context.Context, index string, alias string)",
46+
"params": [
47+
{
48+
"name": "ctx",
49+
"type": "context.Context",
50+
"description": ""
51+
},
52+
{
53+
"name": "index",
54+
"type": "string",
55+
"description": "The index name"
56+
},
57+
{
58+
"name": "alias",
59+
"type": "string",
60+
"description": "The alias name"
61+
}
62+
],
63+
"returns": {
64+
"type": "*StatusCmd",
65+
"description": "OK on success"
66+
}
67+
}
68+
],
69+
"node_redis": [
70+
{
71+
"signature": "ALIASADD(alias: RedisArgument, index: RedisArgument)",
72+
"params": [
73+
{
74+
"name": "alias",
75+
"type": "RedisArgument",
76+
"description": "The alias name"
77+
},
78+
{
79+
"name": "index",
80+
"type": "RedisArgument",
81+
"description": "The index name"
82+
}
83+
],
84+
"returns": {
85+
"type": "Promise<string>",
86+
"description": "OK on success"
87+
}
88+
}
89+
],
90+
"ioredis": [],
91+
"redis_rs_sync": [],
92+
"redis_rs_async": [],
93+
"nredisstack_sync": [
94+
{
95+
"signature": "bool AliasAdd(string alias, string index)",
96+
"params": [
97+
{
98+
"name": "alias",
99+
"type": "string",
100+
"description": "The alias name"
101+
},
102+
{
103+
"name": "index",
104+
"type": "string",
105+
"description": "The index name"
106+
}
107+
],
108+
"returns": {
109+
"type": "bool",
110+
"description": "true if the alias was added"
111+
}
112+
}
113+
],
114+
"nredisstack_async": [
115+
{
116+
"signature": "Task<bool> AliasAddAsync(string alias, string index)",
117+
"params": [
118+
{
119+
"name": "alias",
120+
"type": "string",
121+
"description": "The alias name"
122+
},
123+
{
124+
"name": "index",
125+
"type": "string",
126+
"description": "The index name"
127+
}
128+
],
129+
"returns": {
130+
"type": "Task<bool>",
131+
"description": "true if the alias was added"
132+
}
133+
}
134+
],
135+
"php": [
136+
{
137+
"signature": "ftaliasadd(string $alias, string $index)",
138+
"params": [
139+
{
140+
"name": "$alias",
141+
"type": "string",
142+
"description": "The alias name"
143+
},
144+
{
145+
"name": "$index",
146+
"type": "string",
147+
"description": "The index name"
148+
}
149+
],
150+
"returns": {
151+
"type": "Status",
152+
"description": "OK on success"
153+
}
154+
}
155+
]
156+
}
157+
}
158+

0 commit comments

Comments
 (0)