MongoCollection 拡張リファレンス


                    
                    
                    watch(delegate:queue:)

コレクションに対して MongoDB 変更ストリームを開き、変更を監視します。結果のストリームには、構成された MongoDB ルールに基づいて参照する権限を持つこのコレクションのすべてのイベントが通知されます。

宣言

Swift

public func watch(delegate: ChangeEventDelegate, queue: DispatchQueue = .main) -> ChangeStream

パラメーター

`delegate`	結果として得られる変更ストリームからのイベントとエラーに対応するReact 。
`queue`	ストリーミングイベントをオプションのキューにディスパッチします。キューが提供されない場合は、メインキューが使用されます。

戻り値

ストリーミングイベントを管理する ChangeStream 。

Githubでの表示


                    
                    
                    watch(matchFilter:delegate:queue:)

コレクションに対して MongoDB 変更ストリームを開き、変更を監視します。提供された BSON ドキュメントは、ストリームから取得される変更イベントのマッチ式フィルターとして使用されます。

https://mongodb.com/java-j/docs/manual/reference/operator/aggregation/match/を参照してください一致フィルターの定義方法に関するドキュメントについては、を参照してください。

ChangeEvents をフィルタリングするためのマッチ式の定義は、trigger のマッチ式を定義するのと同様です。 https://mongodb.com/java-j/docs/realm/triggers/database-triggers/

宣言

Swift

public func watch(matchFilter: Document, delegate: ChangeEventDelegate, queue: DispatchQueue = .main) -> ChangeStream

パラメーター

`matchFilter`	受信変更イベントに適用する $match フィルター
`delegate`	結果として得られる変更ストリームからのイベントとエラーに対応するReact 。
`queue`	ストリーミングイベントをオプションのキューにディスパッチします。キューが提供されない場合は、メインキューが使用されます。

戻り値

ストリーミングイベントを管理する ChangeStream 。

Githubでの表示


                    
                    
                    watch(filterIds:delegate:queue:)

コレクションに対して MongoDB 変更ストリームを開き、特定のドキュメントに加えられた変更を監視します。監視するドキュメントは、 _id によって明示的に指定される必要があります。

宣言

Swift

public func watch(filterIds: [ObjectId], delegate: ChangeEventDelegate, queue: DispatchQueue = .main) -> ChangeStream

パラメーター

`filterIds`	監視するコレクション内の _ids のリスト。
`delegate`	結果として得られる変更ストリームからのイベントとエラーに対応するReact 。
`queue`	ストリーミングイベントをオプションのキューにディスパッチします。キューが提供されない場合は、メインキューが使用されます。

戻り値

ストリーミングイベントを管理する ChangeStream 。

Githubでの表示


                    
                    
                    insertOne(_:_:)

指定された値を BSON にエンコードし、挿入します。値に識別子がない場合、その値に対して識別子が生成されます。

宣言

Swift

@preconcurrency
public func insertOne(_ document: Document, _ completion: @escaping MongoInsertBlock)

パラメーター

`document`	挿入するドキュメント A `Document`値。
`completion`	挿入を実行しようとした結果です。成功時に挿入されたオブジェクトの ID が返されます

Githubでの表示


                    
                    
                    insertMany(_:_:)

指定された値を BSON にエンコードし、挿入します。識別子が欠落している値は生成されます。

宣言

Swift

@preconcurrency
public func insertMany(_ documents: [Document], _ completion: @escaping MongoInsertManyBlock)

パラメーター

`documents`	挿入するBSON配列内の `Document` 値。
`completion`	挿入の結果、は、挿入された配列ドキュメント ID を順番に返します。

Githubでの表示


                    
                    
                    find(filter:options:_:)

このコレクション内の指定されたフィルターに一致するドキュメントを検索します。

宣言

Swift

@preconcurrency
public func find(filter: Document, options: FindOptions = FindOptions(),
                 _ completion: @escaping MongoFindBlock)

パラメーター

`filter`	クエリに一致する必要があるBSONとしての `Document`。
`options`	`FindOptions` コマンドを実行するときに使用します。
`completion`	ドキュメントの結果としてのBSON配列やエラーが発生した場合は、

