forked from ravendb/ravendb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
IDocumentQueryBase.cs
368 lines (318 loc) · 13.9 KB
/
IDocumentQueryBase.cs
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
using System;
using System.Collections.Generic;
using System.Linq.Expressions;
using Raven.Abstractions.Data;
using Raven.Client.Document;
using Raven.Client.Linq;
namespace Raven.Client
{
/// <summary>
/// A query against a Raven index
/// </summary>
public interface IDocumentQueryBase<T, out TSelf>
where TSelf : IDocumentQueryBase<T, TSelf>
{
/// <summary>
/// Gets the document convention from the query session
/// </summary>
DocumentConvention DocumentConvention { get; }
/// <summary>
/// Negate the next operation
/// </summary>
TSelf Not { get; }
/// <summary>
/// Negate the next operation
/// </summary>
void NegateNext();
/// <summary>
/// Includes the specified path in the query, loading the document specified in that path
/// </summary>
/// <param name = "path">The path.</param>
TSelf Include(string path);
/// <summary>
/// This function exists solely to forbid in memory where clause on IDocumentQuery, because
/// that is nearly always a mistake.
/// </summary>
[Obsolete(
@"
You cannot issue an in memory filter - such as Where(x=>x.Name == ""Ayende"") - on IDocumentQuery.
This is likely a bug, because this will execute the filter in memory, rather than in RavenDB.
Consider using session.Query<T>() instead of session.LuceneQuery<T>. The session.Query<T>() method fully supports Linq queries, while session.LuceneQuery<T>() is intended for lower level API access.
If you really want to do in memory filtering on the data returned from the query, you can use: session.LuceneQuery<T>().ToList().Where(x=>x.Name == ""Ayende"")
"
, true)]
IEnumerable<T> Where(Func<T, bool> predicate);
/// <summary>
/// This function exists solely to forbid in memory where clause on IDocumentQuery, because
/// that is nearly always a mistake.
/// </summary>
[Obsolete(
@"
You cannot issue an in memory filter - such as Count(x=>x.Name == ""Ayende"") - on IDocumentQuery.
This is likely a bug, because this will execute the filter in memory, rather than in RavenDB.
Consider using session.Query<T>() instead of session.LuceneQuery<T>. The session.Query<T>() method fully supports Linq queries, while session.LuceneQuery<T>() is intended for lower level API access.
If you really want to do in memory filtering on the data returned from the query, you can use: session.LuceneQuery<T>().ToList().Count(x=>x.Name == ""Ayende"")
"
, true)]
int Count(Func<T, bool> predicate);
/// <summary>
/// This function exists solely to forbid in memory where clause on IDocumentQuery, because
/// that is nearly always a mistake.
/// </summary>
[Obsolete(
@"
You cannot issue an in memory filter - such as Count() - on IDocumentQuery.
This is likely a bug, because this will execute the filter in memory, rather than in RavenDB.
Consider using session.Query<T>() instead of session.LuceneQuery<T>. The session.Query<T>() method fully supports Linq queries, while session.LuceneQuery<T>() is intended for lower level API access.
If you really want to do in memory filtering on the data returned from the query, you can use: session.LuceneQuery<T>().ToList().Count()
"
, true)]
int Count();
/// <summary>
/// Includes the specified path in the query, loading the document specified in that path
/// </summary>
/// <param name = "path">The path.</param>
TSelf Include(Expression<Func<T, object>> path);
/// <summary>
/// Takes the specified count.
/// </summary>
/// <param name = "count">The count.</param>
/// <returns></returns>
TSelf Take (int count);
/// <summary>
/// Skips the specified count.
/// </summary>
/// <param name = "count">The count.</param>
/// <returns></returns>
TSelf Skip(int count);
/// <summary>
/// Filter the results from the index using the specified where clause.
/// </summary>
/// <param name = "whereClause">The where clause.</param>
TSelf Where(string whereClause);
/// <summary>
/// Matches exact value
/// </summary>
/// <remarks>
/// Defaults to NotAnalyzed
/// </remarks>
TSelf WhereEquals(string fieldName, object value);
/// <summary>
/// Matches exact value
/// </summary>
/// <remarks>
/// Defaults to allow wildcards only if analyzed
/// </remarks>
TSelf WhereEquals(string fieldName, object value, bool isAnalyzed);
/// <summary>
/// Matches exact value
/// </summary>
TSelf WhereEquals (WhereParams whereParams);
/// <summary>
/// Matches substrings of the field
/// </summary>
TSelf WhereContains(string fieldName, object value);
/// <summary>
/// Matches substrings of the field
/// </summary>
TSelf WhereContains(string fieldName, params object[] values);
/// <summary>
/// Matches substrings of the field
/// </summary>
TSelf WhereContains(string fieldName, IEnumerable<object> values);
/// <summary>
/// Matches fields which starts with the specified value.
/// </summary>
/// <param name = "fieldName">Name of the field.</param>
/// <param name = "value">The value.</param>
TSelf WhereStartsWith (string fieldName, object value);
/// <summary>
/// Matches fields which ends with the specified value.
/// </summary>
/// <param name = "fieldName">Name of the field.</param>
/// <param name = "value">The value.</param>
TSelf WhereEndsWith (string fieldName, object value);
/// <summary>
/// Matches fields where the value is between the specified start and end, exclusive
/// </summary>
/// <param name = "fieldName">Name of the field.</param>
/// <param name = "start">The start.</param>
/// <param name = "end">The end.</param>
TSelf WhereBetween (string fieldName, object start, object end);
/// <summary>
/// Matches fields where the value is between the specified start and end, inclusive
/// </summary>
/// <param name = "fieldName">Name of the field.</param>
/// <param name = "start">The start.</param>
/// <param name = "end">The end.</param>
TSelf WhereBetweenOrEqual (string fieldName, object start, object end);
/// <summary>
/// Matches fields where the value is greater than the specified value
/// </summary>
/// <param name = "fieldName">Name of the field.</param>
/// <param name = "value">The value.</param>
TSelf WhereGreaterThan (string fieldName, object value);
/// <summary>
/// Matches fields where the value is greater than or equal to the specified value
/// </summary>
/// <param name = "fieldName">Name of the field.</param>
/// <param name = "value">The value.</param>
TSelf WhereGreaterThanOrEqual (string fieldName, object value);
/// <summary>
/// Matches fields where the value is less than the specified value
/// </summary>
/// <param name = "fieldName">Name of the field.</param>
/// <param name = "value">The value.</param>
TSelf WhereLessThan (string fieldName, object value);
/// <summary>
/// Matches fields where the value is less than or equal to the specified value
/// </summary>
/// <param name = "fieldName">Name of the field.</param>
/// <param name = "value">The value.</param>
TSelf WhereLessThanOrEqual (string fieldName, object value);
/// <summary>
/// Add an AND to the query
/// </summary>
TSelf AndAlso ();
/// <summary>
/// Add an OR to the query
/// </summary>
TSelf OrElse();
/// <summary>
/// Specifies a boost weight to the last where clause.
/// The higher the boost factor, the more relevant the term will be.
/// </summary>
/// <param name = "boost">boosting factor where 1.0 is default, less than 1.0 is lower weight, greater than 1.0 is higher weight</param>
/// <returns></returns>
/// <remarks>
/// http://lucene.apache.org/java/2_4_0/queryparsersyntax.html#Boosting%20a%20Term
/// </remarks>
TSelf Boost (decimal boost);
/// <summary>
/// Specifies a fuzziness factor to the single word term in the last where clause
/// </summary>
/// <param name = "fuzzy">0.0 to 1.0 where 1.0 means closer match</param>
/// <returns></returns>
/// <remarks>
/// http://lucene.apache.org/java/2_4_0/queryparsersyntax.html#Fuzzy%20Searches
/// </remarks>
TSelf Fuzzy (decimal fuzzy);
/// <summary>
/// Specifies a proximity distance for the phrase in the last where clause
/// </summary>
/// <param name = "proximity">number of words within</param>
/// <returns></returns>
/// <remarks>
/// http://lucene.apache.org/java/2_4_0/queryparsersyntax.html#Proximity%20Searches
/// </remarks>
TSelf Proximity (int proximity);
/// <summary>
/// Filter matches to be inside the specified radius
/// </summary>
/// <param name = "radius">The radius.</param>
/// <param name = "latitude">The latitude.</param>
/// <param name = "longitude">The longitude.</param>
TSelf WithinRadiusOf(double radius, double latitude, double longitude);
/// <summary>
/// Sorts the query results by distance.
/// </summary>
TSelf SortByDistance();
/// <summary>
/// Order the results by the specified fields
/// The fields are the names of the fields to sort, defaulting to sorting by ascending.
/// You can prefix a field name with '-' to indicate sorting by descending or '+' to sort by ascending
/// </summary>
/// <param name = "fields">The fields.</param>
TSelf OrderBy(params string[] fields);
/// <summary>
/// Instructs the query to wait for non stale results as of now.
/// </summary>
/// <returns></returns>
TSelf WaitForNonStaleResultsAsOfNow();
/// <summary>
/// Instructs the query to wait for non stale results as of the last write made by any session belonging to the
/// current document store.
/// This ensures that you'll always get the most relevant results for your scenarios using simple indexes (map only or dynamic queries).
/// However, when used to query map/reduce indexes, it does NOT guarantee that the document that this etag belong to is actually considered for the results.
/// </summary>
TSelf WaitForNonStaleResultsAsOfLastWrite();
/// <summary>
/// Instructs the query to wait for non stale results as of the last write made by any session belonging to the
/// current document store.
/// This ensures that you'll always get the most relevant results for your scenarios using simple indexes (map only or dynamic queries).
/// However, when used to query map/reduce indexes, it does NOT guarantee that the document that this etag belong to is actually considered for the results.
/// </summary>
TSelf WaitForNonStaleResultsAsOfLastWrite(TimeSpan waitTimeout);
/// <summary>
/// Instructs the query to wait for non stale results as of now for the specified timeout.
/// </summary>
/// <param name = "waitTimeout">The wait timeout.</param>
/// <returns></returns>
TSelf WaitForNonStaleResultsAsOfNow(TimeSpan waitTimeout);
/// <summary>
/// Instructs the query to wait for non stale results as of the cutoff date.
/// </summary>
/// <param name = "cutOff">The cut off.</param>
/// <returns></returns>
TSelf WaitForNonStaleResultsAsOf(DateTime cutOff);
/// <summary>
/// Instructs the query to wait for non stale results as of the cutoff date for the specified timeout
/// </summary>
/// <param name = "cutOff">The cut off.</param>
/// <param name = "waitTimeout">The wait timeout.</param>
TSelf WaitForNonStaleResultsAsOf(DateTime cutOff, TimeSpan waitTimeout);
/// <summary>
/// EXPERT ONLY: Instructs the query to wait for non stale results.
/// This shouldn't be used outside of unit tests unless you are well aware of the implications
/// </summary>
TSelf WaitForNonStaleResults();
/// <summary>
/// EXPERT ONLY: Instructs the query to wait for non stale results for the specified wait timeout.
/// This shouldn't be used outside of unit tests unless you are well aware of the implications
/// </summary>
/// <param name = "waitTimeout">The wait timeout.</param>
TSelf WaitForNonStaleResults(TimeSpan waitTimeout);
/// <summary>
/// Adds an ordering for a specific field to the query
/// </summary>
/// <param name = "fieldName">Name of the field.</param>
/// <param name = "descending">if set to <c>true</c> [descending].</param>
TSelf AddOrder(string fieldName, bool descending);
/// <summary>
/// Adds an ordering for a specific field to the query and specifies the type of field for sorting purposes
/// </summary>
/// <param name = "fieldName">Name of the field.</param>
/// <param name = "descending">if set to <c>true</c> [descending].</param>
/// <param name = "fieldType">the type of the field to be sorted.</param>
TSelf AddOrder (string fieldName, bool descending, Type fieldType);
/// <summary>
/// Simplified method for opening a new clause within the query
/// </summary>
/// <returns></returns>
TSelf OpenSubclause ();
/// <summary>
/// Simplified method for closing a clause within the query
/// </summary>
/// <returns></returns>
TSelf CloseSubclause ();
///<summary>
/// Instruct the index to group by the specified fields using the specified aggregation operation
///</summary>
///<remarks>
/// This is only valid on dynamic indexes queries
///</remarks>
TSelf GroupBy (AggregationOperation aggregationOperation, params string[] fieldsToGroupBy);
/// <summary>
/// Callback to get the results of the query
/// </summary>
void AfterQueryExecuted(Action<QueryResult> afterQueryExecuted);
/// <summary>
/// Called externally to raise the after query executed callback
/// </summary>
void InvokeAfterQueryExecuted(QueryResult result);
/// <summary>
/// Provide statistics about the query, such as total count of matching records
/// </summary>
TSelf Statistics(out RavenQueryStatistics stats);
}
}