-
Notifications
You must be signed in to change notification settings - Fork 65
/
Copy pathMongoCollection+Read+AsyncAwait.swift
161 lines (155 loc) · 7.12 KB
/
MongoCollection+Read+AsyncAwait.swift
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
#if compiler(>=5.5.2) && canImport(_Concurrency)
/// Extension to `MongoCollection` to support async/await read APIs.
@available(macOS 10.15.0, *)
extension MongoCollection {
/**
* Finds the documents in this collection which match the provided filter.
*
* - Parameters:
* - filter: A `BSONDocument` that should match the query.
* - options: Optional `FindOptions` to use when executing the command.
* - session: Optional `ClientSession` to use when executing this command.
*
* - Returns: A `MongoCursor` over the resulting `BSONDocument`s.
*
* - Throws:
* - `MongoError.InvalidArgumentError` if the options passed are an invalid combination.
* - `MongoError.LogicError` if the provided session is inactive.
* - `EncodingError` if an error occurs while encoding the options to BSON.
*/
public func find(
_ filter: BSONDocument = [:],
options: FindOptions? = nil,
session: ClientSession? = nil
) async throws -> MongoCursor<CollectionType> {
try await self.find(filter, options: options, session: session).get()
}
/**
* Finds a single document in this collection that matches the provided filter.
*
* - Parameters:
* - filter: A `BSONDocument` that should match the query.
* - options: Optional `FindOneOptions` to use when executing the command.
* - session: Optional `ClientSession` to use when executing this command.
*
* - Returns: the resulting `BSONDocument`, or nil if there is no match.
*
* - Throws:
* - `MongoError.InvalidArgumentError` if the options passed are an invalid combination.
* - `MongoError.LogicError` if the provided session is inactive.
* - `EncodingError` if an error occurs while encoding the options to BSON.
*/
public func findOne(
_ filter: BSONDocument = [:],
options: FindOneOptions? = nil,
session: ClientSession? = nil
) async throws -> T? {
try await self.findOne(filter, options: options, session: session).get()
}
/**
* Runs an aggregation framework pipeline against this collection.
*
* - Parameters:
* - pipeline: an `[BSONDocument]` containing the pipeline of aggregation operations to perform.
* - options: Optional `AggregateOptions` to use when executing the command.
* - session: Optional `ClientSession` to use when executing this command.
*
* - Returns: A `MongoCursor` over the resulting `BSONDocument`s.
*
* - Throws:
* - `MongoError.InvalidArgumentError` if the options passed are an invalid combination.
* - `MongoError.LogicError` if the provided session is inactive.
* - `EncodingError` if an error occurs while encoding the options to BSON.
*/
public func aggregate(
_ pipeline: [BSONDocument],
options: AggregateOptions? = nil,
session: ClientSession? = nil
) async throws -> MongoCursor<BSONDocument> {
try await self.aggregate(pipeline, options: options, session: session, withOutputType: BSONDocument.self).get()
}
/**
* Runs an aggregation framework pipeline against this collection.
* Associates the specified `Codable` type `OutputType` with the returned `MongoCursor`.
*
* - Parameters:
* - pipeline: an `[BSONDocument]` containing the pipeline of aggregation operations to perform.
* - options: Optional `AggregateOptions` to use when executing the command.
* - session: Optional `ClientSession` to use when executing this command.
* - withOutputType: the type that each resulting document of the output
* of the aggregation operation will be decoded to.
*
* - Returns: A `MongoCursor` over the resulting `OutputType`s.
*
* - Throws:
* - `MongoError.InvalidArgumentError` if the options passed are an invalid combination.
* - `MongoError.LogicError` if the provided session is inactive.
* - `EncodingError` if an error occurs while encoding the options to BSON.
*/
public func aggregate<OutputType: Codable>(
_ pipeline: [BSONDocument],
options: AggregateOptions? = nil,
session: ClientSession? = nil,
withOutputType _: OutputType.Type
) async throws -> MongoCursor<OutputType> {
try await self.aggregate(pipeline, options: options, session: session, withOutputType: OutputType.self).get()
}
/**
* Counts the number of documents in this collection matching the provided filter. Note that an empty filter will
* force a scan of the entire collection. For a fast count of the total documents in a collection see
* `estimatedDocumentCount`.
*
* - Parameters:
* - filter: a `BSONDocument`, the filter that documents must match in order to be counted.
* - options: Optional `CountDocumentsOptions` to use when executing the command.
* - session: Optional `ClientSession` to use when executing this command.
*
* - Returns: The count of the documents that matched the filter.
*/
public func countDocuments(
_ filter: BSONDocument = [:],
options: CountDocumentsOptions? = nil,
session: ClientSession? = nil
) async throws -> Int {
try await self.countDocuments(filter, options: options, session: session).get()
}
/**
* Gets an estimate of the count of documents in this collection using collection metadata. This operation cannot
* be used in a transaction.
*
* - Parameters:
* - options: Optional `EstimatedDocumentCountOptions` to use when executing the command.
*
* - Returns: an estimate of the count of documents in this collection.
*/
public func estimatedDocumentCount(options: EstimatedDocumentCountOptions? = nil) async throws -> Int {
try await self.estimatedDocumentCount(options: options).get()
}
/**
* Finds the distinct values for a specified field across the collection.
*
* - Parameters:
* - fieldName: The field for which the distinct values will be found.
* - filter: a `BSONDocument` representing the filter documents must match in order to be considered for the
* operation.
* - options: Optional `DistinctOptions` to use when executing the command.
* - session: Optional `ClientSession` to use when executing this command.
*
* - Returns: A `[BSON]` containing the distinct values for the specified criteria.
*
* - Throws:
* - `MongoError.CommandError` if an error occurs that prevents the command from executing.
* - `MongoError.InvalidArgumentError` if the options passed in form an invalid combination.
* - `MongoError.LogicError` if the provided session is inactive.
* - `EncodingError` if an error occurs while encoding the options to BSON.
*/
public func distinct(
fieldName: String,
filter: BSONDocument = [:],
options: DistinctOptions? = nil,
session: ClientSession? = nil
) async throws -> [BSON] {
try await self.distinct(fieldName: fieldName, filter: filter, options: options, session: session).get()
}
}
#endif