This repository was archived by the owner on Feb 9, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocumentclient.js
1584 lines (1433 loc) · 73.2 KB
/
documentclient.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//----------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
//----------------------------------------------------------------------------
var Base = require("./base")
, AzureDocuments = require('./documents')
, QueryIterator = require('./queryIterator')
, RequestHandler = require('./request')
, Constants = require('./constants');
//SCRIPT START
var DocumentClient = Base.defineClass(
/**
* Provides a client-side logical representation of the Azure DocumentDB database account. This client is used to configure and execute requests against the service.
* @constructor DocumentClient
* @param {string} urlConnection - The service endpoint to use to create the client.
* @param {object} auth - An object that is used for authenticating requests and must contains one of the options
* @param {string} [auth.masterkey] - The authorization master key to use to create the client.
* @param {Object} [auth.resourceTokens] - An object that contains resources tokens. Keys for the object are resource Ids and values are the resource tokens.
* @param {Array} [auth.permissionFeed] - An array of {@link Permission} objects.
* @param {object} [connectionPolicy] - An instance of {@link ConnectionPolicy} class. This parameter is optional and the default connectionPolicy will be used if omitted.
* @param {string} [consistencyLevel] - An optional parameter that represents the consistency level. It can take any value from {@link ConsistencyLevel}.
*/
function DocumentClient(urlConnection, auth, connectionPolicy, consistencyLevel) {
this.urlConnection = urlConnection;
if( auth !== undefined ) {
this.masterKey = auth.masterKey;
this.resourceTokens = auth.resourceTokens;
if (auth.permissionFeed) {
this.resourceTokens = {};
for (var i = 0; i < auth.permissionFeed.length; i++ ){
var resourceParts = auth.permissionFeed[i].resource.split("/");
var rid = resourceParts[resourceParts.length - 1];
this.resourceTokens[rid] = auth.permissionFeed[i]._token;
}
}
}
this.connectionPolicy = connectionPolicy || new AzureDocuments.ConnectionPolicy();
this.defaultHeaders = {};
this.defaultHeaders[Constants.HttpHeaders.CacheControl] = "no-cache";
this.defaultHeaders[Constants.HttpHeaders.Version] = Constants.CurrentVersion;
if (consistencyLevel !== undefined){
this.defaultHeaders[Constants.HttpHeaders.ConsistencyLevel] = consistencyLevel;
}
if (Constants.UserAgent) {
this.defaultHeaders[Constants.HttpHeaders.UserAgent] = Constants.UserAgent;
}
// overide this for default query params to be added to the url.
this.defaultUrlParams = "";
},
{
/** Send a request for creating a database.
* <p>
* A database manages users, permissions and a set of collections. <br>
* Each Azure DocumentDB Database Account is able to support multiple independent named databases, with the database being the logical container for data. <br>
* Each Database consists of one or more collections, each of which in turn contain one or more documents. Since databases are an an administrative resource, the Service Master Key will be required in order to access and successfully complete any action using the User APIs. <br>
* </p>
* @memberof DocumentClient
* @instance
* @param {Object} body - A json object that represents The database to be created.
* @param {string} body.id - The id of the database.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
createDatabase: function (body, options, callback) {
if (!callback) {
callback = options;
}
var path = "/dbs";
this.create(body, path, "dbs", undefined, undefined, options, callback);
},
/**
* Creates a collection.
* <p>
* A collection is a named logical container for documents. <br>
* A database may contain zero or more named collections and each collection consists of zero or more JSON documents. <br>
* Being schema-free, the documents in a collection do not need to share the same structure or fields. <br>
* Since collections are application resources, they can be authorized using either the master key or resource keys. <br>
* </p>
* @memberof DocumentClient
* @instance
* @param {string} databaseLink - The self-link of the database.
* @param {object} body - Represents the body of the collection.
* @param {string} body.id - The id of the collection.
* @param {IndexingPolicy} body.indexingPolicy - The indexing policy associated with the collection.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
createCollection: function (databaseLink, body, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + databaseLink + "colls/";
var resourceInfo = Base.parsePath(databaseLink);
this.create(body, path, "colls", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Create a document.
* <p>
* There is no set schema for JSON documents. They may contain any number of custom properties as well as an optional list of attachments. <br>
* A Document is an application resource and can be authorized using the master key or resource keys
* </p>
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {object} body - Represents the body of the document. Can contain any number of user defined properties.
* @param {string} [body.id] - The id of the document, MUST be unique for each document.
* @param {RequestOptions} [options] - The request options.
* @param {boolean} [options.disableAutomaticIdGeneration] - Disables the automatic id generation. If id is missing in the body and this option is true, an error will be returned.
* @param {RequestCallback} callback - The callback for the request.
*/
createDocument: function (collectionLink, body, options, callback) {
if (!callback) {
callback = options;
options = {};
}
// Generate random document id if the id is missing in the payload and options.disableAutomaticIdGeneration != true
if ((body.id === undefined || body.id === "") && !options.disableAutomaticIdGeneration) {
body.id = Base.generateGuidId();
}
var path = "/" + collectionLink + "docs/";
var resourceInfo = Base.parsePath(collectionLink);
this.create(body, path, "docs", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Create an attachment for the document object.
* <p>
* Each document may contain zero or more attachemnts. Attachments can be of any MIME type - text, image, binary data. <br>
* These are stored externally in Azure Blob storage. Attachments are automatically deleted when the parent document is deleted.
* </P>
* @memberof DocumentClient
* @instance
* @param {string} documentLink - The self-link of the document.
* @param {Object} body - The metadata the defines the attachment media like media, contentType. It can include any other properties as part of the metedata.
* @param {string} body.contentType - The MIME contentType of the attachment.
* @param {string} body.media - Media link associated with the attachment content.
* @param {RequestOptions} options - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
createAttachment: function (documentLink, body, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + documentLink + "attachments/";
var resourceInfo = Base.parsePath(documentLink);
this.create(body, path, "attachments", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Create a database user.
* @memberof DocumentClient
* @instance
* @param {string} databaseLink - The self-link of the database.
* @param {object} body - Represents the body of the user.
* @param {string} body.id - The id of the user.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
createUser: function (databaseLink, body, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + databaseLink + "users/";
var resourceInfo = Base.parsePath(databaseLink);
this.create(body, path, "users", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Create a permission.
* <p> A permission represents a per-User Permission to access a specific resource e.g. Document or Collection. </p>
* @memberof DocumentClient
* @instance
* @param {string} userLink - The self-link of the user.
* @param {object} body - Represents the body of the permission.
* @param {string} body.id - The id of the permission
* @param {string} body.permissionMode - The mode of the permission, must be a value of {@link PermissionMode}
* @param {string} body.resource - The link of the resource that the permission will be applied to.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
createPermission: function(userLink, body, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + userLink + "permissions/";
var resourceInfo = Base.parsePath(userLink);
this.create(body, path, "permissions", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Create a trigger.
* <p>
* DocumentDB supports pre and post triggers defined in JavaScript to be executed on creates, updates and deletes. <br>
* For additional details, refer to the server-side JavaScript API documentation.
* </p>
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {object} trigger - Represents the body of the trigger.
* @param {string} trigger.id - The id of the trigger.
* @param {string} trigger.triggerType - The type of the trigger, should be one of the values of {@link TriggerType}.
* @param {string} trigger.triggerOperation - The trigger operation, should be one of the values of {@link TriggerOperation}.
* @param {function} trigger.serverScript - The body of the trigger, it can be passed as stringified too.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
createTrigger: function (collectionLink, trigger, options, callback) {
var that = this;
if (!callback) {
callback = options;
options = {};
}
if (trigger.serverScript) {
trigger.body = trigger.serverScript.toString();
} else if (trigger.body) {
trigger.body = trigger.body.toString();
}
var resourceInfo = Base.parsePath(collectionLink);
var path = "/" + collectionLink + "triggers/";
this.create(trigger, path, "triggers", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Create a UserDefinedFunction.
* <p>
* DocumentDB supports JavaScript UDFs which can be used inside queries, stored procedures and triggers. <br>
* For additional details, refer to the server-side JavaScript API documentation.
* </p>
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {object} udf - Represents the body of the userDefinedFunction.
* @param {string} udf.id - The id of the udf.
* @param {string} udf.userDefinedFunctionType - The type of the udf, it should be one of the values of {@link UserDefinedFunctionType}
* @param {function} udf.serverScript - Represents the body of the udf, it can be passed as stringified too.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
createUserDefinedFunction: function (collectionLink, udf, options, callback) {
if (!callback) {
callback = options;
options = {};
}
if (udf.serverScript) {
udf.body = udf.serverScript.toString();
} else if (udf.body) {
udf.body = udf.body.toString();
}
var path = "/" + collectionLink + "udfs/";
var resourceInfo = Base.parsePath(collectionLink);
this.create(udf, path, "udfs", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Create a StoredProcedure.
* <p>
* DocumentDB allows stored procedures to be executed in the storage tier, directly against a document collection. The script <br>
* gets executed under ACID transactions on the primary storage partition of the specified collection. For additional details, <br>
* refer to the server-side JavaScript API documentation.
* </p>
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {object} sproc - Represents the body of the stored procedure.
* @param {string} sproc.id - The id of the stored procedure.
* @param {function} sproc.serverScript - The body of the stored procedure, it can be passed as stringified too.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
createStoredProcedure: function (collectionLink, sproc, options, callback) {
if (!callback) {
callback = options;
options = {};
}
if (sproc.serverScript) {
sproc.body = sproc.serverScript.toString();
} else if (sproc.body) {
sproc.body = sproc.body.toString();
}
var path = "/" + collectionLink + "sprocs/";
var resourceInfo = Base.parsePath(collectionLink);
this.create(sproc, path, "sprocs", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Create an attachment for the document object.
* @memberof DocumentClient
* @instance
* @param {string} documentLink - The self-link of the document.
* @param {stream.Readable} readableStream - the stream that represents the media itself that needs to be uploaded.
* @param {MediaOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
createAttachmentAndUploadMedia: function(documentLink, readableStream, options, callback) {
if (!callback) {
callback = options;
options = {};
}
options = options || {};
var initialHeaders = Base.extend({}, this.defaultHeaders);
// Add required headers slug and content-type.
if (options.slug) {
initialHeaders[Constants.HttpHeaders.Slug] = options.slug;
}
if (options.contentType) {
initialHeaders[Constants.HttpHeaders.ContentType] = options.contentType;
} else {
initialHeaders[Constants.HttpHeaders.ContentType] = Constants.MediaTypes.OctetStream;
}
var path = "/" + documentLink + "attachments/";
var resourceInfo = Base.parsePath(documentLink);
this.create(readableStream, path, "attachments", resourceInfo.objectBody.id, initialHeaders, options, callback);
},
/** Reads a database.
* @memberof DocumentClient
* @instance
* @param {string} databaseLink - The self-link of the database.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
readDatabase: function (databaseLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + databaseLink;
var resourceInfo = Base.parsePath(databaseLink);
this.read(path, "dbs", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Reads a collection.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
readCollection: function (collectionLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + collectionLink;
var resourceInfo = Base.parsePath(collectionLink);
this.read(path, "colls", resourceInfo.objectBody.id, undefined, options, callback)
},
/**
* Reads a document.
* @memberof DocumentClient
* @instance
* @param {string} documentLink - The self-link of the document.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
readDocument: function (documentLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + documentLink;
var resourceInfo = Base.parsePath(documentLink);
this.read(path, "docs", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Reads an Attachment object.
* @memberof DocumentClient
* @instance
* @param {string} attachmentLink - The self-link of the attachment.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
readAttachment: function (attachmentLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + attachmentLink;
var resourceInfo = Base.parsePath(attachmentLink);
this.read(path, "attachments", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Reads a user.
* @memberof DocumentClient
* @instance
* @param {string} userLink - The self-link of the user.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
readUser: function (userLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + userLink;
var resourceInfo = Base.parsePath(userLink);
this.read(path, "users", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Reads a permission.
* @memberof DocumentClient
* @instance
* @param {string} permissionLink - The self-link of the permission.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
readPermission: function (permissionLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + permissionLink;
var resourceInfo = Base.parsePath(permissionLink);
this.read(path, "permissions", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Reads a trigger object.
* @memberof DocumentClient
* @instance
* @param {string} triggerLink - The self-link of the trigger.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
readTrigger: function (triggerLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var resourceInfo = Base.parsePath(triggerLink);
var path = "/" + triggerLink;
this.read(path, "triggers", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Reads a udf object.
* @memberof DocumentClient
* @instance
* @param {string} udfLink - The self-link of the user defined function.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
readUserDefinedFunction: function (udfLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + udfLink;
var resourceInfo = Base.parsePath(udfLink);
this.read(path, "udfs", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Reads a StoredProcedure object.
* @memberof DocumentClient
* @instance
* @param {string} sprocLink - The self-link of the stored procedure.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
readStoredProcedure: function (sprocLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + sprocLink;
var resourceInfo = Base.parsePath(sprocLink);
this.read(path, "sprocs", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Reads a conflict.
* @memberof DocumentClient
* @instance
* @param {string} conflictLink - The self-link of the conflict.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
readConflict: function (conflictLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + conflictLink;
var resourceInfo = Base.parsePath(conflictLink);
this.read(path, "conflicts", resourceInfo.objectBody.id, undefined, options, callback);
},
/** lLsts all databases.
* @memberof DocumentClient
* @instance
* @param {FeedOptions} [options] - The feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
readDatabases: function (options) {
return this.queryDatabases(undefined, options);
},
/**
* Get all collections in this database.
* @memberof DocumentClient
* @instance
* @param {string} databaseLink - The self-link of the database.
* @param {FeedOptions} [options] - The feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
readCollections: function (databaseLink, options) {
return this.queryCollections(databaseLink, undefined, options);
},
/**
* Get all documents in this collection.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {FeedOptions} [options] - The feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
readDocuments: function (collectionLink, options) {
return this.queryDocuments(collectionLink, undefined, options);
},
/**
* Get all attachments for this document.
* @memberof DocumentClient
* @instance
* @param {string} documentLink - The self-link of the document.
* @param {FeedOptions} [options] - The feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
readAttachments: function (documentLink, options) {
return this.queryAttachments(documentLink, undefined, options);
},
/**
* Get all users in this database.
* @memberof DocumentClient
* @instance
* @param {string} databaseLink - The self-link of the database.
* @param {FeedOptions} [feedOptions] - The feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
readUsers: function (databaseLink, options) {
return this.queryUsers(databaseLink, undefined, options);
},
/**
* Get all permissions for this user.
* @memberof DocumentClient
* @instance
* @param {string} userLink - The self-link of the user.
* @param {FeedOptions} [feedOptions] - The feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
readPermissions: function(userLink, options) {
return this.queryPermissions(userLink, undefined, options);
},
/**
* Get all triggers in this collection.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {FeedOptions} [options] - The feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
readTriggers: function (collectionLink, options) {
return this.queryTriggers(collectionLink, undefined, options);
},
/**
* Get all UserDefinedFunctions in this collection.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {FeedOptions} [options] - The feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
readUserDefinedFunctions: function (collectionLink, options) {
return this.queryUserDefinedFunctions(collectionLink, undefined, options);
},
/**
* Get all StoredProcedures in this collection.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {FeedOptions} [options] - The feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
readStoredProcedures: function (collectionLink, options, callback) {
return this.queryStoredProcedures(collectionLink, undefined, options);
},
/**
* Get all conflicts in this collection.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {FeedOptions} [options] - The feed options.
* @returns {QueryIterator} - An instance of QueryIterator to handle reading feed.
*/
readConflicts: function (collectionLink, options) {
var that = this;
var path = "/" + collectionLink + "conflicts/";
var resourceInfo = Base.parsePath(collectionLink);
return new QueryIterator(this, "", options, function(options, callback){
that.queryFeed.call(that,
that,
path,
"conflicts",
resourceInfo.objectBody.id,
function(result) { return result.Conflicts; },
function(parent, body) { return body; },
"",
options,
callback);
});
},
/** Lists all databases that satisfy a query.
* @memberof DocumentClient
* @instance
* @param {string} query - A SQL query string.
* @param {FeedOptions} [options] - The feed options.
* @returns {QueryIterator} - An instance of QueryIterator to handle reading feed.
*/
queryDatabases: function (query, options) {
var that = this;
return new QueryIterator(this, query, options, function (options, callback) {
that.queryFeed.call(that,
that,
"/dbs",
"dbs",
"",
function (result) { return result.Databases; },
function (parent, body) { return body; },
query,
options,
callback);
});
},
/**
* Query the collections for the database.
* @memberof DocumentClient
* @instance
* @param {string} databaseLink - The self-link of the database.
* @param {string} query - A SQL query string.
* @param {FeedOptions} [options] - Represents the feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
queryCollections: function (databaseLink, query, options) {
var that = this;
var path = "/" + databaseLink + "colls/";
var resourceInfo = Base.parsePath(databaseLink);
return new QueryIterator(this, query, options, function(options, callback) {
that.queryFeed.call(that,
that,
path,
"colls",
resourceInfo.objectBody.id,
function(result) { return result.DocumentCollections; },
function(parent, body) { return body; },
query,
options,
callback);
});
},
/**
* Query the documents for the collection.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {string} query - A SQL query string.
* @param {FeedOptions} [options] - Represents the feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
queryDocuments: function (collectionLink, query, options) {
var that = this;
var path = "/" + collectionLink + "docs/";
var resourceInfo = Base.parsePath(collectionLink);
return new QueryIterator(this, query, options, function(options, callback){
that.queryFeed.call(that,
that,
path,
"docs",
resourceInfo.objectBody.id,
function(result) { return result.Documents; },
function(parent, body) { return body; },
query,
options,
callback);
});
},
/**
* Query the attachments for the document.
* @memberof DocumentClient
* @instance
* @param {string} documentLink - The self-link of the document.
* @param {string} query - A SQL query string.
* @param {FeedOptions} [options] - Represents the feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
queryAttachments: function (documentLink, query, options) {
var that = this;
var path = "/" + documentLink + "attachments/";
var resourceInfo = Base.parsePath(documentLink);
return new QueryIterator(this, query, options, function(options, callback){
that.queryFeed.call(that,
that,
path,
"attachments",
resourceInfo.objectBody.id,
function(result) { return result.Attachments; },
function(parent, body) { return body;},
query,
options,
callback);
});
},
/**
* Query the users for the database.
* @memberof DocumentClient
* @instance
* @param {string} databaseLink - The self-link of the database.
* @param {string} query - A SQL query string.
* @param {FeedOptions} [options] - Represents the feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
queryUsers: function(databaseLink, query, options) {
var that = this;
var path = "/" + databaseLink + "users/";
var resourceInfo = Base.parsePath(databaseLink);
return new QueryIterator(this, query, options, function(options, callback){
that.queryFeed.call(that,
that,
path,
"users",
resourceInfo.objectBody.id,
function(result) { return result.Users; },
function(parent, body) { return body; },
query,
options,
callback);
});
},
/**
* Query the permission for the user.
* @memberof DocumentClient
* @instance
* @param {string} userLink - The self-link of the user.
* @param {string} query - A SQL query string.
* @param {FeedOptions} [options] - Represents the feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
queryPermissions: function(userLink, query, options) {
var that = this;
var resourceInfo = Base.parsePath(userLink);
var path = "/" + userLink + "permissions/";
return new QueryIterator(this, query, options, function(options, callback){
that.queryFeed.call(that,
that,
path,
"permissions",
resourceInfo.objectBody.id,
function(result) { return result.Permissions; },
function(parent, body) { return body; },
query,
options,
callback);
});
},
/**
* Query the triggers for the collection.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {string} query - A SQL query string.
* @param {FeedOptions} [options] - Represents the feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
queryTriggers: function (collectionLink, query, options) {
var that = this;
var resourceInfo = Base.parsePath(collectionLink);
var path = "/" + collectionLink + "triggers/";
return new QueryIterator(this, query, options, function(options, callback){
that.queryFeed.call(that,
that,
path,
"triggers",
resourceInfo.objectBody.id,
function(result) { return result.Triggers; },
function(parent, body) { return body; },
query,
options,
callback);
});
},
/**
* Query the user defined functions for the collection.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {string} query - A SQL query string.
* @param {FeedOptions} [options] - Represents the feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
queryUserDefinedFunctions: function (collectionLink, query, options) {
var that = this;
var path = "/" + collectionLink + "udfs/";
var resourceInfo = Base.parsePath(collectionLink);
return new QueryIterator(this, query, options, function(options, callback){
that.queryFeed.call(that,
that,
path,
"udfs",
resourceInfo.objectBody.id,
function(result) { return result.UserDefinedFunctions; },
function(parent, body) { return body; },
query,
options,
callback);
});
},
/**
* Query the storedProcedures for the collection.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {string} query - A SQL query string.
* @param {FeedOptions} [options] - Represents the feed options.
* @returns {QueryIterator} - An instance of queryIterator to handle reading feed.
*/
queryStoredProcedures: function (collectionLink, query, options) {
var that = this;
var resourceInfo = Base.parsePath(collectionLink);
var path = "/" + collectionLink + "sprocs/";
return new QueryIterator(this, query, options, function(options, callback){
that.queryFeed.call(that,
that,
path,
"sprocs",
resourceInfo.objectBody.id,
function(result) { return result.StoredProcedures; },
function(parent, body) { return body; },
query,
options,
callback);
});
},
/**
* Delete the database object.
* @memberof DocumentClient
* @instance
* @param {string} databaseLink - The self-link of the database.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
deleteDatabase: function (databaseLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + databaseLink;
var resourceInfo = Base.parsePath(databaseLink);
this.deleteResource(path, "dbs", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Delete the collection object.
* @memberof DocumentClient
* @instance
* @param {string} collectionLink - The self-link of the collection.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
deleteCollection: function (collectionLink, options, callback) {
var that = this;
if (!callback) {
callback = options;
options = {};
}
var path = "/" + collectionLink;
var resourceInfo = Base.parsePath(collectionLink);
this.deleteResource(path, "colls", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Delete the document object.
* @memberof DocumentClient
* @instance
* @param {string} documentLink - The self-link of the document.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
deleteDocument: function (documentLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + documentLink;
var resourceInfo = Base.parsePath(documentLink);
this.deleteResource(path, "docs", resourceInfo.objectBody.id, undefined, options, callback);
},
/**
* Delete the attachment object.
* @memberof DocumentClient
* @instance
* @param {string} attachmentLink - The self-link of the attachment.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
deleteAttachment: function (attachmentLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + attachmentLink;
var resourceInfo = Base.parsePath(attachmentLink);
this.deleteResource(path, "attachments", resourceInfo.objectBody.id, undefined, options, callback)
},
/**
* Delete the user object.
* @memberof DocumentClient
* @instance
* @param {string} userLink - The self-link of the user.
* @param {RequestOptions} [options] - The request options.
* @param {RequestCallback} callback - The callback for the request.
*/
deleteUser: function(userLink, options, callback) {
if (!callback) {
callback = options;
options = {};
}
var path = "/" + userLink;
var resourceInfo = Base.parsePath(userLink);
this.deleteResource(path, "users", resourceInfo.objectBody.id, undefined, options, callback);
},