-
Notifications
You must be signed in to change notification settings - Fork 180
/
Items.yml
608 lines (531 loc) · 18.9 KB
/
Items.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
### YamlMime:TSType
name: Items
uid: '@azure/cosmos.Items'
package: '@azure/cosmos'
summary: >-
Operations for creating new items, and reading/querying all items
See [Item](xref:@azure/cosmos.Item) for reading, replacing, or deleting an
existing container; use `.item(id)`.
fullName: Items
remarks: ''
isDeprecated: false
type: class
properties:
- name: container
uid: '@azure/cosmos.Items.container'
package: '@azure/cosmos'
summary: ''
fullName: container
remarks: ''
isDeprecated: false
syntax:
content: 'container: Container'
return:
description: ''
type: <xref uid="@azure/cosmos.Container" />
methods:
- name: batch(OperationInput[], PartitionKey, RequestOptions)
uid: '@azure/cosmos.Items.batch'
package: '@azure/cosmos'
summary: >-
Execute transactional batch operations on items.
Batch takes an array of Operations which are typed based on what the
operation does. Batch is transactional and will rollback all operations if
one fails.
The choices are: Create, Upsert, Read, Replace, and Delete
Usage example:
```typescript
// partitionKey is required as a second argument to batch, but defaults to
the default partition key
const operations: OperationInput[] = [
{
operationType: "Create",
resourceBody: { id: "doc1", name: "sample", key: "A" }
},
{
operationType: "Upsert",
partitionKey: 'A',
resourceBody: { id: "doc2", name: "other", key: "A" }
}
]
await database.container.items.batch(operations)
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function batch(operations: OperationInput[], partitionKey?:
PartitionKey, options?: RequestOptions):
Promise<Response_2<OperationResponse[]>>
parameters:
- id: operations
type: <xref uid="@azure/cosmos.OperationInput" />[]
description: List of operations. Limit 100
- id: partitionKey
type: <xref uid="@azure/cosmos.PartitionKey" />
description: ''
- id: options
type: <xref uid="@azure/cosmos.RequestOptions" />
description: Used for modifying the request
return:
description: ''
type: >-
Promise<Response_2<<xref uid="@azure/cosmos.OperationResponse"
/>[]>>
- name: bulk(OperationInput[], BulkOptions, RequestOptions)
uid: '@azure/cosmos.Items.bulk'
package: '@azure/cosmos'
summary: >-
Execute bulk operations on items.
Bulk takes an array of Operations which are typed based on what the
operation does.
The choices are: Create, Upsert, Read, Replace, and Delete
Usage example:
```typescript
// partitionKey is optional at the top level if present in the
resourceBody
const operations: OperationInput[] = [
{
operationType: "Create",
resourceBody: { id: "doc1", name: "sample", key: "A" }
},
{
operationType: "Upsert",
partitionKey: 'A',
resourceBody: { id: "doc2", name: "other", key: "A" }
}
]
await database.container.items.bulk(operations)
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function bulk(operations: OperationInput[], bulkOptions?: BulkOptions,
options?: RequestOptions): Promise<BulkOperationResponse>
parameters:
- id: operations
type: <xref uid="@azure/cosmos.OperationInput" />[]
description: List of operations. Limit 100
- id: bulkOptions
type: <xref uid="@azure/cosmos.BulkOptions" />
description: >-
Optional options object to modify bulk behavior. Pass {
continueOnError: true } to continue executing operations when one
fails. (Defaults to false) ** NOTE: THIS WILL DEFAULT TO TRUE IN THE
4.0 RELEASE
- id: options
type: <xref uid="@azure/cosmos.RequestOptions" />
description: Used for modifying the request.
return:
description: ''
type: Promise<<xref uid="@azure/cosmos.BulkOperationResponse" />>
- name: changeFeed(ChangeFeedOptions)
uid: '@azure/cosmos.Items.changeFeed_1'
package: '@azure/cosmos'
summary: Create a `ChangeFeedIterator` to iterate over pages of changes
remarks: ''
isDeprecated: false
syntax:
content: >-
function changeFeed(changeFeedOptions?: ChangeFeedOptions):
ChangeFeedIterator<any>
parameters:
- id: changeFeedOptions
type: <xref uid="@azure/cosmos.ChangeFeedOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/cosmos.ChangeFeedIterator" /><any>
- name: changeFeed(PartitionKey, ChangeFeedOptions)
uid: '@azure/cosmos.Items.changeFeed'
package: '@azure/cosmos'
summary: |+
Create a `ChangeFeedIterator` to iterate over pages of changes
**Example**
Read from the beginning of the change feed.
```javascript
const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function changeFeed(partitionKey: PartitionKey, changeFeedOptions?:
ChangeFeedOptions): ChangeFeedIterator<any>
parameters:
- id: partitionKey
type: <xref uid="@azure/cosmos.PartitionKey" />
description: ''
- id: changeFeedOptions
type: <xref uid="@azure/cosmos.ChangeFeedOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/cosmos.ChangeFeedIterator" /><any>
- name: changeFeed<T>(ChangeFeedOptions)
uid: '@azure/cosmos.Items.changeFeed_3'
package: '@azure/cosmos'
summary: Create a `ChangeFeedIterator` to iterate over pages of changes
remarks: ''
isDeprecated: false
syntax:
content: >-
function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions):
ChangeFeedIterator<T>
parameters:
- id: changeFeedOptions
type: <xref uid="@azure/cosmos.ChangeFeedOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/cosmos.ChangeFeedIterator" /><T>
- name: changeFeed<T>(PartitionKey, ChangeFeedOptions)
uid: '@azure/cosmos.Items.changeFeed_2'
package: '@azure/cosmos'
summary: Create a `ChangeFeedIterator` to iterate over pages of changes
remarks: ''
isDeprecated: false
syntax:
content: >-
function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?:
ChangeFeedOptions): ChangeFeedIterator<T>
parameters:
- id: partitionKey
type: <xref uid="@azure/cosmos.PartitionKey" />
description: ''
- id: changeFeedOptions
type: <xref uid="@azure/cosmos.ChangeFeedOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/cosmos.ChangeFeedIterator" /><T>
- name: create<T>(T, RequestOptions)
uid: '@azure/cosmos.Items.create'
package: '@azure/cosmos'
summary: >-
Create an item.
Any provided type, T, is not necessarily enforced by the SDK.
You may get more or less properties and it's up to your logic to enforce
it.
There is no set schema for JSON items. They may contain any number of
custom properties.
remarks: ''
isDeprecated: false
syntax:
content: >-
function create<T>(body: T, options?: RequestOptions):
Promise<ItemResponse<T>>
parameters:
- id: body
type: T
description: >-
Represents the body of the item. Can contain any number of user
defined properties.
- id: options
type: <xref uid="@azure/cosmos.RequestOptions" />
description: >-
Used for modifying the request (for instance, specifying the
partition key).
return:
description: ''
type: Promise<<xref uid="@azure/cosmos.ItemResponse" /><T>>
- name: getChangeFeedIterator<T>(ChangeFeedIteratorOptions)
uid: '@azure/cosmos.Items.getChangeFeedIterator'
package: '@azure/cosmos'
summary: >-
Returns an iterator to iterate over pages of changes. The iterator
returned can be used to fetch changes for a single partition key, feed
range or an entire container.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getChangeFeedIterator<T>(changeFeedIteratorOptions?:
ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>
parameters:
- id: changeFeedIteratorOptions
type: <xref uid="@azure/cosmos.ChangeFeedIteratorOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/cosmos.ChangeFeedPullModelIterator" /><T>
- name: query(string | SqlQuerySpec, FeedOptions)
uid: '@azure/cosmos.Items.query'
package: '@azure/cosmos'
summary: |+
Queries all items.
**Example**
Read all items to array.
```typescript
const querySpec: SqlQuerySpec = {
query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
parameters: [
{name: "@lastName", value: "Hendricks"}
]
};
const {result: items} = await items.query(querySpec).fetchAll();
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function query(query: string | SqlQuerySpec, options?: FeedOptions):
QueryIterator<any>
parameters:
- id: query
type: string | <xref uid="@azure/cosmos.SqlQuerySpec" />
description: >-
Query configuration for the operation. See
[SqlQuerySpec](xref:@azure/cosmos.SqlQuerySpec) for more info on how
to configure a query.
- id: options
type: <xref uid="@azure/cosmos.FeedOptions" />
description: >-
Used for modifying the request (for instance, specifying the
partition key).
return:
description: ''
type: <xref uid="@azure/cosmos.QueryIterator" /><any>
- name: query<T>(string | SqlQuerySpec, FeedOptions)
uid: '@azure/cosmos.Items.query_1'
package: '@azure/cosmos'
summary: >+
Queries all items.
**Example**
Read all items to array.
```typescript
const querySpec: SqlQuerySpec = {
query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
parameters: [
{name: "@lastName", value: "Hendricks"}
]
};
const {result: items} = await items.query<{firstName:
string}>(querySpec).fetchAll();
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function query<T>(query: string | SqlQuerySpec, options?: FeedOptions):
QueryIterator<T>
parameters:
- id: query
type: string | <xref uid="@azure/cosmos.SqlQuerySpec" />
description: >-
Query configuration for the operation. See
[SqlQuerySpec](xref:@azure/cosmos.SqlQuerySpec) for more info on how
to configure a query.
- id: options
type: <xref uid="@azure/cosmos.FeedOptions" />
description: >-
Used for modifying the request (for instance, specifying the
partition key).
return:
description: ''
type: <xref uid="@azure/cosmos.QueryIterator" /><T>
- name: readAll(FeedOptions)
uid: '@azure/cosmos.Items.readAll'
package: '@azure/cosmos'
summary: >+
Read all items.
There is no set schema for JSON items. They may contain any number of
custom properties.
**Example**
Read all items to array.
```typescript
const {body: containerList} = await items.readAll().fetchAll();
```
remarks: ''
isDeprecated: false
syntax:
content: 'function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>'
parameters:
- id: options
type: <xref uid="@azure/cosmos.FeedOptions" />
description: >-
Used for modifying the request (for instance, specifying the
partition key).
return:
description: ''
type: >-
<xref uid="@azure/cosmos.QueryIterator" /><<xref
uid="@azure/cosmos.ItemDefinition" />>
- name: readAll<T>(FeedOptions)
uid: '@azure/cosmos.Items.readAll_1'
package: '@azure/cosmos'
summary: >+
Read all items.
Any provided type, T, is not necessarily enforced by the SDK.
You may get more or less properties and it's up to your logic to enforce
it.
There is no set schema for JSON items. They may contain any number of
custom properties.
**Example**
Read all items to array.
```typescript
const {body: containerList} = await items.readAll().fetchAll();
```
remarks: ''
isDeprecated: false
syntax:
content: 'function readAll<T>(options?: FeedOptions): QueryIterator<T>'
parameters:
- id: options
type: <xref uid="@azure/cosmos.FeedOptions" />
description: >-
Used for modifying the request (for instance, specifying the
partition key).
return:
description: ''
type: <xref uid="@azure/cosmos.QueryIterator" /><T>
- name: readChangeFeed(ChangeFeedOptions)
uid: '@azure/cosmos.Items.readChangeFeed_1'
package: '@azure/cosmos'
summary: Create a `ChangeFeedIterator` to iterate over pages of changes
remarks: ''
isDeprecated: true
customDeprecatedMessage: Use `changeFeed` instead.
syntax:
content: >-
function readChangeFeed(changeFeedOptions?: ChangeFeedOptions):
ChangeFeedIterator<any>
parameters:
- id: changeFeedOptions
type: <xref uid="@azure/cosmos.ChangeFeedOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/cosmos.ChangeFeedIterator" /><any>
- name: readChangeFeed(PartitionKey, ChangeFeedOptions)
uid: '@azure/cosmos.Items.readChangeFeed'
package: '@azure/cosmos'
summary: |+
Create a `ChangeFeedIterator` to iterate over pages of changes
**Example**
Read from the beginning of the change feed.
```javascript
const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
```
remarks: ''
isDeprecated: true
customDeprecatedMessage: Use `changeFeed` instead.
syntax:
content: >-
function readChangeFeed(partitionKey: PartitionKey, changeFeedOptions?:
ChangeFeedOptions): ChangeFeedIterator<any>
parameters:
- id: partitionKey
type: <xref uid="@azure/cosmos.PartitionKey" />
description: ''
- id: changeFeedOptions
type: <xref uid="@azure/cosmos.ChangeFeedOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/cosmos.ChangeFeedIterator" /><any>
- name: readChangeFeed<T>(ChangeFeedOptions)
uid: '@azure/cosmos.Items.readChangeFeed_3'
package: '@azure/cosmos'
summary: Create a `ChangeFeedIterator` to iterate over pages of changes
remarks: ''
isDeprecated: true
customDeprecatedMessage: Use `changeFeed` instead.
syntax:
content: >-
function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions):
ChangeFeedIterator<T>
parameters:
- id: changeFeedOptions
type: <xref uid="@azure/cosmos.ChangeFeedOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/cosmos.ChangeFeedIterator" /><T>
- name: readChangeFeed<T>(PartitionKey, ChangeFeedOptions)
uid: '@azure/cosmos.Items.readChangeFeed_2'
package: '@azure/cosmos'
summary: Create a `ChangeFeedIterator` to iterate over pages of changes
remarks: ''
isDeprecated: true
customDeprecatedMessage: Use `changeFeed` instead.
syntax:
content: >-
function readChangeFeed<T>(partitionKey: PartitionKey,
changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
parameters:
- id: partitionKey
type: <xref uid="@azure/cosmos.PartitionKey" />
description: ''
- id: changeFeedOptions
type: <xref uid="@azure/cosmos.ChangeFeedOptions" />
description: ''
return:
description: ''
type: <xref uid="@azure/cosmos.ChangeFeedIterator" /><T>
- name: upsert(unknown, RequestOptions)
uid: '@azure/cosmos.Items.upsert'
package: '@azure/cosmos'
summary: >-
Upsert an item.
There is no set schema for JSON items. They may contain any number of
custom properties.
remarks: ''
isDeprecated: false
syntax:
content: >-
function upsert(body: unknown, options?: RequestOptions):
Promise<ItemResponse<ItemDefinition>>
parameters:
- id: body
type: unknown
description: >-
Represents the body of the item. Can contain any number of user
defined properties.
- id: options
type: <xref uid="@azure/cosmos.RequestOptions" />
description: >-
Used for modifying the request (for instance, specifying the
partition key).
return:
description: ''
type: >-
Promise<<xref uid="@azure/cosmos.ItemResponse" /><<xref
uid="@azure/cosmos.ItemDefinition" />>>
- name: upsert<T>(T, RequestOptions)
uid: '@azure/cosmos.Items.upsert_1'
package: '@azure/cosmos'
summary: >-
Upsert an item.
Any provided type, T, is not necessarily enforced by the SDK.
You may get more or less properties and it's up to your logic to enforce
it.
There is no set schema for JSON items. They may contain any number of
custom properties.
remarks: ''
isDeprecated: false
syntax:
content: >-
function upsert<T>(body: T, options?: RequestOptions):
Promise<ItemResponse<T>>
parameters:
- id: body
type: T
description: >-
Represents the body of the item. Can contain any number of user
defined properties.
- id: options
type: <xref uid="@azure/cosmos.RequestOptions" />
description: >-
Used for modifying the request (for instance, specifying the
partition key).
return:
description: ''
type: Promise<<xref uid="@azure/cosmos.ItemResponse" /><T>>