-
Notifications
You must be signed in to change notification settings - Fork 116
/
Raven.Client.Lightweight-3.5.XML
7246 lines (7233 loc) · 360 KB
/
Raven.Client.Lightweight-3.5.XML
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Raven.Client.Lightweight-3.5</name>
</assembly>
<members>
<member name="T:Raven.Client.Connection.HttpJsonRequest">
<summary>
A representation of an HTTP json request to the RavenDB server
</summary>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequest.ReadResponseString">
<summary>
Reads the response string.
</summary>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequest.CalculateDuration">
<summary>
The request duration
</summary>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequest.Write(System.String)">
<summary>
Writes the specified data.
</summary>
<param name="data">The data.</param>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequest.BeginWrite(System.String,System.AsyncCallback,System.Object)">
<summary>
Begins the write operation
</summary>
<param name="dataToWrite">The byte array.</param>
<param name="callback">The callback.</param>
<param name="state">The state.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequest.EndWrite(System.IAsyncResult)">
<summary>
Ends the write operation.
</summary>
<param name="result">The result.</param>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequest.AddOperationHeaders(System.Collections.Specialized.NameValueCollection)">
<summary>
Adds the operation headers.
</summary>
<param name="operationsHeaders">The operations headers.</param>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequest.AddOperationHeaders(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Adds the operation headers.
</summary>
<param name="operationsHeaders">The operations headers.</param>
</member>
<member name="P:Raven.Client.Connection.HttpJsonRequest.ResponseHeaders">
<summary>
Gets or sets the response headers.
</summary>
<value>The response headers.</value>
</member>
<member name="P:Raven.Client.Connection.HttpJsonRequest.ResponseStatusCode">
<summary>
Gets or sets the response status code.
</summary>
<value>The response status code.</value>
</member>
<member name="P:Raven.Client.Connection.HttpJsonRequest.SkipServerCheck">
<summary>
Whatever we can skip the server check and directly return the cached result
</summary>
</member>
<member name="P:Raven.Client.Connection.HttpJsonRequest.ContentType">
<summary>
The underlying request content type
</summary>
</member>
<member name="T:Raven.Client.Connection.HttpJsonRequestFactory">
<summary>
Create the HTTP Json Requests to the RavenDB Server
and manages the http cache
</summary>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequestFactory.InvokeLogRequest(Raven.Client.Connection.Profiling.IHoldProfilingInformation,Raven.Client.Connection.Profiling.RequestResultArgs)">
<summary>
Invoke the LogRequest event
</summary>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequestFactory.CreateHttpJsonRequest(Raven.Client.Connection.Profiling.IHoldProfilingInformation,System.String,System.String,System.Net.ICredentials,Raven.Client.Document.DocumentConvention)">
<summary>
Creates the HTTP json request.
</summary>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequestFactory.CreateHttpJsonRequest(Raven.Client.Connection.Profiling.IHoldProfilingInformation,System.String,System.String,Raven.Json.Linq.RavenJObject,System.Net.ICredentials,Raven.Client.Document.DocumentConvention)">
<summary>
Creates the HTTP json request.
</summary>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequestFactory.ResetCache">
<summary>
Reset the number of cached requests and clear the entire cache
Mostly used for testing
</summary>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequestFactory.#ctor(System.Int32)">
<summary>
default ctor
</summary>
<param name="maxNumberOfCachedRequests"></param>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequestFactory.Dispose">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
<filterpriority>2</filterpriority>
</member>
<member name="M:Raven.Client.Connection.HttpJsonRequestFactory.DisableAllCaching">
<summary>
Disable all caching within the given scope
</summary>
</member>
<member name="P:Raven.Client.Connection.HttpJsonRequestFactory.EnableBasicAuthenticationOverUnsecureHttpEvenThoughPasswordsWouldBeSentOverTheWireInClearTextToBeStolenByHackers">
<summary>
Advanced: Don't set this unless you know what you are doing!
Enable using basic authentication using http
By default, RavenDB only allows basic authentication over HTTPS, setting this property to true
will instruct RavenDB to make unsecure calls (usually only good for testing / internal networks).
</summary>
</member>
<member name="E:Raven.Client.Connection.HttpJsonRequestFactory.ConfigureRequest">
<summary>
Occurs when a json request is created
</summary>
</member>
<member name="E:Raven.Client.Connection.HttpJsonRequestFactory.LogRequest">
<summary>
Occurs when a json request is completed
</summary>
</member>
<member name="P:Raven.Client.Connection.HttpJsonRequestFactory.NumberOfCachedRequests">
<summary>
The number of requests that we got 304 for
and were able to handle purely from the cache
</summary>
</member>
<member name="P:Raven.Client.Connection.HttpJsonRequestFactory.DisableHttpCaching">
<summary>
Disable the HTTP caching
</summary>
</member>
<member name="P:Raven.Client.Connection.HttpJsonRequestFactory.AggressiveCacheDuration">
<summary>
The aggressive cache duration
</summary>
</member>
<member name="T:Raven.Client.Connection.IDatabaseCommands">
<summary>
Expose the set of operations by the RavenDB server
</summary>
</member>
<member name="T:Raven.Client.Connection.Profiling.IHoldProfilingInformation">
<summary>
Interface for getting profiling infomration about the actions of the system
within a given context, usually the context is database commands or async database commands
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.IHoldProfilingInformation.ProfilingInformation">
<summary>
The profiling information
</summary>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.StartsWith(System.String,System.Int32,System.Int32)">
<summary>
Retrieves documents for the specified key prefix
</summary>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Get(System.String)">
<summary>
Retrieves the document for the specified key
</summary>
<param name="key">The key.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Get(System.String[],System.String[])">
<summary>
Retrieves documents with the specified ids, optionally specifying includes to fetch along
</summary>
<param name="ids">The ids.</param>
<param name="includes">The includes.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Put(System.String,System.Nullable{System.Guid},Raven.Json.Linq.RavenJObject,Raven.Json.Linq.RavenJObject)">
<summary>
Puts the document in the database with the specified key
</summary>
<param name="key">The key.</param>
<param name="etag">The etag.</param>
<param name="document">The document.</param>
<param name="metadata">The metadata.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Delete(System.String,System.Nullable{System.Guid})">
<summary>
Deletes the document with the specified key
</summary>
<param name="key">The key.</param>
<param name="etag">The etag.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.PutAttachment(System.String,System.Nullable{System.Guid},System.IO.Stream,Raven.Json.Linq.RavenJObject)">
<summary>
Puts a byte array as attachment with the specified key
</summary>
<param name="key">The key.</param>
<param name="etag">The etag.</param>
<param name="data">The data.</param>
<param name="metadata">The metadata.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.GetAttachment(System.String)">
<summary>
Retrieves the attachment with the specified key
</summary>
<param name="key">The key.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.DeleteAttachment(System.String,System.Nullable{System.Guid})">
<summary>
Deletes the attachment with the specified key
</summary>
<param name="key">The key.</param>
<param name="etag">The etag.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.GetDatabaseNames">
<summary>
Returns the names of all tenant databases on the RavenDB server
</summary>
<returns>List of tenant database names</returns>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.GetIndexNames(System.Int32,System.Int32)">
<summary>
Returns the names of all indexes that exist on the server
</summary>
<param name="start">Paging start</param>
<param name="pageSize">Size of the page.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.ResetIndex(System.String)">
<summary>
Resets the specified index
</summary>
<param name="name">The name.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.GetIndex(System.String)">
<summary>
Gets the index definition for the specified name
</summary>
<param name="name">The name.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.PutIndex(System.String,Raven.Abstractions.Indexing.IndexDefinition)">
<summary>
Creates an index with the specified name, based on an index definition
</summary>
<param name="name">The name.</param>
<param name="indexDef">The index def.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.PutIndex(System.String,Raven.Abstractions.Indexing.IndexDefinition,System.Boolean)">
<summary>
Creates an index with the specified name, based on an index definition
</summary>
<param name="name">The name.</param>
<param name="indexDef">The index def.</param>
<param name="overwrite">if set to <c>true</c> [overwrite].</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.PutIndex``2(System.String,Raven.Client.Indexes.IndexDefinitionBuilder{``0,``1})">
<summary>
Creates an index with the specified name, based on an index definition that is created by the supplied
IndexDefinitionBuilder
</summary>
<typeparam name="TDocument">The type of the document.</typeparam>
<typeparam name="TReduceResult">The type of the reduce result.</typeparam>
<param name="name">The name.</param>
<param name="indexDef">The index def.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.PutIndex``2(System.String,Raven.Client.Indexes.IndexDefinitionBuilder{``0,``1},System.Boolean)">
<summary>
Creates an index with the specified name, based on an index definition that is created by the supplied
IndexDefinitionBuilder
</summary>
<typeparam name="TDocument">The type of the document.</typeparam>
<typeparam name="TReduceResult">The type of the reduce result.</typeparam>
<param name="name">The name.</param>
<param name="indexDef">The index def.</param>
<param name="overwrite">if set to <c>true</c> [overwrite].</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Query(System.String,Raven.Abstractions.Data.IndexQuery,System.String[])">
<summary>
Queries the specified index in the Raven flavoured Lucene query syntax
</summary>
<param name="index">The index.</param>
<param name="query">The query.</param>
<param name="includes">The includes.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.DeleteIndex(System.String)">
<summary>
Deletes the specified index
</summary>
<param name="name">The name.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Batch(System.Collections.Generic.IEnumerable{Raven.Abstractions.Commands.ICommandData})">
<summary>
Executed the specified commands as a single batch
</summary>
<param name="commandDatas">The command data.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Commit(System.Guid)">
<summary>
Commits the specified tx id
</summary>
<param name="txId">The tx id.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Rollback(System.Guid)">
<summary>
Rollbacks the specified tx id
</summary>
<param name="txId">The tx id.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.PromoteTransaction(System.Guid)">
<summary>
Promotes the transaction
</summary>
<param name="fromTxId">From tx id.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.StoreRecoveryInformation(System.Guid,System.Guid,System.Byte[])">
<summary>
Stores the recovery information
</summary>
<param name="resourceManagerId">The resource manager Id for this transaction</param>
<param name="txId">The tx id.</param>
<param name="recoveryInformation">The recovery information.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.With(System.Net.ICredentials)">
<summary>
Returns a new <see cref="T:Raven.Client.Connection.IDatabaseCommands"/> using the specified credentials
</summary>
<param name="credentialsForSession">The credentials for session.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.DeleteByIndex(System.String,Raven.Abstractions.Data.IndexQuery)">
<summary>
Perform a set based deletes using the specified index, not allowing the operation
if the index is stale
</summary>
<param name="indexName">Name of the index.</param>
<param name="queryToDelete">The query to delete.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.DeleteByIndex(System.String,Raven.Abstractions.Data.IndexQuery,System.Boolean)">
<summary>
Perform a set based deletes using the specified index
</summary>
<param name="indexName">Name of the index.</param>
<param name="queryToDelete">The query to delete.</param>
<param name="allowStale">if set to <c>true</c> [allow stale].</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.UpdateByIndex(System.String,Raven.Abstractions.Data.IndexQuery,Raven.Abstractions.Data.PatchRequest[])">
<summary>
Perform a set based update using the specified index, not allowing the operation
if the index is stale
</summary>
<param name="indexName">Name of the index.</param>
<param name="queryToUpdate">The query to update.</param>
<param name="patchRequests">The patch requests.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.UpdateByIndex(System.String,Raven.Abstractions.Data.IndexQuery,Raven.Abstractions.Data.PatchRequest[],System.Boolean)">
<summary>
Perform a set based update using the specified index
</summary>
<param name="indexName">Name of the index.</param>
<param name="queryToUpdate">The query to update.</param>
<param name="patchRequests">The patch requests.</param>
<param name="allowStale">if set to <c>true</c> [allow stale].</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.ForDatabase(System.String)">
<summary>
Create a new instance of <see cref="T:Raven.Client.Connection.IDatabaseCommands"/> that will interacts
with the specified database
</summary>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.ForDefaultDatabase">
<summary>
Create a new instance of <see cref="T:Raven.Client.Connection.IDatabaseCommands"/> that will interacts
with the default database
</summary>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.GetRootDatabase">
<summary>
Create a new instance of <see cref="T:Raven.Client.Connection.IDatabaseCommands"/> that will interact
with the root database. Useful if the database has works against a tenant database
</summary>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Suggest(System.String,Raven.Abstractions.Data.SuggestionQuery)">
<summary>
Returns a list of suggestions based on the specified suggestion query
</summary>
<param name="index">The index to query for suggestions</param>
<param name="suggestionQuery">The suggestion query.</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.GetTerms(System.String,System.String,System.String,System.Int32)">
<summary>
Get the all terms stored in the index for the specified field
You can page through the results by use fromValue parameter as the
starting point for the next query
</summary>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.GetFacets(System.String,Raven.Abstractions.Data.IndexQuery,System.String)">
<summary>
Using the given Index, calculate the facets as per the specified doc
</summary>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Patch(System.String,Raven.Abstractions.Data.PatchRequest[])">
<summary>
Sends a patch request for a specific document, ignoring the document's Etag
</summary>
<param name="key">Id of the document to patch</param>
<param name="patches">Array of patch requests</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Patch(System.String,Raven.Abstractions.Data.PatchRequest[],System.Nullable{System.Guid})">
<summary>
Sends a patch request for a specific document
</summary>
<param name="key">Id of the document to patch</param>
<param name="patches">Array of patch requests</param>
<param name="etag">Require specific Etag [null to ignore]</param>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.DisableAllCaching">
<summary>
Disable all caching within the given scope
</summary>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.MultiGet(Raven.Abstractions.Data.GetRequest[])">
<summary>
Perform a single POST requst containing multiple nested GET requests
</summary>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.GetStatistics">
<summary>
Retrieve the statistics for the database
</summary>
</member>
<member name="M:Raven.Client.Connection.IDatabaseCommands.Head(System.String)">
<summary>
Retrieves the document metadata for the specified document key.
</summary>
<param name="key">The key.</param>
<returns>The document metadata for the specifed document, or null if the document does not exist</returns>
</member>
<member name="P:Raven.Client.Connection.IDatabaseCommands.OperationsHeaders">
<summary>
Gets or sets the operations headers
</summary>
<value>The operations headers.</value>
</member>
<member name="P:Raven.Client.Connection.IDatabaseCommands.SupportsPromotableTransactions">
<summary>
Gets a value indicating whether [supports promotable transactions].
</summary>
<value>
<c>true</c> if [supports promotable transactions]; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Raven.Client.Connection.IRavenQueryInspector">
<summary>
Provide access to the underlying <see cref="T:Raven.Client.IDocumentQuery`1"/>
</summary>
</member>
<member name="M:Raven.Client.Connection.IRavenQueryInspector.GetLastEqualityTerm">
<summary>
The last term that we asked the query to use equals on
</summary>
</member>
<member name="P:Raven.Client.Connection.IRavenQueryInspector.IndexQueried">
<summary>
Get the name of the index being queried
</summary>
</member>
<member name="P:Raven.Client.Connection.IRavenQueryInspector.DatabaseCommands">
<summary>
Grant access to the database commands
</summary>
</member>
<member name="T:Raven.Client.Connection.JsonExtensions">
<summary>
Extension to json objects
</summary>
</member>
<member name="M:Raven.Client.Connection.JsonExtensions.Deserialize``1(Raven.Json.Linq.RavenJObject,Raven.Client.Document.DocumentConvention)">
<summary>
Deserializes the specified instance <param name="self"/> to an instance of <typeparam name="T"/> using the specified <param name="convention"/>
</summary>
</member>
<member name="M:Raven.Client.Connection.JsonExtensions.Deserialize(Raven.Json.Linq.RavenJObject,System.Type,Raven.Client.Document.DocumentConvention)">
<summary>
Deserializes the specified instance <param name="self"/> to an instance of <param name="type"/> using the specified <param name="convention"/>
</summary>
</member>
<member name="T:Raven.Client.Connection.JsonLuceneDateTimeConverter">
<summary>
Convert a lucene data format to and from json values
</summary>
</member>
<member name="M:Raven.Client.Connection.JsonLuceneDateTimeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Raven.Client.Connection.JsonLuceneDateTimeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Raven.Client.Connection.JsonLuceneDateTimeConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="P:Raven.Client.Connection.JsonLuceneDateTimeConverter.CanWrite">
<summary>
Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON.
</summary>
<value>
<c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Raven.Client.Connection.Profiling.RequestStatus">
<summary>
The status of the request
</summary>
</member>
<member name="F:Raven.Client.Connection.Profiling.RequestStatus.SentToServer">
<summary>
The request was sent to the server
</summary>
</member>
<member name="F:Raven.Client.Connection.Profiling.RequestStatus.Cached">
<summary>
The request was served directly from the local cache
after checking with the server to see if it was still
up to date
</summary>
</member>
<member name="F:Raven.Client.Connection.Profiling.RequestStatus.AggresivelyCached">
<summary>
The request was served from the local cache without
checking with the server and may be out of date
</summary>
</member>
<member name="F:Raven.Client.Connection.Profiling.RequestStatus.ErrorOnServer">
<summary>
The server returned an error
</summary>
</member>
<member name="T:Raven.Client.Connection.Profiling.RequestResultArgs">
<summary>
The result of a request made to the server
</summary>
</member>
<member name="M:Raven.Client.Connection.Profiling.RequestResultArgs.#ctor">
<summary>
Creates a new instance of <seealso cref="T:Raven.Client.Connection.Profiling.RequestResultArgs"/>
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.RequestResultArgs.AdditionalInformation">
<summary>
Any additional information that might be required
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.RequestResultArgs.At">
<summary>
When the request completed
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.RequestResultArgs.Status">
<summary>
The request status
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.RequestResultArgs.Url">
<summary>
The request Url
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.RequestResultArgs.DurationMilliseconds">
<summary>
How long this request took
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.RequestResultArgs.Method">
<summary>
The request method
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.RequestResultArgs.PostedData">
<summary>
The data posted to the server
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.RequestResultArgs.HttpResult">
<summary>
The HTTP result for this request
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.RequestResultArgs.Result">
<summary>
The result of this request
</summary>
</member>
<member name="T:Raven.Client.Connection.Profiling.ProfilingInformation">
<summary>
Information about a particular session
</summary>
</member>
<member name="M:Raven.Client.Connection.Profiling.ProfilingInformation.CreateProfilingInformation(System.Nullable{System.Guid})">
<summary>
Create a new instance of profiling information and provide additional context information
</summary>
</member>
<member name="F:Raven.Client.Connection.Profiling.ProfilingInformation.Requests">
<summary>
The requests made by this session
</summary>
</member>
<member name="F:Raven.Client.Connection.Profiling.ProfilingInformation.Id">
<summary>
Uniquely identify the session
</summary>
</member>
<member name="F:Raven.Client.Connection.Profiling.ProfilingInformation.At">
<summary>
The time when the session was created
</summary>
</member>
<member name="F:Raven.Client.Connection.Profiling.ProfilingInformation.DurationMilliseconds">
<summary>
The duration this session was opened
</summary>
</member>
<member name="M:Raven.Client.Connection.Profiling.ProfilingInformation.#ctor(System.Nullable{System.Guid})">
<summary>
Create a new instance of this class
</summary>
</member>
<member name="E:Raven.Client.Connection.Profiling.ProfilingInformation.OnContextCreated">
<summary>
A hook that allows extensions to provide additional information about the created context
</summary>
</member>
<member name="P:Raven.Client.Connection.Profiling.ProfilingInformation.Context">
<summary>
Additional information that is added by extension
</summary>
</member>
<member name="T:Raven.Client.Connection.RavenQuery">
<summary>
Helper class that provide a way to escape query terms
</summary>
</member>
<member name="M:Raven.Client.Connection.RavenQuery.Escape(System.String)">
<summary>
Escapes Lucene operators and quotes phrases
</summary>
</member>
<member name="M:Raven.Client.Connection.RavenQuery.Escape(System.String,System.Boolean)">
<summary>
Escapes Lucene operators and quotes phrases
</summary>
<param name="term"></param>
<param name="allowWildcards"></param>
<returns>escaped term</returns>
<remarks>
http://lucene.apache.org/java/2_4_0/queryparsersyntax.html#Escaping%20Special%20Characters
</remarks>
</member>
<member name="T:Raven.Client.Connection.RavenTransactionAccessor">
<summary>
Provide access to the current transaction
</summary>
</member>
<member name="M:Raven.Client.Connection.RavenTransactionAccessor.GetTransactionInformation">
<summary>
Gets the transaction information for the current transaction
</summary>
<returns></returns>
</member>
<member name="T:Raven.Client.Connection.ReplicationInformer">
<summary>
Replication and failover management on the client side
</summary>
</member>
<member name="M:Raven.Client.Connection.ReplicationInformer.#ctor(Raven.Client.Document.DocumentConvention)">
<summary>
Create a new instance of this class
</summary>
</member>
<member name="M:Raven.Client.Connection.ReplicationInformer.UpdateReplicationInformationIfNeeded(Raven.Client.Connection.ServerClient)">
<summary>
Updates the replication information if needed.
</summary>
<param name="serverClient">The server client.</param>
</member>
<member name="M:Raven.Client.Connection.ReplicationInformer.GetFailureCount(System.String)">
<summary>
Get the current failure count for the url
</summary>
</member>
<member name="M:Raven.Client.Connection.ReplicationInformer.ShouldExecuteUsing(System.String,System.Int32,System.String,System.Boolean)">
<summary>
Should execute the operation using the specified operation URL
</summary>
</member>
<member name="M:Raven.Client.Connection.ReplicationInformer.IsFirstFailure(System.String)">
<summary>
Determines whether this is the first failure on the specified operation URL.
</summary>
<param name="operationUrl">The operation URL.</param>
</member>
<member name="M:Raven.Client.Connection.ReplicationInformer.IncrementFailureCount(System.String)">
<summary>
Increments the failure count for the specified operation URL
</summary>
<param name="operationUrl">The operation URL.</param>
</member>
<member name="M:Raven.Client.Connection.ReplicationInformer.RefreshReplicationInformation(Raven.Client.Connection.ServerClient)">
<summary>
Refreshes the replication information.
Expert use only.
</summary>
</member>
<member name="M:Raven.Client.Connection.ReplicationInformer.ResetFailureCount(System.String)">
<summary>
Resets the failure count for the specified URL
</summary>
<param name="operationUrl">The operation URL.</param>
</member>
<member name="E:Raven.Client.Connection.ReplicationInformer.FailoverStatusChanged">
<summary>
Notify when the failover status changed
</summary>
</member>
<member name="P:Raven.Client.Connection.ReplicationInformer.ReplicationDestinations">
<summary>
Gets the replication destinations.
</summary>
<value>The replication destinations.</value>
</member>
<member name="T:Raven.Client.Connection.FailoverStatusChangedEventArgs">
<summary>
The event arguments for when the failover status changed
</summary>
</member>
<member name="P:Raven.Client.Connection.FailoverStatusChangedEventArgs.Failing">
<summary>
Whatever that url is now failing
</summary>
</member>
<member name="P:Raven.Client.Connection.FailoverStatusChangedEventArgs.Url">
<summary>
The url whose failover status changed
</summary>
</member>
<member name="T:Raven.Client.Connection.SerializationHelper">
<summary>
Helper method to do serialization from RavenJObject to JsonDocument
</summary>
</member>
<member name="M:Raven.Client.Connection.SerializationHelper.RavenJObjectsToJsonDocuments(System.Collections.Generic.IEnumerable{Raven.Json.Linq.RavenJObject})">
<summary>
Translate a collection of RavenJObject to JsonDocuments
</summary>
</member>
<member name="M:Raven.Client.Connection.SerializationHelper.ToJsonDocuments(System.Collections.Generic.IEnumerable{Raven.Json.Linq.RavenJObject})">
<summary>
Translate a collection of RavenJObject to JsonDocuments
</summary>
</member>
<member name="M:Raven.Client.Connection.SerializationHelper.ToJsonDocument(Raven.Json.Linq.RavenJObject)">
<summary>
Translate a collection of RavenJObject to JsonDocuments
</summary>
</member>
<member name="M:Raven.Client.Connection.SerializationHelper.ToQueryResult(Raven.Json.Linq.RavenJObject,System.String)">
<summary>
Translate a result for a query
</summary>
</member>
<member name="M:Raven.Client.Connection.SerializationHelper.DeserializeJsonDocument(System.String,Raven.Json.Linq.RavenJToken,System.Collections.Specialized.NameValueCollection,System.Net.HttpStatusCode)">
<summary>
Deserialize a request to a JsonDocument
</summary>
</member>
<member name="M:Raven.Client.Connection.SerializationHelper.DeserializeJsonDocumentMetadata(System.String,System.Collections.Specialized.NameValueCollection,System.Net.HttpStatusCode)">
<summary>
Deserialize a request to a JsonDocument
</summary>
</member>
<member name="T:Raven.Client.Connection.ServerClient">
<summary>
Access the RavenDB operations using HTTP
</summary>
</member>
<member name="M:Raven.Client.Connection.ServerClient.#ctor(System.String,Raven.Client.Document.DocumentConvention,System.Net.ICredentials,Raven.Client.Connection.ReplicationInformer,Raven.Client.Connection.HttpJsonRequestFactory,System.Nullable{System.Guid})">
<summary>
Initializes a new instance of the <see cref="T:Raven.Client.Connection.ServerClient"/> class.
</summary>
</member>
<member name="M:Raven.Client.Connection.ServerClient.Get(System.String)">
<summary>
Gets the document for the specified key.
</summary>
<param name="key">The key.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.StartsWith(System.String,System.Int32,System.Int32)">
<summary>
Gets documents for the specified key prefix
</summary>
</member>
<member name="M:Raven.Client.Connection.ServerClient.ExecuteGetRequest(System.String)">
<summary>
Execute a GET request against the provided url
and return the result as a json object
</summary>
<param name="requestUrl">The relative url to the server</param>
<remarks>
This method respects the replication semantics against the database.
</remarks>
</member>
<member name="M:Raven.Client.Connection.ServerClient.InFailoverMode">
<summary>
Allow to query whatever we are in failover mode or not
</summary>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.DirectGet(System.String,System.String)">
<summary>
Perform a direct get for a document with the specified key on the specified server URL.
</summary>
<param name="serverUrl">The server URL.</param>
<param name="key">The key.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.Put(System.String,System.Nullable{System.Guid},Raven.Json.Linq.RavenJObject,Raven.Json.Linq.RavenJObject)">
<summary>
Puts the document with the specified key in the database
</summary>
<param name="key">The key.</param>
<param name="etag">The etag.</param>
<param name="document">The document.</param>
<param name="metadata">The metadata.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.Delete(System.String,System.Nullable{System.Guid})">
<summary>
Deletes the document with the specified key.
</summary>
<param name="key">The key.</param>
<param name="etag">The etag.</param>
</member>
<member name="M:Raven.Client.Connection.ServerClient.PutAttachment(System.String,System.Nullable{System.Guid},System.IO.Stream,Raven.Json.Linq.RavenJObject)">
<summary>
Puts the attachment with the specified key
</summary>
<param name="key">The key.</param>
<param name="etag">The etag.</param>
<param name="data">The data.</param>
<param name="metadata">The metadata.</param>
</member>
<member name="M:Raven.Client.Connection.ServerClient.GetAttachment(System.String)">
<summary>
Gets the attachment by the specified key
</summary>
<param name="key">The key.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.DeleteAttachment(System.String,System.Nullable{System.Guid})">
<summary>
Deletes the attachment with the specified key
</summary>
<param name="key">The key.</param>
<param name="etag">The etag.</param>
</member>
<member name="M:Raven.Client.Connection.ServerClient.GetIndexNames(System.Int32,System.Int32)">
<summary>
Gets the index names from the server
</summary>
<param name="start">Paging start</param>
<param name="pageSize">Size of the page.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.ResetIndex(System.String)">
<summary>
Resets the specified index
</summary>
<param name="name">The name.</param>
</member>
<member name="M:Raven.Client.Connection.ServerClient.GetIndex(System.String)">
<summary>
Gets the index definition for the specified name
</summary>
<param name="name">The name.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.PutIndex(System.String,Raven.Abstractions.Indexing.IndexDefinition)">
<summary>
Puts the index.
</summary>
<param name="name">The name.</param>
<param name="definition">The definition.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.PutIndex(System.String,Raven.Abstractions.Indexing.IndexDefinition,System.Boolean)">
<summary>
Puts the index.
</summary>
<param name="name">The name.</param>
<param name="definition">The definition.</param>
<param name="overwrite">if set to <c>true</c> overwrite the index.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.PutIndex``2(System.String,Raven.Client.Indexes.IndexDefinitionBuilder{``0,``1})">
<summary>
Puts the index definition for the specified name
</summary>
<typeparam name="TDocument">The type of the document.</typeparam>
<typeparam name="TReduceResult">The type of the reduce result.</typeparam>
<param name="name">The name.</param>
<param name="indexDef">The index def.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.PutIndex``2(System.String,Raven.Client.Indexes.IndexDefinitionBuilder{``0,``1},System.Boolean)">
<summary>
Puts the index for the specified name
</summary>
<typeparam name="TDocument">The type of the document.</typeparam>
<typeparam name="TReduceResult">The type of the reduce result.</typeparam>
<param name="name">The name.</param>
<param name="indexDef">The index def.</param>
<param name="overwrite">if set to <c>true</c> [overwrite].</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.Query(System.String,Raven.Abstractions.Data.IndexQuery,System.String[])">
<summary>
Queries the specified index.
</summary>
<param name="index">The index.</param>
<param name="query">The query.</param>
<param name="includes">The includes.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.DeleteIndex(System.String)">
<summary>
Deletes the index.
</summary>
<param name="name">The name.</param>
</member>
<member name="M:Raven.Client.Connection.ServerClient.Get(System.String[],System.String[])">
<summary>
Gets the results for the specified ids.
</summary>
<param name="ids">The ids.</param>
<param name="includes">The includes.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.DirectGet(System.String[],System.String,System.String[])">
<summary>
Perform a direct get for loading multiple ids in one request
</summary>
<param name="ids">The ids.</param>
<param name="operationUrl">The operation URL.</param>
<param name="includes">The includes.</param>
<returns></returns>
</member>
<member name="M:Raven.Client.Connection.ServerClient.Batch(System.Collections.Generic.IEnumerable{Raven.Abstractions.Commands.ICommandData})">
<summary>
Executed the specified commands as a single batch
</summary>
<param name="commandDatas">The command data.</param>
<returns></returns>