Githubでの表示


                    
                    
                    findOneDocument(filter:options:_:)

指定されたフィルターに一致するコレクションまたはビューから 1 つのドキュメントを返します。クエリを満たすドキュメントが複数ある場合、このメソッドではクエリのソート順または自然な順序に従って最初のドキュメントが返されます。

宣言

Swift

@preconcurrency
public func findOneDocument(filter: Document, options: FindOptions = FindOptions(),
                            _ completion: @escaping MongoFindOneBlock)

パラメーター

`filter`	クエリに一致する必要があるBSONとしての `Document`。
`options`	`FindOptions` コマンドを実行するときに使用します。
`completion`	BSONまたはエラーが発生した場合

Githubでの表示


                    
                    
                    aggregate(pipeline:_:)

このコレクションに対して集計フレームワークパイプラインを実行します。

宣言

Swift

@preconcurrency
public func aggregate(pipeline: [Document], _ completion: @escaping MongoFindBlock)

パラメーター

`pipeline`	実行される集計操作のパイプラインを含む `Documents` で構成されるBSON配列。
`completion`	ドキュメントの結果としてのBSON配列やエラーが発生した場合は、

Githubでの表示


                    
                    
                    count(filter:limit:_:)

指定されたフィルターに一致するこのコレクション内のドキュメントの数をカウントします。

宣言

Swift

@preconcurrency
public func count(filter: Document, limit: Int? = nil, _ completion: @escaping MongoCountBlock)

パラメーター

`filter`	クエリに一致する必要があるBSONとしての `Document`。
`limit`	カウントするドキュメントの最大量
`completion`	フィルターに一致したドキュメントの数を返します。

Githubでの表示


                    
                    
                    deleteOneDocument(filter:_:)

コレクションから一致するドキュメントを 1 つ削除します。

宣言

Swift

@preconcurrency
public func deleteOneDocument(filter: Document, _ completion: @escaping MongoCountBlock)

パラメーター

`filter`	クエリに一致する必要があるBSONとしての `Document`。
`completion`	削除を実行した結果。削除されたオブジェクトの数を返します

Githubでの表示


                    
                    
                    deleteManyDocuments(filter:_:)

複数のドキュメントを削除します

宣言

Swift

@preconcurrency
public func deleteManyDocuments(filter: Document, _ completion: @escaping MongoCountBlock)

パラメーター

`filter`	一致条件を表すドキュメント
`completion`	削除を実行した結果。削除のカウントを返します

Githubでの表示


                    
                    
                    updateOneDocument(filter:update:upsert:_:)

このコレクション内の指定されたフィルターに一致する 1 つのドキュメントを更新します。

宣言

Swift

@preconcurrency
public func updateOneDocument(filter: Document, update: Document, upsert: Bool = false,
                              _ completion: @escaping MongoUpdateBlock)

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。
`upsert`	true の場合、クエリに一致するドキュメントがない場合には、は新しいドキュメントを作成します。
`completion`	ドキュメントを更新しようとした試行の結果。

Githubでの表示


                    
                    
                    updateManyDocuments(filter:update:upsert:_:)

このコレクション内の指定されたフィルターに一致する複数のドキュメントを更新します。

宣言

Swift

@preconcurrency
public func updateManyDocuments(filter: Document, update: Document, upsert: Bool = false,
                                _ completion: @escaping MongoUpdateBlock)

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。
`upsert`	true の場合、クエリに一致するドキュメントがない場合には、は新しいドキュメントを作成します。
`completion`	ドキュメントを更新しようとした試行の結果。

Githubでの表示


                    
                    
                    findOneAndUpdate(filter:update:options:_:)

クエリフィルターに基づいてコレクション内の 1 つのドキュメントを更新し、更新前または更新後の形式でドキュメントを返します。 updateOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索、更新、返すことができます。これにより、検索操作と更新操作の間にある他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

@preconcurrency
public func findOneAndUpdate(filter: Document, update: Document,
                             options: FindOneAndModifyOptions = .init(),
                             _ completion: @escaping MongoFindOneBlock)

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。
`options`	`RemoteFindOneAndModifyOptions` コマンドを実行するときに使用します。
`completion`	ドキュメントを更新しようとした試行の結果。

