-
Notifications
You must be signed in to change notification settings - Fork 255
/
Database.xml
1479 lines (1472 loc) · 113 KB
/
Database.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
<Type Name="Database" FullName="Microsoft.Azure.Cosmos.Database">
<TypeSignature Language="C#" Value="public abstract class Database" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Database extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.Database" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class Database" />
<TypeSignature Language="F#" Value="type Database = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.36.0.0</AssemblyVersion>
<AssemblyVersion>3.38.1.0</AssemblyVersion>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Operations for reading or deleting an existing database.
See <see cref="P:Microsoft.Azure.Cosmos.Database.Client" /> for creating new databases, and reading/querying all databases; use `client.Databases`.
</summary>
<remarks>
Note: all these operations make calls against a fixed budget.
You should design your system such that these calls scale sub-linearly with your application.
For instance, do not call `database.ReadAsync()` before every single `container.ReadItemAsync()` call to ensure the database exists;
do this once on application start up.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Database ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Client">
<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.CosmosClient Client { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.CosmosClient Client" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Database.Client" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Client As CosmosClient" />
<MemberSignature Language="F#" Value="member this.Client : Microsoft.Azure.Cosmos.CosmosClient" Usage="Microsoft.Azure.Cosmos.Database.Client" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.CosmosClient</ReturnType>
</ReturnValue>
<Docs>
<summary>
The parent Cosmos client instance related the database instance
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateClientEncryptionKeyAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ClientEncryptionKeyResponse> CreateClientEncryptionKeyAsync (Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties clientEncryptionKeyProperties, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.ClientEncryptionKeyResponse> CreateClientEncryptionKeyAsync(class Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties clientEncryptionKeyProperties, class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.CreateClientEncryptionKeyAsync(Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties,Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateClientEncryptionKeyAsync (clientEncryptionKeyProperties As ClientEncryptionKeyProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientEncryptionKeyResponse)" />
<MemberSignature Language="F#" Value="abstract member CreateClientEncryptionKeyAsync : Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ClientEncryptionKeyResponse>" Usage="database.CreateClientEncryptionKeyAsync (clientEncryptionKeyProperties, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ClientEncryptionKeyResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="clientEncryptionKeyProperties" Type="Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="clientEncryptionKeyProperties">Client encryption key properties.</param>
<param name="requestOptions">(Optional) The options for the request.</param>
<param name="cancellationToken">(Optional) Token representing request cancellation.</param>
<summary>
Saves the client encryption key as an asynchronous operation in the Azure Cosmos service.
This method is not meant to be invoked directly. Please see https://aka.ms/CosmosClientEncryption in order to use client-side encryption.
</summary>
<returns>An awaitable response which wraps a <see cref="T:Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties" /> containing the read resource record.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateContainerAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerAsync (Microsoft.Azure.Cosmos.ContainerProperties containerProperties, Microsoft.Azure.Cosmos.ThroughputProperties throughputProperties, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerAsync(class Microsoft.Azure.Cosmos.ContainerProperties containerProperties, class Microsoft.Azure.Cosmos.ThroughputProperties throughputProperties, class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.CreateContainerAsync(Microsoft.Azure.Cosmos.ContainerProperties,Microsoft.Azure.Cosmos.ThroughputProperties,Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateContainerAsync (containerProperties As ContainerProperties, throughputProperties As ThroughputProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)" />
<MemberSignature Language="F#" Value="abstract member CreateContainerAsync : Microsoft.Azure.Cosmos.ContainerProperties * Microsoft.Azure.Cosmos.ThroughputProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>" Usage="database.CreateContainerAsync (containerProperties, throughputProperties, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="containerProperties" Type="Microsoft.Azure.Cosmos.ContainerProperties" />
<Parameter Name="throughputProperties" Type="Microsoft.Azure.Cosmos.ThroughputProperties" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="containerProperties">The <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> object.</param>
<param name="throughputProperties">(Optional) The throughput provisioned for a container in measurement of Requests Units per second in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
Creates a container as an asynchronous operation in the Azure Cosmos service.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ContainerResponse" /> which wraps a <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> containing the read resource record.</returns>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
ContainerProperties containerProperties = new ContainerProperties()
{
Id = Guid.NewGuid().ToString(),
PartitionKeyPath = "/pk",
IndexingPolicy = new IndexingPolicy()
{
Automatic = false,
IndexingMode = IndexingMode.Lazy,
}
};
ContainerResponse response = await this.cosmosDatabase.CreateContainerAsync(
containerProperties,
ThroughputProperties.CreateAutoscaleThroughput(10000));
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="CreateContainerAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerAsync (Microsoft.Azure.Cosmos.ContainerProperties containerProperties, int? throughput = default, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerAsync(class Microsoft.Azure.Cosmos.ContainerProperties containerProperties, valuetype System.Nullable`1<int32> throughput, class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.CreateContainerAsync(Microsoft.Azure.Cosmos.ContainerProperties,System.Nullable{System.Int32},Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateContainerAsync (containerProperties As ContainerProperties, Optional throughput As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)" />
<MemberSignature Language="F#" Value="abstract member CreateContainerAsync : Microsoft.Azure.Cosmos.ContainerProperties * Nullable<int> * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>" Usage="database.CreateContainerAsync (containerProperties, throughput, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="containerProperties" Type="Microsoft.Azure.Cosmos.ContainerProperties" />
<Parameter Name="throughput" Type="System.Nullable<System.Int32>" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="containerProperties">The <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> object.</param>
<param name="throughput">(Optional) The throughput provisioned for a container in measurement of Requests Units per second in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
Creates a container as an asynchronous operation in the Azure Cosmos service.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ContainerResponse" /> which wraps a <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> containing the read resource record.</returns>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
ContainerProperties containerProperties = new ContainerProperties()
{
Id = Guid.NewGuid().ToString(),
PartitionKeyPath = "/pk",
IndexingPolicy = new IndexingPolicy()
{
Automatic = false,
IndexingMode = IndexingMode.Lazy,
}
};
ContainerResponse response = await this.cosmosDatabase.CreateContainerAsync(containerProperties);
]]></code>
</example>
<altmember cref="M:Microsoft.Azure.Cosmos.Database.DefineContainer(System.String,System.String)" />
</Docs>
</Member>
<Member MemberName="CreateContainerAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerAsync (string id, string partitionKeyPath, int? throughput = default, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerAsync(string id, string partitionKeyPath, valuetype System.Nullable`1<int32> throughput, class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.CreateContainerAsync(System.String,System.String,System.Nullable{System.Int32},Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateContainerAsync (id As String, partitionKeyPath As String, Optional throughput As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)" />
<MemberSignature Language="F#" Value="abstract member CreateContainerAsync : string * string * Nullable<int> * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>" Usage="database.CreateContainerAsync (id, partitionKeyPath, throughput, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="partitionKeyPath" Type="System.String" />
<Parameter Name="throughput" Type="System.Nullable<System.Int32>" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="id">The Cosmos container id</param>
<param name="partitionKeyPath">The path to the partition key. Example: /location</param>
<param name="throughput">(Optional) The throughput provisioned for a container in measurement of Requests Units per second in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
Creates a container as an asynchronous operation in the Azure Cosmos service.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ContainerResponse" /> which wraps a <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> containing the read resource record.</returns>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
ContainerResponse response = await this.cosmosDatabase.CreateContainerAsync(Guid.NewGuid().ToString(), "/pk");
]]></code>
</example>
<altmember cref="M:Microsoft.Azure.Cosmos.Database.DefineContainer(System.String,System.String)" />
</Docs>
</Member>
<Member MemberName="CreateContainerIfNotExistsAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerIfNotExistsAsync (Microsoft.Azure.Cosmos.ContainerProperties containerProperties, Microsoft.Azure.Cosmos.ThroughputProperties throughputProperties, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerIfNotExistsAsync(class Microsoft.Azure.Cosmos.ContainerProperties containerProperties, class Microsoft.Azure.Cosmos.ThroughputProperties throughputProperties, class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.CreateContainerIfNotExistsAsync(Microsoft.Azure.Cosmos.ContainerProperties,Microsoft.Azure.Cosmos.ThroughputProperties,Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateContainerIfNotExistsAsync (containerProperties As ContainerProperties, throughputProperties As ThroughputProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)" />
<MemberSignature Language="F#" Value="abstract member CreateContainerIfNotExistsAsync : Microsoft.Azure.Cosmos.ContainerProperties * Microsoft.Azure.Cosmos.ThroughputProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>" Usage="database.CreateContainerIfNotExistsAsync (containerProperties, throughputProperties, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="containerProperties" Type="Microsoft.Azure.Cosmos.ContainerProperties" />
<Parameter Name="throughputProperties" Type="Microsoft.Azure.Cosmos.ThroughputProperties" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="containerProperties">The <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> object.</param>
<param name="throughputProperties">(Optional) The throughput provisioned for a container in measurement of Requests Units per second in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
<para>Check if a container exists, and if it doesn't, create it.
Only the container id is used to verify if there is an existing container. Other container properties such as throughput are not validated and can be different then the passed properties.</para>
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ContainerResponse" /> which wraps a <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> containing the read resource record.
<list type="table"><listheader><term>StatusCode</term><description>Common success StatusCodes for the CreateDatabaseIfNotExistsAsync operation</description></listheader><item><term>201</term><description>Created - New database is created.</description></item><item><term>200</term><description>OK - This means the database already exists.</description></item></list></returns>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
ContainerProperties containerProperties = new ContainerProperties()
{
Id = Guid.NewGuid().ToString(),
PartitionKeyPath = "/pk",
IndexingPolicy = new IndexingPolicy()
{
Automatic = false,
IndexingMode = IndexingMode.Lazy,
}
};
ContainerResponse response = await this.cosmosDatabase.CreateContainerIfNotExistsAsync(
containerProperties,
ThroughputProperties.CreateAutoscaleThroughput(5000));
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="CreateContainerIfNotExistsAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerIfNotExistsAsync (Microsoft.Azure.Cosmos.ContainerProperties containerProperties, int? throughput = default, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerIfNotExistsAsync(class Microsoft.Azure.Cosmos.ContainerProperties containerProperties, valuetype System.Nullable`1<int32> throughput, class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.CreateContainerIfNotExistsAsync(Microsoft.Azure.Cosmos.ContainerProperties,System.Nullable{System.Int32},Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateContainerIfNotExistsAsync (containerProperties As ContainerProperties, Optional throughput As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)" />
<MemberSignature Language="F#" Value="abstract member CreateContainerIfNotExistsAsync : Microsoft.Azure.Cosmos.ContainerProperties * Nullable<int> * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>" Usage="database.CreateContainerIfNotExistsAsync (containerProperties, throughput, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="containerProperties" Type="Microsoft.Azure.Cosmos.ContainerProperties" />
<Parameter Name="throughput" Type="System.Nullable<System.Int32>" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="containerProperties">The <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> object.</param>
<param name="throughput">(Optional) The throughput provisioned for a container in measurement of Requests Units per second in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
<para>Check if a container exists, and if it doesn't, create it.
Only the container id is used to verify if there is an existing container. Other container properties such as throughput are not validated and can be different then the passed properties.</para>
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ContainerResponse" /> which wraps a <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> containing the read resource record.
<list type="table"><listheader><term>StatusCode</term><description>Common success StatusCodes for the CreateDatabaseIfNotExistsAsync operation</description></listheader><item><term>201</term><description>Created - New database is created.</description></item><item><term>200</term><description>OK - This means the database already exists.</description></item></list></returns>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
ContainerProperties containerProperties = new ContainerProperties()
{
Id = Guid.NewGuid().ToString(),
PartitionKeyPath = "/pk",
IndexingPolicy = new IndexingPolicy()
{
Automatic = false,
IndexingMode = IndexingMode.Lazy,
}
};
ContainerResponse response = await this.cosmosDatabase.CreateContainerIfNotExistsAsync(containerProperties);
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="CreateContainerIfNotExistsAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerIfNotExistsAsync (string id, string partitionKeyPath, int? throughput = default, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.ContainerResponse> CreateContainerIfNotExistsAsync(string id, string partitionKeyPath, valuetype System.Nullable`1<int32> throughput, class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.CreateContainerIfNotExistsAsync(System.String,System.String,System.Nullable{System.Int32},Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateContainerIfNotExistsAsync (id As String, partitionKeyPath As String, Optional throughput As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)" />
<MemberSignature Language="F#" Value="abstract member CreateContainerIfNotExistsAsync : string * string * Nullable<int> * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>" Usage="database.CreateContainerIfNotExistsAsync (id, partitionKeyPath, throughput, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="partitionKeyPath" Type="System.String" />
<Parameter Name="throughput" Type="System.Nullable<System.Int32>" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="id">The Cosmos container id</param>
<param name="partitionKeyPath">The path to the partition key. Example: /location</param>
<param name="throughput">(Optional) The throughput provisioned for a container in measurement of Request Units per second in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
Check if a container exists, and if it doesn't, create it.
This will make a read operation, and if the container is not found it will do a create operation.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ContainerResponse" /> which wraps a <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> containing the read resource record.</returns>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
ContainerResponse response = await this.cosmosDatabase.CreateContainerIfNotExistsAsync(Guid.NewGuid().ToString(), "/pk");
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="CreateContainerStreamAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage> CreateContainerStreamAsync (Microsoft.Azure.Cosmos.ContainerProperties containerProperties, Microsoft.Azure.Cosmos.ThroughputProperties throughputProperties, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.ResponseMessage> CreateContainerStreamAsync(class Microsoft.Azure.Cosmos.ContainerProperties containerProperties, class Microsoft.Azure.Cosmos.ThroughputProperties throughputProperties, class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.CreateContainerStreamAsync(Microsoft.Azure.Cosmos.ContainerProperties,Microsoft.Azure.Cosmos.ThroughputProperties,Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateContainerStreamAsync (containerProperties As ContainerProperties, throughputProperties As ThroughputProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResponseMessage)" />
<MemberSignature Language="F#" Value="abstract member CreateContainerStreamAsync : Microsoft.Azure.Cosmos.ContainerProperties * Microsoft.Azure.Cosmos.ThroughputProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage>" Usage="database.CreateContainerStreamAsync (containerProperties, throughputProperties, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="containerProperties" Type="Microsoft.Azure.Cosmos.ContainerProperties" />
<Parameter Name="throughputProperties" Type="Microsoft.Azure.Cosmos.ThroughputProperties" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="containerProperties">The <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> object.</param>
<param name="throughputProperties">(Optional) The throughput provisioned for a container in measurement of Request Units per second in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the container request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
Creates a container as an asynchronous operation in the Azure Cosmos service.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" /> containing the created resource record.</returns>
<remarks>To be added.</remarks>
<example>
Creates a container as an asynchronous operation in the Azure Cosmos service and return stream response.
<code language="c#"><![CDATA[
ContainerProperties containerProperties = new ContainerProperties()
{
Id = Guid.NewGuid().ToString(),
PartitionKeyPath = "/pk",
};
using(ResponseMessage response = await this.cosmosDatabase.CreateContainerStreamAsync(
containerProperties,
ThroughputProperties.CreateAutoscaleThroughput(10000)))
{
}
]]></code></example>
<altmember cref="M:Microsoft.Azure.Cosmos.Database.DefineContainer(System.String,System.String)" />
</Docs>
</Member>
<Member MemberName="CreateContainerStreamAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage> CreateContainerStreamAsync (Microsoft.Azure.Cosmos.ContainerProperties containerProperties, int? throughput = default, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.ResponseMessage> CreateContainerStreamAsync(class Microsoft.Azure.Cosmos.ContainerProperties containerProperties, valuetype System.Nullable`1<int32> throughput, class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.CreateContainerStreamAsync(Microsoft.Azure.Cosmos.ContainerProperties,System.Nullable{System.Int32},Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateContainerStreamAsync (containerProperties As ContainerProperties, Optional throughput As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResponseMessage)" />
<MemberSignature Language="F#" Value="abstract member CreateContainerStreamAsync : Microsoft.Azure.Cosmos.ContainerProperties * Nullable<int> * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage>" Usage="database.CreateContainerStreamAsync (containerProperties, throughput, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="containerProperties" Type="Microsoft.Azure.Cosmos.ContainerProperties" />
<Parameter Name="throughput" Type="System.Nullable<System.Int32>" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="containerProperties">The <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> object.</param>
<param name="throughput">(Optional) The throughput provisioned for a container in measurement of Request Units per second in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the container request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
Creates a container as an asynchronous operation in the Azure Cosmos service.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" /> containing the created resource record.</returns>
<remarks>To be added.</remarks>
<example>
Creates a container as an asynchronous operation in the Azure Cosmos service and return stream response.
<code language="c#"><![CDATA[
ContainerProperties containerProperties = new ContainerProperties()
{
Id = Guid.NewGuid().ToString(),
PartitionKeyPath = "/pk",
};
using(ResponseMessage response = await this.cosmosDatabase.CreateContainerStreamAsync(containerProperties))
{
}
]]></code></example>
<altmember cref="M:Microsoft.Azure.Cosmos.Database.DefineContainer(System.String,System.String)" />
</Docs>
</Member>
<Member MemberName="CreateUserAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse> CreateUserAsync (string id, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.UserResponse> CreateUserAsync(string id, class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.CreateUserAsync(System.String,Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateUserAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UserResponse)" />
<MemberSignature Language="F#" Value="abstract member CreateUserAsync : string * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse>" Usage="database.CreateUserAsync (id, requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="id">The Cosmos user id</param>
<param name="requestOptions">(Optional) The options for the user request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
Creates a user as an asynchronous operation in the Azure Cosmos service.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.UserResponse" /> which wraps a <see cref="T:Microsoft.Azure.Cosmos.UserProperties" /> containing the read resource record.</returns>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
UserResponse response = await this.cosmosDatabase.CreateUserAsync(Guid.NewGuid().ToString());
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="DefineContainer">
<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.Fluent.ContainerBuilder DefineContainer (string name, string partitionKeyPath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.Fluent.ContainerBuilder DefineContainer(string name, string partitionKeyPath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.DefineContainer(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function DefineContainer (name As String, partitionKeyPath As String) As ContainerBuilder" />
<MemberSignature Language="F#" Value="abstract member DefineContainer : string * string -> Microsoft.Azure.Cosmos.Fluent.ContainerBuilder" Usage="database.DefineContainer (name, partitionKeyPath)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.Fluent.ContainerBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="partitionKeyPath" Type="System.String" />
</Parameters>
<Docs>
<param name="name">Azure Cosmos container name to create.</param>
<param name="partitionKeyPath">The path to the partition key. Example: /partitionKey</param>
<summary>
Creates a containerBuilder.
</summary>
<returns>A fluent definition of an Azure Cosmos container.</returns>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
CosmosContainerResponse container = await this.cosmosDatabase.DefineContainer("TestContainer", "/partitionKey")
.UniqueKey()
.Path("/path1")
.Path("/path2")
.Attach()
.IndexingPolicy()
.IndexingMode(IndexingMode.Consistent)
.AutomaticIndexing(false)
.IncludedPaths()
.Path("/includepath1")
.Path("/includepath2")
.Attach()
.ExcludedPaths()
.Path("/excludepath1")
.Path("/excludepath2")
.Attach()
.CompositeIndex()
.Path("/root/leaf1")
.Path("/root/leaf2", CompositePathSortOrder.Descending)
.Attach()
.CompositeIndex()
.Path("/root/leaf3")
.Path("/root/leaf4")
.Attach()
.Attach()
.CreateAsync(5000 /* throughput /*);
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="DeleteAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.DatabaseResponse> DeleteAsync (Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.DatabaseResponse> DeleteAsync(class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.DeleteAsync(Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function DeleteAsync (Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DatabaseResponse)" />
<MemberSignature Language="F#" Value="abstract member DeleteAsync : Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.DatabaseResponse>" Usage="database.DeleteAsync (requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.DatabaseResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="requestOptions">(Optional) The options for the request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
Delete a Database from the Azure Cosmos DB service as an asynchronous operation.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.DatabaseResponse" /> which will contain information about the request issued.</returns>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
// Delete a Cosmos database
Database database = cosmosClient.GetDatabase("myDbId");
DatabaseResponse response = await database.DeleteAsync();
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="DeleteStreamAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage> DeleteStreamAsync (Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Cosmos.ResponseMessage> DeleteStreamAsync(class Microsoft.Azure.Cosmos.RequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.DeleteStreamAsync(Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function DeleteStreamAsync (Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResponseMessage)" />
<MemberSignature Language="F#" Value="abstract member DeleteStreamAsync : Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage>" Usage="database.DeleteStreamAsync (requestOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.RequestOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="requestOptions">(Optional) The options for the request.</param>
<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>
<summary>
Delete a <see cref="T:Microsoft.Azure.Cosmos.DatabaseProperties" /> from the Azure Cosmos DB service as an asynchronous operation.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" /> which will contain information about the request issued.</returns>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
// Delete a Database resource where database_id is the ID property of the Database resource you wish to delete.
Database database = this.cosmosClient.GetDatabase(database_id);
await database.DeleteStreamAsync();
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="GetClientEncryptionKey">
<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.ClientEncryptionKey GetClientEncryptionKey (string id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.ClientEncryptionKey GetClientEncryptionKey(string id) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.GetClientEncryptionKey(System.String)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetClientEncryptionKey (id As String) As ClientEncryptionKey" />
<MemberSignature Language="F#" Value="abstract member GetClientEncryptionKey : string -> Microsoft.Azure.Cosmos.ClientEncryptionKey" Usage="database.GetClientEncryptionKey id" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.ClientEncryptionKey</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.String" />
</Parameters>
<Docs>
<param name="id">Unique identifier for the client encryption key.</param>
<summary>
Returns a reference to a client encryption key object.
This method is not meant to be invoked directly. Please see https://aka.ms/CosmosClientEncryption in order to use client-side encryption.
</summary>
<returns>Client encryption key reference.</returns>
<remarks>
The reference returned doesn't guarantee existence of the client encryption key.
Please ensure it already exists or is created through <see cref="M:Microsoft.Azure.Cosmos.Database.CreateClientEncryptionKeyAsync(Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties,Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" />.
</remarks>
</Docs>
</Member>
<Member MemberName="GetClientEncryptionKeyQueryIterator">
<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.FeedIterator<Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties> GetClientEncryptionKeyQueryIterator (Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.FeedIterator`1<class Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties> GetClientEncryptionKeyQueryIterator(class Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken, class Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.GetClientEncryptionKeyQueryIterator(Microsoft.Azure.Cosmos.QueryDefinition,System.String,Microsoft.Azure.Cosmos.QueryRequestOptions)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetClientEncryptionKeyQueryIterator (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator(Of ClientEncryptionKeyProperties)" />
<MemberSignature Language="F#" Value="abstract member GetClientEncryptionKeyQueryIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties>" Usage="database.GetClientEncryptionKeyQueryIterator (queryDefinition, continuationToken, requestOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.FeedIterator<Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="queryDefinition" Type="Microsoft.Azure.Cosmos.QueryDefinition" />
<Parameter Name="continuationToken" Type="System.String" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.QueryRequestOptions" />
</Parameters>
<Docs>
<param name="queryDefinition">The Cosmos SQL query definition.</param>
<param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the request. Set <see cref="P:Microsoft.Azure.Cosmos.QueryRequestOptions.MaxItemCount" /> to restrict the number of results returned.</param>
<summary>
Returns an iterator that can be iterated to get properties of client encryption keys.
This method is not meant to be invoked directly. Please see https://aka.ms/CosmosClientEncryption in order to use client-side encryption.
</summary>
<returns>An iterator over client encryption keys.</returns>
<remarks>
<see cref="M:Microsoft.Azure.Cosmos.ClientEncryptionKey.ReadAsync(Microsoft.Azure.Cosmos.RequestOptions,System.Threading.CancellationToken)" /> is recommended for single client encryption key look-up.
</remarks>
</Docs>
</Member>
<Member MemberName="GetContainer">
<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.Container GetContainer (string id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.Container GetContainer(string id) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.GetContainer(System.String)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetContainer (id As String) As Container" />
<MemberSignature Language="F#" Value="abstract member GetContainer : string -> Microsoft.Azure.Cosmos.Container" Usage="database.GetContainer id" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.Container</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.String" />
</Parameters>
<Docs>
<param name="id">The Cosmos container id.</param>
<summary>
Returns a reference to a container object.
</summary>
<returns>Cosmos container reference</returns>
<remarks>
Returns a Container reference. Reference doesn't guarantee existence.
Please ensure container already exists or is created through a create operation.
</remarks>
<example>
<code language="c#"><![CDATA[
Database db = this.cosmosClient.GetDatabase("myDatabaseId");
Container container = db.GetContainer("testcontainer");
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="GetContainerQueryIterator<T>">
<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.FeedIterator<T> GetContainerQueryIterator<T> (Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.FeedIterator`1<!!T> GetContainerQueryIterator<T>(class Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken, class Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.GetContainerQueryIterator``1(Microsoft.Azure.Cosmos.QueryDefinition,System.String,Microsoft.Azure.Cosmos.QueryRequestOptions)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetContainerQueryIterator(Of T) (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator(Of T)" />
<MemberSignature Language="F#" Value="abstract member GetContainerQueryIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<'T>" Usage="database.GetContainerQueryIterator (queryDefinition, continuationToken, requestOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.FeedIterator<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="queryDefinition" Type="Microsoft.Azure.Cosmos.QueryDefinition" />
<Parameter Name="continuationToken" Type="System.String" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.QueryRequestOptions" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="queryDefinition">The Cosmos SQL query definition.</param>
<param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the item query request.</param>
<summary>
This method creates a query for containers under an database using a SQL statement with parameterized values. It returns a FeedIterator.
For more information on preparing SQL statements with parameterized values, please see <see cref="T:Microsoft.Azure.Cosmos.QueryDefinition" /> overload.
</summary>
<returns>An iterator to go through the containers</returns>
<remarks>
Refer to https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started for syntax and examples.
<para><see cref="M:Microsoft.Azure.Cosmos.Container.ReadContainerAsync(Microsoft.Azure.Cosmos.ContainerRequestOptions,System.Threading.CancellationToken)" /> is recommended for single container look-up.
</para></remarks>
<example>
This create the type feed iterator for containers with queryDefinition as input.
<code language="c#"><![CDATA[
QueryDefinition queryDefinition = new QueryDefinition("SELECT * FROM c where c.status like @status");
.WithParameter("@status", "start%");
using (FeedIterator<ContainerProperties> feedIterator = this.cosmosDatabase.GetContainerQueryIterator<ContainerProperties>(queryDefinition))
{
while (feedIterator.HasMoreResults)
{
FeedResponse<ContainerProperties> response = await feedIterator.ReadNextAsync();
foreach (var container in response)
{
Console.WriteLine(container);
}
}
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetContainerQueryIterator<T>">
<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.FeedIterator<T> GetContainerQueryIterator<T> (string queryText = default, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.FeedIterator`1<!!T> GetContainerQueryIterator<T>(string queryText, string continuationToken, class Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.GetContainerQueryIterator``1(System.String,System.String,Microsoft.Azure.Cosmos.QueryRequestOptions)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetContainerQueryIterator(Of T) (Optional queryText As String = Nothing, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator(Of T)" />
<MemberSignature Language="F#" Value="abstract member GetContainerQueryIterator : string * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<'T>" Usage="database.GetContainerQueryIterator (queryText, continuationToken, requestOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.FeedIterator<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="queryText" Type="System.String" />
<Parameter Name="continuationToken" Type="System.String" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.QueryRequestOptions" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="queryText">The Cosmos SQL query text.</param>
<param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the item query request.</param>
<summary>
This method creates a query for containers under an database using a SQL statement. It returns a FeedIterator.
</summary>
<returns>An iterator to go through the containers</returns>
<remarks>
Refer to https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started for syntax and examples.
<para><see cref="M:Microsoft.Azure.Cosmos.Container.ReadContainerAsync(Microsoft.Azure.Cosmos.ContainerRequestOptions,System.Threading.CancellationToken)" /> is recommended for single container look-up.
</para></remarks>
<example>
1. This create the type feed iterator for containers with queryText as input,
<code language="c#"><![CDATA[
string queryText = "SELECT * FROM c where c.status like 'start%'";
using (FeedIterator<ContainerProperties> feedIterator = this.cosmosDatabase.GetContainerQueryIterator<ContainerProperties>(queryText))
{
while (feedIterator.HasMoreResults)
{
FeedResponse<ContainerProperties> response = await feedIterator.ReadNextAsync();
foreach (var container in response)
{
Console.WriteLine(container);
}
}
}
]]></code></example>
<example>
2. This create the type feed iterator for containers without queryText, retrieving all containers.
<code language="c#"><![CDATA[
using (FeedIterator<ContainerProperties> feedIterator = this.cosmosDatabase.GetContainerQueryIterator<ContainerProperties>())
{
while (feedIterator.HasMoreResults)
{
FeedResponse<ContainerProperties> response = await feedIterator.ReadNextAsync();
foreach (var container in response)
{
Console.WriteLine(container);
}
}
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetContainerQueryStreamIterator">
<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.FeedIterator GetContainerQueryStreamIterator (Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.FeedIterator GetContainerQueryStreamIterator(class Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken, class Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.GetContainerQueryStreamIterator(Microsoft.Azure.Cosmos.QueryDefinition,System.String,Microsoft.Azure.Cosmos.QueryRequestOptions)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetContainerQueryStreamIterator (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator" />
<MemberSignature Language="F#" Value="abstract member GetContainerQueryStreamIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator" Usage="database.GetContainerQueryStreamIterator (queryDefinition, continuationToken, requestOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.FeedIterator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="queryDefinition" Type="Microsoft.Azure.Cosmos.QueryDefinition" />
<Parameter Name="continuationToken" Type="System.String" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.QueryRequestOptions" />
</Parameters>
<Docs>
<param name="queryDefinition">The Cosmos SQL query definition.</param>
<param name="continuationToken">The continuation token in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the container request.</param>
<summary>
This method creates a query for containers under an database using a SQL statement with parameterized values. It returns a FeedIterator.
For more information on preparing SQL statements with parameterized values, please see <see cref="T:Microsoft.Azure.Cosmos.QueryDefinition" /> overload.
</summary>
<returns>An iterator to go through the containers</returns>
<remarks>
Refer to https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started for syntax and examples.
<para><see cref="M:Microsoft.Azure.Cosmos.Container.ReadContainerStreamAsync(Microsoft.Azure.Cosmos.ContainerRequestOptions,System.Threading.CancellationToken)" /> is recommended for single container look-up.
</para></remarks>
<example>
This create the stream feed iterator for containers with queryDefinition as input.
<code language="c#"><![CDATA[
string queryText = "SELECT c.id FROM c where c.status like 'start%'";
QueryDefinition queryDefinition = new QueryDefinition(queryText);
using (FeedIterator feedIterator = this.cosmosDatabase.GetContainerQueryStreamIterator(queryDefinition))
{
while (feedIterator.HasMoreResults)
{
using (ResponseMessage response = await feedIterator.ReadNextAsync())
{
response.EnsureSuccessStatusCode();
using (StreamReader sr = new StreamReader(response.Content))
using (JsonTextReader jtr = new JsonTextReader(sr))
{
// The stream content contains the following JSON structure
// {"_rid":"FwsdAA==","DocumentCollections":[{"id":"container1"},{"id":"container2"}],"_count":2}
JObject result = JObject.Load(jtr);
}
}
}
}
]]></code></example>
<example>
This creates feed iterator to get a list of all the container ids
<code language="c#"><![CDATA[
using (FeedIterator feedIterator = this.cosmosDatabase.GetContainerQueryStreamIterator(
new QueryDefinition("select value c.id From c ")))
{
while (feedIterator.HasMoreResults)
{
using (ResponseMessage response = await feedIterator.ReadNextAsync())
{
response.EnsureSuccessStatusCode();
using (StreamReader streamReader = new StreamReader(response.Content))
using (JsonTextReader jsonTextReader = new JsonTextReader(streamReader))
{
// The stream content contains the following JSON structure
// {"_rid":"7p8wAA==","DocumentCollections":["container1","container2"],"_count":2}
JObject jObject = await JObject.LoadAsync(jsonTextReader);
}
}
}
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetContainerQueryStreamIterator">
<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.FeedIterator GetContainerQueryStreamIterator (string queryText = default, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.FeedIterator GetContainerQueryStreamIterator(string queryText, string continuationToken, class Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Database.GetContainerQueryStreamIterator(System.String,System.String,Microsoft.Azure.Cosmos.QueryRequestOptions)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetContainerQueryStreamIterator (Optional queryText As String = Nothing, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator" />
<MemberSignature Language="F#" Value="abstract member GetContainerQueryStreamIterator : string * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator" Usage="database.GetContainerQueryStreamIterator (queryText, continuationToken, requestOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.FeedIterator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="queryText" Type="System.String" />
<Parameter Name="continuationToken" Type="System.String" />
<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.QueryRequestOptions" />
</Parameters>
<Docs>
<param name="queryText">The Cosmos SQL query text.</param>
<param name="continuationToken">The continuation token in the Azure Cosmos DB service.</param>
<param name="requestOptions">(Optional) The options for the container request.</param>
<summary>
This method creates a query for containers under an database using a SQL statement. It returns a FeedIterator.
</summary>
<returns>An iterator to go through the containers</returns>
<remarks>
Refer to https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started for syntax and examples.
<para><see cref="M:Microsoft.Azure.Cosmos.Container.ReadContainerStreamAsync(Microsoft.Azure.Cosmos.ContainerRequestOptions,System.Threading.CancellationToken)" /> is recommended for single container look-up.
</para></remarks>
<example>
This create the stream feed iterator for containers with queryDefinition as input.
<code language="c#"><![CDATA[
using (FeedIterator feedIterator = this.cosmosDatabase.GetContainerQueryStreamIterator(
"SELECT c.id FROM c where c.status like 'start%'"))
{
while (feedIterator.HasMoreResults)
{
using (ResponseMessage response = await feedIterator.ReadNextAsync())
{
response.EnsureSuccessStatusCode();
using (StreamReader sr = new StreamReader(response.Content))
using (JsonTextReader jtr = new JsonTextReader(sr))
{
// The stream content contains the following JSON structure
// {"_rid":"FwsdAA==","DocumentCollections":[{"id":"container1"},{"id":"container2"}],"_count":2}
JObject result = JObject.Load(jtr);
}
}
}
}
]]></code></example>
<example>
This creates feed iterator to get a list of all the container ids
<code language="c#"><![CDATA[
using (FeedIterator feedIterator = this.cosmosDatabase.GetContainerQueryStreamIterator(
"select value c.id From c "))
{
while (feedIterator.HasMoreResults)
{
using (ResponseMessage response = await feedIterator.ReadNextAsync())
{