-
Notifications
You must be signed in to change notification settings - Fork 241
/
com.azure.cosmos.CosmosAsyncDatabase.yml
612 lines (612 loc) · 81 KB
/
com.azure.cosmos.CosmosAsyncDatabase.yml
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
### YamlMime:JavaType
uid: "com.azure.cosmos.CosmosAsyncDatabase"
fullName: "com.azure.cosmos.CosmosAsyncDatabase"
name: "CosmosAsyncDatabase"
nameWithType: "CosmosAsyncDatabase"
summary: "Perform read and delete databases, update database throughput, and perform operations on child resources"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **CosmosAsyncDatabase**"
methods:
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createClientEncryptionKey(com.azure.cosmos.models.CosmosClientEncryptionKeyProperties)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createClientEncryptionKey(CosmosClientEncryptionKeyProperties keyProperties)"
name: "createClientEncryptionKey(CosmosClientEncryptionKeyProperties keyProperties)"
nameWithType: "CosmosAsyncDatabase.createClientEncryptionKey(CosmosClientEncryptionKeyProperties keyProperties)"
summary: "Creates a client encryption key after subscription the operation will be performed."
parameters:
- description: "the cosmos client encryption key properties"
name: "keyProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosClientEncryptionKeyResponse> createClientEncryptionKey(CosmosClientEncryptionKeyProperties keyProperties)"
desc: "Creates a client encryption key after subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single resource response with the created client encryption key. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response with the\n created cosmos client encryption key or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyResponse?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyResponse&text=CosmosClientEncryptionKeyResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(com.azure.cosmos.models.CosmosContainerProperties)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(CosmosContainerProperties containerProperties)"
name: "createContainer(CosmosContainerProperties containerProperties)"
nameWithType: "CosmosAsyncDatabase.createContainer(CosmosContainerProperties containerProperties)"
summary: "Creates a Cosmos container."
parameters:
- description: "the container properties."
name: "containerProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosContainerResponse> createContainer(CosmosContainerProperties containerProperties)"
desc: "Creates a Cosmos container.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(containerId, partitionKeyDefinition);\n cosmosAsyncDatabase.createContainer(containerProperties)\n .subscribe(\n cosmosContainerResponse -> System.out.println(cosmosContainerResponse),\n throwable -> System.out.println(\"Failed to create container: \" + throwable)\n );\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos container response with the created container. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single cosmos container response with\n the created container or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosContainerResponse?alt=com.azure.cosmos.models.CosmosContainerResponse&text=CosmosContainerResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(com.azure.cosmos.models.CosmosContainerProperties,com.azure.cosmos.models.CosmosContainerRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options)"
name: "createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options)"
summary: "Creates a Cosmos container."
parameters:
- description: "the containerProperties."
name: "containerProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />"
- description: "the cosmos container request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosContainerRequestOptions?alt=com.azure.cosmos.models.CosmosContainerRequestOptions&text=CosmosContainerRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosContainerResponse> createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options)"
desc: "Creates a Cosmos container.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(containerId, partitionKeyDefinition);\n cosmosAsyncDatabase.createContainer(containerProperties)\n .subscribe(\n cosmosContainerResponse -> System.out.println(cosmosContainerResponse),\n throwable -> System.out.println(\"Failed to create container: \" + throwable)\n );\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos container response with the created container. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the cosmos container response with the\n created container or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosContainerResponse?alt=com.azure.cosmos.models.CosmosContainerResponse&text=CosmosContainerResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(com.azure.cosmos.models.CosmosContainerProperties,com.azure.cosmos.models.ThroughputProperties)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)"
name: "createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)"
nameWithType: "CosmosAsyncDatabase.createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)"
summary: "Creates a Cosmos container with custom throughput properties."
parameters:
- description: "the container properties."
name: "containerProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />"
- description: "the throughput properties for the container."
name: "throughputProperties"
type: "<xref href=\"com.azure.cosmos.models.ThroughputProperties?alt=com.azure.cosmos.models.ThroughputProperties&text=ThroughputProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosContainerResponse> createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)"
desc: "Creates a Cosmos container with custom throughput properties.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(containerId, partitionKeyDefinition);\n ThroughputProperties throughputProperties =\n ThroughputProperties.createAutoscaledThroughput(autoScaleMaxThroughput);\n cosmosAsyncDatabase.createContainer(containerProperties, throughputProperties)\n .subscribe(\n cosmosContainerResponse -> System.out.println(cosmosContainerResponse),\n throwable -> System.out.println(\"Failed to create container: \" + throwable)\n );\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos container response with the created container. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single cosmos container response with\n the created container or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosContainerResponse?alt=com.azure.cosmos.models.CosmosContainerResponse&text=CosmosContainerResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(com.azure.cosmos.models.CosmosContainerProperties,com.azure.cosmos.models.ThroughputProperties,com.azure.cosmos.models.CosmosContainerRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties, CosmosContainerRequestOptions options)"
name: "createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties, CosmosContainerRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties, CosmosContainerRequestOptions options)"
summary: "Creates a container."
parameters:
- description: "the container properties."
name: "containerProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />"
- description: "the throughput properties."
name: "throughputProperties"
type: "<xref href=\"com.azure.cosmos.models.ThroughputProperties?alt=com.azure.cosmos.models.ThroughputProperties&text=ThroughputProperties\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosContainerRequestOptions?alt=com.azure.cosmos.models.CosmosContainerRequestOptions&text=CosmosContainerRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosContainerResponse> createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties, CosmosContainerRequestOptions options)"
desc: "Creates a container.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(containerId, partitionKeyDefinition);\n\n cosmosAsyncDatabase.createContainer(\n containerProperties,\n throughput,\n options\n )\n .subscribe(\n cosmosContainerResponse -> System.out.println(cosmosContainerResponse),\n throwable -> System.out.println(\"Failed to create container: \" + throwable)\n );\n```"
returns:
description: "the mono."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosContainerResponse?alt=com.azure.cosmos.models.CosmosContainerResponse&text=CosmosContainerResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(java.lang.String,java.lang.String)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(String id, String partitionKeyPath)"
name: "createContainer(String id, String partitionKeyPath)"
nameWithType: "CosmosAsyncDatabase.createContainer(String id, String partitionKeyPath)"
summary: "Creates a Cosmos container."
parameters:
- description: "the cosmos container id."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key path."
name: "partitionKeyPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<CosmosContainerResponse> createContainer(String id, String partitionKeyPath)"
desc: "Creates a Cosmos container.\n\n```java\nThroughputProperties throughputProperties =\n ThroughputProperties.createAutoscaledThroughput(autoscaledThroughput);\n cosmosAsyncDatabase.createContainer(\n containerId,\n partitionKeyPath,\n throughputProperties\n )\n .subscribe(\n cosmosContainerResponse -> System.out.println(cosmosContainerResponse),\n throwable -> System.out.println(\"Failed to create container: \" + throwable)\n );\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos container response with the created container. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the cosmos container response with the\n created container or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosContainerResponse?alt=com.azure.cosmos.models.CosmosContainerResponse&text=CosmosContainerResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(java.lang.String,java.lang.String,com.azure.cosmos.models.ThroughputProperties)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createContainer(String id, String partitionKeyPath, ThroughputProperties throughputProperties)"
name: "createContainer(String id, String partitionKeyPath, ThroughputProperties throughputProperties)"
nameWithType: "CosmosAsyncDatabase.createContainer(String id, String partitionKeyPath, ThroughputProperties throughputProperties)"
summary: "Creates a Cosmos container."
parameters:
- description: "the cosmos container id."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key path."
name: "partitionKeyPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the throughput properties for the container."
name: "throughputProperties"
type: "<xref href=\"com.azure.cosmos.models.ThroughputProperties?alt=com.azure.cosmos.models.ThroughputProperties&text=ThroughputProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosContainerResponse> createContainer(String id, String partitionKeyPath, ThroughputProperties throughputProperties)"
desc: "Creates a Cosmos container.\n\n```java\nThroughputProperties throughputProperties =\n ThroughputProperties.createAutoscaledThroughput(autoscaledThroughput);\n cosmosAsyncDatabase.createContainer(\n containerId,\n partitionKeyPath,\n throughputProperties\n )\n .subscribe(\n cosmosContainerResponse -> System.out.println(cosmosContainerResponse),\n throwable -> System.out.println(\"Failed to create container: \" + throwable)\n );\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos container response with the created container. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the cosmos container response with the\n created container or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosContainerResponse?alt=com.azure.cosmos.models.CosmosContainerResponse&text=CosmosContainerResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createContainerIfNotExists(com.azure.cosmos.models.CosmosContainerProperties)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createContainerIfNotExists(CosmosContainerProperties containerProperties)"
name: "createContainerIfNotExists(CosmosContainerProperties containerProperties)"
nameWithType: "CosmosAsyncDatabase.createContainerIfNotExists(CosmosContainerProperties containerProperties)"
summary: "Creates a Cosmos container if it does not exist on the service."
parameters:
- description: "the container properties"
name: "containerProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosContainerResponse> createContainerIfNotExists(CosmosContainerProperties containerProperties)"
desc: "Creates a Cosmos container if it does not exist on the service.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(containerId, partitionKeyDefinition);\n cosmosAsyncDatabase.createContainerIfNotExists(containerProperties)\n .subscribe(\n cosmosContainerResponse -> System.out.println(cosmosContainerResponse),\n throwable -> System.out.println(\"Failed to create container: \" + throwable)\n );\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos container response with the created or existing container. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the cosmos container response with the\n created or existing container or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosContainerResponse?alt=com.azure.cosmos.models.CosmosContainerResponse&text=CosmosContainerResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createContainerIfNotExists(com.azure.cosmos.models.CosmosContainerProperties,com.azure.cosmos.models.ThroughputProperties)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)"
name: "createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)"
nameWithType: "CosmosAsyncDatabase.createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)"
summary: "Creates a Cosmos container if it does not exist on the service."
parameters:
- description: "the container properties."
name: "containerProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />"
- description: "the throughput properties for the container."
name: "throughputProperties"
type: "<xref href=\"com.azure.cosmos.models.ThroughputProperties?alt=com.azure.cosmos.models.ThroughputProperties&text=ThroughputProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosContainerResponse> createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)"
desc: "Creates a Cosmos container if it does not exist on the service.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(containerId, partitionKeyDefinition);\n cosmosAsyncDatabase.createContainerIfNotExists(containerProperties, throughputProperties)\n .subscribe(\n cosmosContainerResponse -> System.out.println(cosmosContainerResponse),\n throwable -> System.out.println(\"Failed to create container: \" + throwable)\n );\n```\n\nThe throughput properties will only be used if the specified container does not exist and therefor a new container will be created.\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos container response with the created or existing container. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the cosmos container response with the\n created or existing container or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosContainerResponse?alt=com.azure.cosmos.models.CosmosContainerResponse&text=CosmosContainerResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createContainerIfNotExists(java.lang.String,java.lang.String)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createContainerIfNotExists(String id, String partitionKeyPath)"
name: "createContainerIfNotExists(String id, String partitionKeyPath)"
nameWithType: "CosmosAsyncDatabase.createContainerIfNotExists(String id, String partitionKeyPath)"
summary: "Creates a Cosmos container if it does not exist on the service."
parameters:
- description: "the cosmos container id."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key path."
name: "partitionKeyPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<CosmosContainerResponse> createContainerIfNotExists(String id, String partitionKeyPath)"
desc: "Creates a Cosmos container if it does not exist on the service.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(containerId, partitionKeyDefinition);\n cosmosAsyncDatabase.createContainerIfNotExists(containerProperties)\n .subscribe(\n cosmosContainerResponse -> System.out.println(cosmosContainerResponse),\n throwable -> System.out.println(\"Failed to create container: \" + throwable)\n );\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos container response with the created container. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the cosmos container response with the\n created container or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosContainerResponse?alt=com.azure.cosmos.models.CosmosContainerResponse&text=CosmosContainerResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createContainerIfNotExists(java.lang.String,java.lang.String,com.azure.cosmos.models.ThroughputProperties)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createContainerIfNotExists(String id, String partitionKeyPath, ThroughputProperties throughputProperties)"
name: "createContainerIfNotExists(String id, String partitionKeyPath, ThroughputProperties throughputProperties)"
nameWithType: "CosmosAsyncDatabase.createContainerIfNotExists(String id, String partitionKeyPath, ThroughputProperties throughputProperties)"
summary: "Creates a Cosmos container if it does not exist on the service."
parameters:
- description: "the cosmos container id."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key path."
name: "partitionKeyPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the throughput properties for the container."
name: "throughputProperties"
type: "<xref href=\"com.azure.cosmos.models.ThroughputProperties?alt=com.azure.cosmos.models.ThroughputProperties&text=ThroughputProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosContainerResponse> createContainerIfNotExists(String id, String partitionKeyPath, ThroughputProperties throughputProperties)"
desc: "Creates a Cosmos container if it does not exist on the service.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(containerId, partitionKeyDefinition);\n cosmosAsyncDatabase.createContainerIfNotExists(containerProperties, throughputProperties)\n .subscribe(\n cosmosContainerResponse -> System.out.println(cosmosContainerResponse),\n throwable -> System.out.println(\"Failed to create container: \" + throwable)\n );\n```\n\nThe throughput properties will only be used if the specified container does not exist and therefor a new container will be created.\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos container response with the created container. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the cosmos container response with the\n created container or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosContainerResponse?alt=com.azure.cosmos.models.CosmosContainerResponse&text=CosmosContainerResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.createUser(com.azure.cosmos.models.CosmosUserProperties)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.createUser(CosmosUserProperties userProperties)"
name: "createUser(CosmosUserProperties userProperties)"
nameWithType: "CosmosAsyncDatabase.createUser(CosmosUserProperties userProperties)"
summary: "Creates a user After subscription the operation will be performed."
parameters:
- description: "the cosmos user properties"
name: "userProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosUserProperties?alt=com.azure.cosmos.models.CosmosUserProperties&text=CosmosUserProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosUserResponse> createUser(CosmosUserProperties userProperties)"
desc: "Creates a user After subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single resource response with the created user. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error.\n\n```java\nString userId = \"userId\";\n CosmosUserProperties userProperties = new CosmosUserProperties();\n userProperties.setId(userId);\n cosmosAsyncDatabase.createUser(userProperties)\n .subscribe(\n userResponse -> System.out.println(userResponse),\n throwable -> System.out.println(\"Failed to create user: \" + throwable)\n );\n```"
returns:
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response with the\n created cosmos user or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosUserResponse?alt=com.azure.cosmos.models.CosmosUserResponse&text=CosmosUserResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.delete()"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.delete()"
name: "delete()"
nameWithType: "CosmosAsyncDatabase.delete()"
summary: "Deletes the current Cosmos database."
syntax: "public Mono<CosmosDatabaseResponse> delete()"
desc: "Deletes the current Cosmos database.\n\n```java\nCosmosAsyncDatabase database = cosmosAsyncClient\n .getDatabase(\"<YOUR DATABASE NAME>\");\n database.delete().subscribe(databaseResponse -> {\n System.out.println(databaseResponse);\n },\n throwable -> {\n throwable.printStackTrace();\n });\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos database response with the deleted database. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single cosmos database response."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosDatabaseResponse?alt=com.azure.cosmos.models.CosmosDatabaseResponse&text=CosmosDatabaseResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.delete(com.azure.cosmos.models.CosmosDatabaseRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.delete(CosmosDatabaseRequestOptions options)"
name: "delete(CosmosDatabaseRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.delete(CosmosDatabaseRequestOptions options)"
summary: "Deletes the current Cosmos database while specifying additional request options."
parameters:
- description: "the request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosDatabaseRequestOptions?alt=com.azure.cosmos.models.CosmosDatabaseRequestOptions&text=CosmosDatabaseRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosDatabaseResponse> delete(CosmosDatabaseRequestOptions options)"
desc: "Deletes the current Cosmos database while specifying additional request options.\n\n```java\nCosmosAsyncDatabase database = cosmosAsyncClient\n .getDatabase(\"<YOUR DATABASE NAME>\");\n database.delete().subscribe(databaseResponse -> {\n System.out.println(databaseResponse);\n },\n throwable -> {\n throwable.printStackTrace();\n });\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos database response with the deleted database. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single cosmos database response."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosDatabaseResponse?alt=com.azure.cosmos.models.CosmosDatabaseResponse&text=CosmosDatabaseResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.getClientEncryptionKey(java.lang.String)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.getClientEncryptionKey(String id)"
name: "getClientEncryptionKey(String id)"
nameWithType: "CosmosAsyncDatabase.getClientEncryptionKey(String id)"
summary: "Gets a Cosmos<wbr>Async<wbr>Client<wbr>Encryption<wbr>Key object without making a service call"
parameters:
- description: "id of the clientEncryptionKey"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosAsyncClientEncryptionKey getClientEncryptionKey(String id)"
desc: "Gets a CosmosAsyncClientEncryptionKey object without making a service call"
returns:
description: "Cosmos ClientEncryptionKey"
type: "<xref href=\"com.azure.cosmos.CosmosAsyncClientEncryptionKey?alt=com.azure.cosmos.CosmosAsyncClientEncryptionKey&text=CosmosAsyncClientEncryptionKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.getContainer(java.lang.String)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.getContainer(String id)"
name: "getContainer(String id)"
nameWithType: "CosmosAsyncDatabase.getContainer(String id)"
summary: "Gets a Cosmos<wbr>Async<wbr>Container object without making a service call"
parameters:
- description: "id of the container"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosAsyncContainer getContainer(String id)"
desc: "Gets a CosmosAsyncContainer object without making a service call"
returns:
description: "Cosmos Container"
type: "<xref href=\"com.azure.cosmos.CosmosAsyncContainer?alt=com.azure.cosmos.CosmosAsyncContainer&text=CosmosAsyncContainer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.getId()"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.getId()"
name: "getId()"
nameWithType: "CosmosAsyncDatabase.getId()"
summary: "Get the id of the Cosmos<wbr>Async<wbr>Database."
syntax: "public String getId()"
desc: "Get the id of the CosmosAsyncDatabase."
returns:
description: "the id of the CosmosAsyncDatabase."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.getUser(java.lang.String)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.getUser(String id)"
name: "getUser(String id)"
nameWithType: "CosmosAsyncDatabase.getUser(String id)"
summary: "Gets user."
parameters:
- description: "the id"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosAsyncUser getUser(String id)"
desc: "Gets user."
returns:
description: "the user"
type: "<xref href=\"com.azure.cosmos.CosmosAsyncUser?alt=com.azure.cosmos.CosmosAsyncUser&text=CosmosAsyncUser\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryClientEncryptionKeys(com.azure.cosmos.models.SqlQuerySpec)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryClientEncryptionKeys(SqlQuerySpec querySpec)"
name: "queryClientEncryptionKeys(SqlQuerySpec querySpec)"
nameWithType: "CosmosAsyncDatabase.queryClientEncryptionKeys(SqlQuerySpec querySpec)"
summary: "Query for cosmos client encryption keys in a database."
parameters:
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.azure.cosmos.models.SqlQuerySpec?alt=com.azure.cosmos.models.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosClientEncryptionKeyProperties> queryClientEncryptionKeys(SqlQuerySpec querySpec)"
desc: "Query for cosmos client encryption keys in a database.\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained client encryption keys. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained client encryption keys or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryClientEncryptionKeys(com.azure.cosmos.models.SqlQuerySpec,com.azure.cosmos.models.CosmosQueryRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryClientEncryptionKeys(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
name: "queryClientEncryptionKeys(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.queryClientEncryptionKeys(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
summary: "Query for cosmos client encryption keys in a database."
parameters:
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.azure.cosmos.models.SqlQuerySpec?alt=com.azure.cosmos.models.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the query request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosQueryRequestOptions?alt=com.azure.cosmos.models.CosmosQueryRequestOptions&text=CosmosQueryRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosClientEncryptionKeyProperties> queryClientEncryptionKeys(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
desc: "Query for cosmos client encryption keys in a database.\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained client encryption keys. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained client encryption keys or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryClientEncryptionKeys(java.lang.String)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryClientEncryptionKeys(String query)"
name: "queryClientEncryptionKeys(String query)"
nameWithType: "CosmosAsyncDatabase.queryClientEncryptionKeys(String query)"
summary: "Query for cosmos client encryption keys in a database."
parameters:
- description: "query as string."
name: "query"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosPagedFlux<CosmosClientEncryptionKeyProperties> queryClientEncryptionKeys(String query)"
desc: "Query for cosmos client encryption keys in a database.\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained client encryption keys. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained client encryption keys or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryClientEncryptionKeys(java.lang.String,com.azure.cosmos.models.CosmosQueryRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryClientEncryptionKeys(String query, CosmosQueryRequestOptions options)"
name: "queryClientEncryptionKeys(String query, CosmosQueryRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.queryClientEncryptionKeys(String query, CosmosQueryRequestOptions options)"
summary: "Query for cosmos client encryption keys in a database."
parameters:
- description: "query as string."
name: "query"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the query request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosQueryRequestOptions?alt=com.azure.cosmos.models.CosmosQueryRequestOptions&text=CosmosQueryRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosClientEncryptionKeyProperties> queryClientEncryptionKeys(String query, CosmosQueryRequestOptions options)"
desc: "Query for cosmos client encryption keys in a database.\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained client encryption keys. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained client encryption keys or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryContainers(com.azure.cosmos.models.SqlQuerySpec)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryContainers(SqlQuerySpec querySpec)"
name: "queryContainers(SqlQuerySpec querySpec)"
nameWithType: "CosmosAsyncDatabase.queryContainers(SqlQuerySpec querySpec)"
summary: "Query for cosmos containers in a cosmos database."
parameters:
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.azure.cosmos.models.SqlQuerySpec?alt=com.azure.cosmos.models.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosContainerProperties> queryContainers(SqlQuerySpec querySpec)"
desc: "Query for cosmos containers in a cosmos database.\n\n```java\ncosmosAsyncDatabase.queryContainers(\"SELECT * FROM DB_NAME\")\n .byPage()\n .flatMap(containerPropertiesFeedResponse -> {\n for (CosmosContainerProperties properties : containerPropertiesFeedResponse.getResults()) {\n System.out.println(properties);\n }\n return Flux.empty();\n })\n .subscribe();\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained containers. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained containers or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryContainers(com.azure.cosmos.models.SqlQuerySpec,com.azure.cosmos.models.CosmosQueryRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
name: "queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
summary: "Query for cosmos containers in a cosmos database."
parameters:
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.azure.cosmos.models.SqlQuerySpec?alt=com.azure.cosmos.models.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the query request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosQueryRequestOptions?alt=com.azure.cosmos.models.CosmosQueryRequestOptions&text=CosmosQueryRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosContainerProperties> queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
desc: "Query for cosmos containers in a cosmos database.\n\n```java\ncosmosAsyncDatabase.queryContainers(\"SELECT * FROM DB_NAME\")\n .byPage()\n .flatMap(containerPropertiesFeedResponse -> {\n for (CosmosContainerProperties properties : containerPropertiesFeedResponse.getResults()) {\n System.out.println(properties);\n }\n return Flux.empty();\n })\n .subscribe();\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained containers. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained containers or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryContainers(java.lang.String)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryContainers(String query)"
name: "queryContainers(String query)"
nameWithType: "CosmosAsyncDatabase.queryContainers(String query)"
summary: "Query for cosmos containers in a cosmos database."
parameters:
- description: "the query."
name: "query"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosPagedFlux<CosmosContainerProperties> queryContainers(String query)"
desc: "Query for cosmos containers in a cosmos database.\n\n```java\ncosmosAsyncDatabase.queryContainers(\"SELECT * FROM DB_NAME\")\n .byPage()\n .flatMap(containerPropertiesFeedResponse -> {\n for (CosmosContainerProperties properties : containerPropertiesFeedResponse.getResults()) {\n System.out.println(properties);\n }\n return Flux.empty();\n })\n .subscribe();\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained containers. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained containers or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryContainers(java.lang.String,com.azure.cosmos.models.CosmosQueryRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryContainers(String query, CosmosQueryRequestOptions options)"
name: "queryContainers(String query, CosmosQueryRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.queryContainers(String query, CosmosQueryRequestOptions options)"
summary: "Query for cosmos containers in a cosmos database."
parameters:
- description: "the query."
name: "query"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the query request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosQueryRequestOptions?alt=com.azure.cosmos.models.CosmosQueryRequestOptions&text=CosmosQueryRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosContainerProperties> queryContainers(String query, CosmosQueryRequestOptions options)"
desc: "Query for cosmos containers in a cosmos database.\n\n```java\ncosmosAsyncDatabase.queryContainers(\"SELECT * FROM DB_NAME\")\n .byPage()\n .flatMap(containerPropertiesFeedResponse -> {\n for (CosmosContainerProperties properties : containerPropertiesFeedResponse.getResults()) {\n System.out.println(properties);\n }\n return Flux.empty();\n })\n .subscribe();\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained containers. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained containers or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryUsers(com.azure.cosmos.models.SqlQuerySpec)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryUsers(SqlQuerySpec querySpec)"
name: "queryUsers(SqlQuerySpec querySpec)"
nameWithType: "CosmosAsyncDatabase.queryUsers(SqlQuerySpec querySpec)"
summary: "Query for cosmos users in a database."
parameters:
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.azure.cosmos.models.SqlQuerySpec?alt=com.azure.cosmos.models.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosUserProperties> queryUsers(SqlQuerySpec querySpec)"
desc: "Query for cosmos users in a database.\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained users. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained users or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosUserProperties?alt=com.azure.cosmos.models.CosmosUserProperties&text=CosmosUserProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryUsers(com.azure.cosmos.models.SqlQuerySpec,com.azure.cosmos.models.CosmosQueryRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
name: "queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
summary: "Query for cosmos users in a database."
parameters:
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.azure.cosmos.models.SqlQuerySpec?alt=com.azure.cosmos.models.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the query request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosQueryRequestOptions?alt=com.azure.cosmos.models.CosmosQueryRequestOptions&text=CosmosQueryRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosUserProperties> queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)"
desc: "Query for cosmos users in a database.\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained users. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained users or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosUserProperties?alt=com.azure.cosmos.models.CosmosUserProperties&text=CosmosUserProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryUsers(java.lang.String)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryUsers(String query)"
name: "queryUsers(String query)"
nameWithType: "CosmosAsyncDatabase.queryUsers(String query)"
summary: "Query for cosmos users in a database."
parameters:
- description: "query as string."
name: "query"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosPagedFlux<CosmosUserProperties> queryUsers(String query)"
desc: "Query for cosmos users in a database.\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained users. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained users or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosUserProperties?alt=com.azure.cosmos.models.CosmosUserProperties&text=CosmosUserProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.queryUsers(java.lang.String,com.azure.cosmos.models.CosmosQueryRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.queryUsers(String query, CosmosQueryRequestOptions options)"
name: "queryUsers(String query, CosmosQueryRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.queryUsers(String query, CosmosQueryRequestOptions options)"
summary: "Query for cosmos users in a database."
parameters:
- description: "query as string."
name: "query"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the query request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosQueryRequestOptions?alt=com.azure.cosmos.models.CosmosQueryRequestOptions&text=CosmosQueryRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosUserProperties> queryUsers(String query, CosmosQueryRequestOptions options)"
desc: "Query for cosmos users in a database.\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the obtained users. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n obtained users or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosUserProperties?alt=com.azure.cosmos.models.CosmosUserProperties&text=CosmosUserProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.read()"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.read()"
name: "read()"
nameWithType: "CosmosAsyncDatabase.read()"
summary: "Reads a database."
syntax: "public Mono<CosmosDatabaseResponse> read()"
desc: "Reads a database. Fetch the details and properties of a database based on its unique identifier.\n\n```java\nCosmosAsyncDatabase database = cosmosAsyncClient\n .getDatabase(\"<YOUR DATABASE NAME>\");\n database.read().subscribe(databaseResponse -> {\n System.out.println(databaseResponse);\n },\n throwable -> {\n throwable.printStackTrace();\n });\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single cosmos database response with the read database. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single cosmos database respone with\n the read database or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosDatabaseResponse?alt=com.azure.cosmos.models.CosmosDatabaseResponse&text=CosmosDatabaseResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.read(com.azure.cosmos.models.CosmosDatabaseRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.read(CosmosDatabaseRequestOptions options)"
name: "read(CosmosDatabaseRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.read(CosmosDatabaseRequestOptions options)"
summary: "Reads a database."
parameters:
- description: "the request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosDatabaseRequestOptions?alt=com.azure.cosmos.models.CosmosDatabaseRequestOptions&text=CosmosDatabaseRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosDatabaseResponse> read(CosmosDatabaseRequestOptions options)"
desc: "Reads a database. Fetch the details and properties of a database based on its unique identifier.\n\n```java\nCosmosAsyncDatabase database = cosmosAsyncClient\n .getDatabase(\"<YOUR DATABASE NAME>\");\n database.read().subscribe(databaseResponse -> {\n System.out.println(databaseResponse);\n },\n throwable -> {\n throwable.printStackTrace();\n });\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a cosmos database response with the read database. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
returns:
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single cosmos database response with\n the read database or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosDatabaseResponse?alt=com.azure.cosmos.models.CosmosDatabaseResponse&text=CosmosDatabaseResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.readAllClientEncryptionKeys()"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.readAllClientEncryptionKeys()"
name: "readAllClientEncryptionKeys()"
nameWithType: "CosmosAsyncDatabase.readAllClientEncryptionKeys()"
summary: "Reads all cosmos client encryption keys in a database."
syntax: "public CosmosPagedFlux<CosmosClientEncryptionKeyProperties> readAllClientEncryptionKeys()"
desc: "Reads all cosmos client encryption keys in a database.\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the read cosmos client encryption keys. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n read cosmos client encryption keys or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.readAllClientEncryptionKeys(com.azure.cosmos.models.CosmosQueryRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.readAllClientEncryptionKeys(CosmosQueryRequestOptions options)"
name: "readAllClientEncryptionKeys(CosmosQueryRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.readAllClientEncryptionKeys(CosmosQueryRequestOptions options)"
summary: "Reads all cosmos client encryption keys in a database."
parameters:
- description: "the query request options."
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosQueryRequestOptions?alt=com.azure.cosmos.models.CosmosQueryRequestOptions&text=CosmosQueryRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosClientEncryptionKeyProperties> readAllClientEncryptionKeys(CosmosQueryRequestOptions options)"
desc: "Reads all cosmos client encryption keys in a database.\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the read cosmos client encryption keys. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n read cosmos client encryption keys or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.readAllContainers()"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.readAllContainers()"
name: "readAllContainers()"
nameWithType: "CosmosAsyncDatabase.readAllContainers()"
summary: "Reads all cosmos containers."
syntax: "public CosmosPagedFlux<CosmosContainerProperties> readAllContainers()"
desc: "Reads all cosmos containers.\n\n```java\ncosmosAsyncDatabase.readAllContainers()\n .byPage()\n .flatMap(containerPropertiesFeedResponse -> {\n for (CosmosContainerProperties properties : containerPropertiesFeedResponse.getResults()) {\n System.out.println(properties);\n }\n return Flux.empty();\n })\n .subscribe();\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the read containers. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of read\n containers or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.readAllContainers(com.azure.cosmos.models.CosmosQueryRequestOptions)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.readAllContainers(CosmosQueryRequestOptions options)"
name: "readAllContainers(CosmosQueryRequestOptions options)"
nameWithType: "CosmosAsyncDatabase.readAllContainers(CosmosQueryRequestOptions options)"
summary: "Reads all cosmos containers."
parameters:
- description: "<xref uid=\"com.azure.cosmos.models.CosmosQueryRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosQueryRequestOptions\"></xref>"
name: "options"
type: "<xref href=\"com.azure.cosmos.models.CosmosQueryRequestOptions?alt=com.azure.cosmos.models.CosmosQueryRequestOptions&text=CosmosQueryRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosPagedFlux<CosmosContainerProperties> readAllContainers(CosmosQueryRequestOptions options)"
desc: "Reads all cosmos containers.\n\n```java\ncosmosAsyncDatabase.readAllContainers()\n .byPage()\n .flatMap(containerPropertiesFeedResponse -> {\n for (CosmosContainerProperties properties : containerPropertiesFeedResponse.getResults()) {\n System.out.println(properties);\n }\n return Flux.empty();\n })\n .subscribe();\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the read containers. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of read\n containers or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosContainerProperties?alt=com.azure.cosmos.models.CosmosContainerProperties&text=CosmosContainerProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.readAllUsers()"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.readAllUsers()"
name: "readAllUsers()"
nameWithType: "CosmosAsyncDatabase.readAllUsers()"
summary: "Reads all cosmos users in a database."
syntax: "public CosmosPagedFlux<CosmosUserProperties> readAllUsers()"
desc: "Reads all cosmos users in a database.\n\n```java\ncosmosAsyncDatabase.readAllUsers()\n .byPage()\n .flatMap(userPropertiesFeedResponse -> {\n for (CosmosUserProperties properties : userPropertiesFeedResponse.getResults()) {\n System.out.println(properties);\n }\n return Flux.empty();\n })\n .subscribe();\n```\n\nAfter subscription the operation will be performed. The <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will contain one or several feed response of the read cosmos users. In case of failure the <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> will error."
returns:
description: "a <xref uid=\"com.azure.cosmos.util.CosmosPagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosPagedFlux\"></xref> containing one or several feed response pages of the\n read cosmos users or an error."
type: "<xref href=\"com.azure.cosmos.util.CosmosPagedFlux?alt=com.azure.cosmos.util.CosmosPagedFlux&text=CosmosPagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.cosmos.models.CosmosUserProperties?alt=com.azure.cosmos.models.CosmosUserProperties&text=CosmosUserProperties\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.readThroughput()"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.readThroughput()"
name: "readThroughput()"
nameWithType: "CosmosAsyncDatabase.readThroughput()"
summary: "Gets the throughput of the database."
syntax: "public Mono<ThroughputResponse> readThroughput()"
desc: "Gets the throughput of the database.\n\n```java\ncosmosAsyncDatabase.readThroughput()\n .subscribe(throughputResponse -> {\n System.out.println(throughputResponse);\n },\n throwable -> {\n throwable.printStackTrace();\n });\n```"
returns:
description: "the mono containing throughput response."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.ThroughputResponse?alt=com.azure.cosmos.models.ThroughputResponse&text=ThroughputResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.replaceThroughput(com.azure.cosmos.models.ThroughputProperties)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.replaceThroughput(ThroughputProperties throughputProperties)"
name: "replaceThroughput(ThroughputProperties throughputProperties)"
nameWithType: "CosmosAsyncDatabase.replaceThroughput(ThroughputProperties throughputProperties)"
summary: "Sets throughput provisioned for a container in measurement of Requests-per-Unit in the Azure Cosmos service."
parameters:
- description: "the throughput properties."
name: "throughputProperties"
type: "<xref href=\"com.azure.cosmos.models.ThroughputProperties?alt=com.azure.cosmos.models.ThroughputProperties&text=ThroughputProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<ThroughputResponse> replaceThroughput(ThroughputProperties throughputProperties)"
desc: "Sets throughput provisioned for a container in measurement of Requests-per-Unit in the Azure Cosmos service.\n\n```java\nThroughputProperties autoscaledThroughput = ThroughputProperties\n .createAutoscaledThroughput(autoScaleMaxThroughput);\n cosmosAsyncDatabase.replaceThroughput(autoscaledThroughput)\n .subscribe(throughputResponse -> {\n System.out.println(throughputResponse);\n },\n throwable -> {\n throwable.printStackTrace();\n });\n```"
returns:
description: "the mono."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.ThroughputResponse?alt=com.azure.cosmos.models.ThroughputResponse&text=ThroughputResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncDatabase.upsertUser(com.azure.cosmos.models.CosmosUserProperties)"
fullName: "com.azure.cosmos.CosmosAsyncDatabase.upsertUser(CosmosUserProperties userProperties)"
name: "upsertUser(CosmosUserProperties userProperties)"
nameWithType: "CosmosAsyncDatabase.upsertUser(CosmosUserProperties userProperties)"
summary: "Upsert a user."
parameters:
- description: "the cosmos user properties"
name: "userProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosUserProperties?alt=com.azure.cosmos.models.CosmosUserProperties&text=CosmosUserProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosUserResponse> upsertUser(CosmosUserProperties userProperties)"
desc: "Upsert a user. Upsert will create a new user if it doesn't exist, or replace the existing one if it does. After subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single resource response with the created user. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error.\n\n```java\nString userId = \"userId\";\n CosmosUserProperties userProperties = new CosmosUserProperties();\n userProperties.setId(userId);\n cosmosAsyncDatabase.upsertUser(userProperties)\n .subscribe(\n userResponse -> System.out.println(userResponse),\n throwable -> System.out.println(\"Failed to upsert user: \" + throwable)\n );\n```"
returns:
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response with the\n upserted user or an error."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosUserResponse?alt=com.azure.cosmos.models.CosmosUserResponse&text=CosmosUserResponse\" data-throw-if-not-resolved=\"False\" />>"
type: "class"
desc: "Perform read and delete databases, update database throughput, and perform operations on child resources"
metadata: {}
package: "com.azure.cosmos"
artifact: com.azure:azure-cosmos:4.63.2