Githubでの表示


                    
                    
                    findOneAndReplace(filter:replacement:options:_:)

クエリフィルターに基づいてコレクション内の 1 つのドキュメントを上書きし、置換前または置換後の形式でドキュメントを返します。 updateOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索、置換、および返すことができます。これにより、検索操作と更新操作の間にある他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

@preconcurrency
public func findOneAndReplace(filter: Document, replacement: Document,
                              options: FindOneAndModifyOptions = .init(),
                              _ completion: @escaping MongoFindOneBlock)

パラメーター

`filter`	クエリに一致する必要がある`Document` 。
`replacement`	置換を説明する`Document` 。
`options`	`FindOneAndModifyOptions` コマンドを実行するときに使用します。
`completion`	ドキュメントを置き換えようとした試行の結果。

Githubでの表示


                    
                    
                    findOneAndDelete(filter:options:_:)

クエリフィルターに基づいてコレクションから 1 つのドキュメントを削除し、削除される直前のドキュメントと同じ形式のドキュメントを返します。 deleteOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索して削除できます。これにより、検索操作と削除操作が個別に行われる間に他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

@preconcurrency
public func findOneAndDelete(filter: Document, options: FindOneAndModifyOptions = .init(),
                             _ completion: @escaping MongoFindOneBlock)

パラメーター

`filter`	クエリに一致する必要がある`Document` 。
`options`	`FindOneAndModifyOptions` コマンドを実行するときに使用します。
`completion`	ドキュメントを削除しようとした試行の結果。

Githubでの表示


                    
                    
                    insertOne(_:)

非同期

指定された値を BSON にエンコードし、挿入します。値に識別子がない場合、その値に対して識別子が生成されます。

宣言

Swift

public func insertOne(_ document: Document) async throws -> AnyBSON

パラメーター


                                document

挿入するDocument値。

戻り値

挿入されたドキュメントのオブジェクトID。

Githubでの表示


                    
                    
                    insertMany(_:)

非同期

指定された値を BSON にエンコードし、挿入します。識別子が欠落している値は生成されます。

宣言

Swift

public func insertMany(_ documents: [Document]) async throws -> [AnyBSON]

パラメーター


                                documents

挿入するBSON配列内の Document 値。

戻り値

挿入されたドキュメントのオブジェクト ID。

Githubでの表示


                    
                    
                    find(filter:options:)

このコレクション内の指定されたフィルターに一致するドキュメントを検索します。


                    
                    
                    findOneDocument(filter:options:)

指定されたフィルターに一致するコレクションまたはビューから 1 つのドキュメントを返します。クエリを満たすドキュメントが複数ある場合、このメソッドではクエリのソート順または自然な順序に従って最初のドキュメントが返されます。


                    
                    
                    find(filter:options:_isolation:)

非同期

このコレクション内の指定されたフィルターに一致するドキュメントを検索します。

宣言

Swift

public func find(filter: Document, options: FindOptions = .init(),
                 _isolation: isolated (any Actor)? = #isolation) async throws -> [Document]

パラメーター

`filter`	クエリに一致する必要があるBSONとしての `Document`。
`options`	`FindOptions` コマンドを実行するときに使用します。

戻り値

フィルタリングされたDocumentの配列。

Githubでの表示


                    
                    
                    findOneDocument(filter:options:_isolation:)

非同期

指定されたフィルターに一致するコレクションまたはビューから 1 つのドキュメントを返します。クエリを満たすドキュメントが複数ある場合、このメソッドではクエリのソート順または自然な順序に従って最初のドキュメントが返されます。

宣言

Swift

public func findOneDocument(filter: Document, options: FindOptions = .init(),
                            _isolation: isolated (any Actor)? = #isolation) async throws -> Document?

パラメーター

`filter`	クエリに一致する必要があるBSONとしての `Document`。
`options`	`FindOptions` コマンドを実行するときに使用します。

戻り値

Document フィルタリングされました。

Githubでの表示


                    
                    
                    aggregate(pipeline:)

非同期

このコレクションに対して集計フレームワークパイプラインを実行します。

宣言

Swift

public func aggregate(pipeline: [Document]) async throws -> [Document]

パラメーター


                                pipeline

実行される集計操作のパイプラインを含む Documents で構成されるBSON配列。

戻り値

集計操作のDocumentの結果の配列。

Githubでの表示


                    
                    
                    count(filter:limit:)

非同期

指定されたフィルターに一致するこのコレクション内のドキュメントの数をカウントします。

宣言

Swift

public func count(filter: Document, limit: Int? = nil) async throws -> Int

パラメーター

`filter`	クエリに一致する必要があるBSONとしての `Document`。
`limit`	カウントするドキュメントの最大量

戻り値

フィルターに一致したドキュメントの数。

Githubでの表示


                    
                    
                    deleteOneDocument(filter:)

非同期

コレクションから一致するドキュメントを 1 つ削除します。

宣言

Swift

public func deleteOneDocument(filter: Document) async throws -> Int

パラメーター


                                filter

クエリに一致する必要があるBSONとしての Document。

戻り値

Int 削除されたドキュメントの数。

Githubでの表示


                    
                    
                    deleteManyDocuments(filter:)

非同期

複数のドキュメントを削除します

宣言

Swift

public func deleteManyDocuments(filter: Document) async throws -> Int

パラメーター


                                filter

一致条件を表すドキュメント

戻り値

Int 削除されたドキュメントの数。

Githubでの表示


                    
                    
                    updateOneDocument(filter:update:upsert:)

非同期

このコレクション内の指定されたフィルターに一致する 1 つのドキュメントを更新します。

宣言

Swift

public func updateOneDocument(filter: Document,
                              update: Document,
                              upsert: Bool? = nil) async throws -> UpdateResult

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。
`upsert`	true の場合、クエリに一致するドキュメントがない場合には、は新しいドキュメントを作成します。

戻り値

UpdateResultupdateOne操作の結果。

Githubでの表示


                    
                    
                    updateManyDocuments(filter:update:upsert:)

非同期

このコレクション内の指定されたフィルターに一致する複数のドキュメントを更新します。

宣言

Swift

public func updateManyDocuments(filter: Document,
                                update: Document,
                                upsert: Bool? = nil) async throws -> UpdateResult

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。
`upsert`	true の場合、クエリに一致するドキュメントがない場合には、は新しいドキュメントを作成します。

戻り値

UpdateResultupdateMany操作の結果。

Githubでの表示


                    
                    
                    findOneAndUpdate(filter:update:options:)

クエリフィルターに基づいてコレクション内の 1 つのドキュメントを更新し、更新前または更新後の形式でドキュメントを返します。 updateOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索、更新、返すことができます。これにより、検索操作と更新操作の間にある他の更新操作でドキュメントが変更されるリスクを回避できます。


                    
                    
                    findOneAndReplace(filter:replacement:options:)

クエリフィルターに基づいてコレクション内の 1 つのドキュメントを上書きし、置換前または置換後の形式でドキュメントを返します。 updateOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索、置換、および返すことができます。これにより、検索操作と更新操作の間にある他の更新操作でドキュメントが変更されるリスクを回避できます。


                    
                    
                    findOneAndDelete(filter:options:)

クエリフィルターに基づいてコレクションから 1 つのドキュメントを削除し、削除される直前のドキュメントと同じ形式のドキュメントを返します。 deleteOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索して削除できます。これにより、検索操作と削除操作が個別に行われる間に他の更新操作でドキュメントが変更されるリスクを回避できます。


                    
                    
                    findOneAndUpdate(filter:update:options:_isolation:)

非同期

クエリフィルターに基づいてコレクション内の 1 つのドキュメントを更新し、更新前または更新後の形式でドキュメントを返します。 updateOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索、更新、返すことができます。これにより、検索操作と更新操作の間にある他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

public func findOneAndUpdate(filter: Document, update: Document,
                             options: FindOneAndModifyOptions = .init(),
                             _isolation: isolated (any Actor)? = #isolation) async throws -> Document?

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。
`options`	`RemoteFindOneAndModifyOptions` コマンドを実行するときに使用します。

戻り値

Document ドキュメントを更新しようとした試行の結果をコピーするか、ドキュメントが見つからない場合はnil 。

Githubでの表示


                    
                    
                    findOneAndReplace(filter:replacement:options:_isolation:)

非同期

クエリフィルターに基づいてコレクション内の 1 つのドキュメントを上書きし、置換前または置換後の形式でドキュメントを返します。 updateOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索、置換、および返すことができます。これにより、検索操作と更新操作の間にある他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

public func findOneAndReplace(filter: Document, replacement: Document,
                              options: FindOneAndModifyOptions = .init(),
                              _isolation: isolated (any Actor)? = #isolation) async throws -> Document?

パラメーター

`filter`	クエリに一致する必要がある`Document` 。
`replacement`	置換を説明する`Document` 。
`options`	`FindOneAndModifyOptions` コマンドを実行するときに使用します。

戻り値

Documentドキュメントを置き換える試行の結果を表示するか、ドキュメントが見つからない場合はnil 。

Githubでの表示


                    
                    
                    findOneAndDelete(filter:options:_isolation:)

非同期

クエリフィルターに基づいてコレクションから 1 つのドキュメントを削除し、削除される直前のドキュメントと同じ形式のドキュメントを返します。 deleteOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索して削除できます。これにより、検索操作と削除操作が個別に行われる間に他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

public func findOneAndDelete(filter: Document,
                             options: FindOneAndModifyOptions = .init(),
                             _isolation: isolated (any Actor)? = #isolation) async throws -> Document?

パラメーター

`filter`	クエリに一致する必要がある`Document` 。
`options`	`FindOneAndModifyOptions` コマンドを実行するときに使用します。

戻り値

Document ドキュメントを削除しようとした結果を表示するか、ドキュメントが見つからない場合はnil 。

Githubでの表示


                    
                    
                    watch()

MongoDB コレクションが変更されるたびに任意の BSON 変更イベントを発行する発行者を作成します。

宣言

Swift

public func watch() -> Publishers.WatchPublisher

戻り値

コレクションが変更されるたびに任意の BSON 変更イベントを発行する発行者。

Githubでの表示


                    
                    
                    watch(filterIds:)

MongoDB コレクションが変更されるたびに任意の BSON 変更イベントを発行する発行者を作成します。

宣言

Swift

public func watch(filterIds: [ObjectId]) -> Publishers.WatchPublisher

パラメーター


                                filterIds

監視するコレクション内の _ids のリスト。

戻り値

コレクションが変更されるたびに任意の BSON 変更イベントを発行する発行者。

Githubでの表示


                    
                    
                    watch(matchFilter:)

MongoDB コレクションが変更されるたびに任意の BSON 変更イベントを発行する発行者を作成します。

宣言

Swift

public func watch(matchFilter: Document) -> Publishers.WatchPublisher

パラメーター


                                matchFilter

受信変更イベントに適用する $match フィルター。

戻り値

コレクションが変更されるたびに任意の BSON 変更イベントを発行する発行者。

Githubでの表示


                    
                    
                    changeEvents

MongoDB コレクションの各変更に関する情報を含む任意の BSON 値の非同期シーケンス

宣言

Swift

public var changeEvents: AsyncThrowingPublisher<Publishers.WatchPublisher> { get }

Githubでの表示


                    
                    
                    changeEvents(onOpen:)

MongoDB コレクションの各変更に関する情報を含む任意の BSON 値の非同期シーケンス

宣言

Swift

public func changeEvents(onOpen: @Sendable @escaping () -> Void)
        -> AsyncThrowingPublisher<Publishers.WatchPublisher>

パラメーター


                                onOpen

監視ストリームがサーバー上で初期化されたときに呼び出されるコールバック。このコールバックが呼び出される前にトリガーされるサーバー側の変更では、変更イベントが生成されない可能性があります。

Githubでの表示


                    
                    
                    changeEvents(filterIds:onOpen:)

MongoDB コレクション内のfilterIdsに含まれる ID を持つオブジェクトに対する各変更に関する情報を含む任意の BSON 値の非同期シーケンス。

宣言

Swift

public func changeEvents(filterIds: [ObjectId], onOpen: (@Sendable () -> Void)? = nil)
        -> AsyncThrowingPublisher<Publishers.WatchPublisher>

パラメーター

`filterIds`	変更イベントを生成するドキュメント ID
`onOpen`	監視ストリームがサーバー上で初期化されたときに呼び出される任意のコールバック。このコールバックが呼び出される前にトリガーされるサーバー側の変更では、変更イベントが生成されない可能性があります。

Githubでの表示


                    
                    
                    changeEvents(matchFilter:onOpen:)

指定された $match フィルターに一致する MongoDB コレクション内のオブジェクトに対する各変更に関する情報を含む任意の BSON 値の非同期シーケンス。

宣言

Swift

public func changeEvents(matchFilter: Document, onOpen: (@Sendable () -> Void)? = nil)
        -> AsyncThrowingPublisher<Publishers.WatchPublisher>

パラメーター

`matchFilter`	変更イベントを生成するドキュメントをフィルタリングする $match フィルター。
`onOpen`	監視ストリームがサーバー上で初期化されたときに呼び出される任意のコールバック。このコールバックが呼び出される前にトリガーされるサーバー側の変更では、変更イベントが生成されない可能性があります。

Githubでの表示


                    
                    
                    insertOne(_:)

指定された値を BSON にエンコードし、挿入します。値に識別子がない場合、その値に対して識別子が生成されます。

宣言

Swift

func insertOne(_ document: Document) -> Future<AnyBSON, Error>

パラメーター


                                document

挿入するDocument値。

戻り値

挿入されたドキュメントのオブジェクト ID またはErrorを最終的に返す出版社。

Githubでの表示


                    
                    
                    insertMany(_:)

指定された値を BSON にエンコードし、挿入します。識別子が欠落している値は生成されます。

宣言

Swift

func insertMany(_ documents: [Document]) -> Future<[AnyBSON], Error>

パラメーター


                                documents

挿入するBSON配列内の Document 値。

戻り値

挿入されたドキュメントのオブジェクト ID またはErrorを最終的に返す出版社。

Githubでの表示


                    
                    
                    find(filter:options:)

このコレクション内の指定されたフィルターに一致するドキュメントを検索します。

宣言

Swift

func find(filter: Document, options: FindOptions) -> Future<[Document], Error>

パラメーター

`filter`	クエリに一致する必要があるBSONとしての `Document`。
`options`	`FindOptions` コマンドを実行するときに使用します。

戻り値

最終的に[ObjectId]のドキュメントまたはErrorを返す出版社。

Githubでの表示


                    
                    
                    find(filter:)

このコレクション内の指定されたフィルターに一致するドキュメントを検索します。

宣言

Swift

func find(filter: Document) -> Future<[Document], Error>

パラメーター


                                filter

クエリに一致する必要があるBSONとしての Document。

戻り値

最終的に[ObjectId]のドキュメントまたはErrorを返す出版社。

Githubでの表示


                    
                    
                    findOneDocument(filter:options:)

指定されたフィルターに一致するコレクションまたはビューから 1 つのドキュメントを返します。クエリを満たすドキュメントが複数ある場合、このメソッドではクエリのソート順または自然な順序に従って最初のドキュメントが返されます。

宣言

Swift

func findOneDocument(filter: Document, options: FindOptions) -> Future<Document?, Error>

パラメーター

`filter`	クエリに一致する必要があるBSONとしての `Document`。
`options`	`FindOptions` コマンドを実行するときに使用します。

戻り値

最終的にDocumentまたはErrorを返す出版社。

Githubでの表示


                    
                    
                    findOneDocument(filter:)

指定されたフィルターに一致するコレクションまたはビューから 1 つのドキュメントを返します。クエリを満たすドキュメントが複数ある場合、このメソッドではクエリのソート順または自然な順序に従って最初のドキュメントが返されます。

宣言

Swift

func findOneDocument(filter: Document) -> Future<Document?, Error>

パラメーター


                                filter

クエリに一致する必要があるBSONとしての Document。

戻り値

ドキュメントが見つからなかった場合、またはErrorの場合は、最終的にDocumentまたはnilを返す出版社。

Githubでの表示


                    
                    
                    aggregate(pipeline:)

このコレクションに対して集計フレームワークパイプラインを実行します。

宣言

Swift

func aggregate(pipeline: [Document]) -> Future<[Document], Error>

パラメーター


                                pipeline

実行される集計操作のパイプラインを含む Documents で構成されるBSON配列。

戻り値

最終的にDocumentまたはErrorを返す出版社。

Githubでの表示


                    
                    
                    count(filter:limit:)

指定されたフィルターに一致するこのコレクション内のドキュメントの数をカウントします。

宣言

Swift

func count(filter: Document, limit: Int) -> Future<Int, Error>

パラメーター

`filter`	クエリに一致する必要があるBSONとしての `Document`。
`limit`	カウントするドキュメントの最大量

戻り値

最終的にInt個のドキュメントまたはErrorを返す出版社。

Githubでの表示


                    
                    
                    count(filter:)

指定されたフィルターに一致するこのコレクション内のドキュメントの数をカウントします。

宣言

Swift

func count(filter: Document) -> Future<Int, Error>

パラメーター


                                filter

クエリに一致する必要があるBSONとしての Document。

戻り値

最終的にInt個のドキュメントまたはErrorを返す出版社。

Githubでの表示


                    
                    
                    deleteOneDocument(filter:)

コレクションから一致するドキュメントを 1 つ削除します。

宣言

Swift

func deleteOneDocument(filter: Document) -> Future<Int, Error>

パラメーター


                                filter

クエリに一致する必要があるBSONとしての Document。

戻り値

最終的に削除されたドキュメントのInt数、またはErrorを返す出版社。

Githubでの表示


                    
                    
                    deleteManyDocuments(filter:)

複数のドキュメントを削除します

宣言

Swift

func deleteManyDocuments(filter: Document) -> Future<Int, Error>

パラメーター


                                filter

一致条件を表すドキュメント

戻り値

最終的に削除されたドキュメントのInt数、またはErrorを返す出版社。

Githubでの表示


                    
                    
                    updateOneDocument(filter:update:upsert:)

このコレクション内の指定されたフィルターに一致する 1 つのドキュメントを更新します。

宣言

Swift

func updateOneDocument(filter: Document, update: Document, upsert: Bool) -> Future<UpdateResult, Error>

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。
`upsert`	true の場合、クエリに一致するドキュメントがない場合には、は新しいドキュメントを作成します。

戻り値

最終的にUpdateResultまたはErrorを返す出版社。

Githubでの表示


                    
                    
                    updateOneDocument(filter:update:)

このコレクション内の指定されたフィルターに一致する 1 つのドキュメントを更新します。

宣言

Swift

func updateOneDocument(filter: Document, update: Document) -> Future<UpdateResult, Error>

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。

戻り値

最終的にUpdateResultまたはErrorを返す出版社。

Githubでの表示


                    
                    
                    updateManyDocuments(filter:update:upsert:)

このコレクション内の指定されたフィルターに一致する複数のドキュメントを更新します。

宣言

Swift

func updateManyDocuments(filter: Document, update: Document, upsert: Bool) -> Future<UpdateResult, Error>

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。
`upsert`	true の場合、クエリに一致するドキュメントがない場合には、は新しいドキュメントを作成します。

戻り値

最終的にUpdateResultまたはErrorを返す出版社。

Githubでの表示


                    
                    
                    updateManyDocuments(filter:update:)

このコレクション内の指定されたフィルターに一致する複数のドキュメントを更新します。

宣言

Swift

func updateManyDocuments(filter: Document, update: Document) -> Future<UpdateResult, Error>

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。

戻り値

最終的にUpdateResultまたはErrorを返す出版社。

Githubでの表示


                    
                    
                    findOneAndUpdate(filter:update:options:)

クエリフィルターに基づいてコレクション内の 1 つのドキュメントを更新し、更新前または更新後の形式でドキュメントを返します。 updateOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索、更新、返すことができます。これにより、検索操作と更新操作の間にある他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

func findOneAndUpdate(filter: Document, update: Document, options: FindOneAndModifyOptions) -> Future<Document?, Error>

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。
`options`	`RemoteFindOneAndModifyOptions` コマンドを実行するときに使用します。

戻り値

ドキュメントが見つからなかった場合、またはErrorの場合は、最終的にDocumentまたはnilを返す出版社。

Githubでの表示


                    
                    
                    findOneAndUpdate(filter:update:)

クエリフィルターに基づいてコレクション内の 1 つのドキュメントを更新し、更新前または更新後の形式でドキュメントを返します。 updateOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索、更新、返すことができます。これにより、検索操作と更新操作の間にある他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

func findOneAndUpdate(filter: Document, update: Document) -> Future<Document?, Error>

パラメーター

`filter`	一致条件を表すBSON `Document` 。
`update`	一致するドキュメントに適用するアップデートを表すBSON `Document`。

戻り値

ドキュメントが見つからなかった場合、またはErrorの場合は、最終的にDocumentまたはnilを返す出版社。

Githubでの表示


                    
                    
                    findOneAndReplace(filter:replacement:options:)

クエリフィルターに基づいてコレクション内の 1 つのドキュメントを上書きし、置換前または置換後の形式でドキュメントを返します。 updateOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索、置換、および返すことができます。これにより、検索操作と更新操作の間にある他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

func findOneAndReplace(filter: Document, replacement: Document, options: FindOneAndModifyOptions) -> Future<Document?, Error>

パラメーター

`filter`	クエリに一致する必要がある`Document` 。
`replacement`	置換を説明する`Document` 。
`options`	`FindOneAndModifyOptions` コマンドを実行するときに使用します。

戻り値

ドキュメントが見つからなかった場合、またはErrorの場合は、最終的にDocumentまたはnilを返す出版社。

Githubでの表示


                    
                    
                    findOneAndReplace(filter:replacement:)

クエリフィルターに基づいてコレクション内の 1 つのドキュメントを上書きし、置換前または置換後の形式でドキュメントを返します。 updateOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索、置換、および返すことができます。これにより、検索操作と更新操作の間にある他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

func findOneAndReplace(filter: Document, replacement: Document) -> Future<Document?, Error>

パラメーター

`filter`	クエリに一致する必要がある`Document` 。
`replacement`	置換を説明する`Document` 。

戻り値

ドキュメントが見つからなかった場合、またはErrorの場合は、最終的にDocumentまたはnilを返す出版社。

Githubでの表示


                    
                    
                    findOneAndDelete(filter:options:)

クエリフィルターに基づいてコレクションから 1 つのドキュメントを削除し、削除される直前のドキュメントと同じ形式のドキュメントを返します。 deleteOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索して削除できます。これにより、検索操作と削除操作が個別に行われる間に他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

func findOneAndDelete(filter: Document, options: FindOneAndModifyOptions) -> Future<Document?, Error>

パラメーター

`filter`	クエリに一致する必要がある`Document` 。
`options`	`FindOneAndModifyOptions` コマンドを実行するときに使用します。

戻り値

ドキュメントが見つからなかった場合、またはErrorの場合は、最終的にDocumentまたはnilを返す出版社。

Githubでの表示


                    
                    
                    findOneAndDelete(filter:)

クエリフィルターに基づいてコレクションから 1 つのドキュメントを削除し、削除される直前のドキュメントと同じ形式のドキュメントを返します。 deleteOneDocumentとは異なり、このアクションでは同じコマンドでドキュメントをアトミックに検索して削除できます。これにより、検索操作と削除操作が個別に行われる間に他の更新操作でドキュメントが変更されるリスクを回避できます。

宣言

Swift

func findOneAndDelete(filter: Document) -> Future<Document?, Error>

パラメーター


                                filter

クエリに一致する必要があるDocument 。

戻り値

ドキュメントが見つからなかった場合、またはErrorの場合は、最終的にDocumentまたはnilを返す出版社。

Githubでの表示