SODA for In-Database JavaScriptの読取りおよび書込み操作

読取りおよび書込み操作(挿入および保存以外)を指定する主な方法は、SodaOperationクラスが提供するメソッドを使用することです。SodaOperationメソッドをつなげて、コレクションに対する読取りおよび書込み操作を指定できます。

非ターミナルのSodaOperationメソッドは、呼び出された同じオブジェクトを戻し、メソッドをつなげることができるようにします。

ターミナルのSodaOperationメソッドは常に、操作を実行するメソッド・チェーンの最後に出現します。

ノート:

SodaOperationオブジェクトは内部オブジェクトです。そのプロパティは直接変更しないでください。

メソッドのSODAドキュメントに異なる記述がなければ、すべての非ターミナル・メソッドをつなぎ、ターミナル・メソッドでチェーンを終了できます。ただし、すべての組合せに意味があるわけではありません。たとえば、keys()などのドキュメントを一意に識別しないメソッドとversion()メソッドをつなげても意味はありません。

表8-1 読取り操作用の非ターミナル・メソッドの概要

メソッド	説明
`key()`	指定したドキュメント・キーを持つドキュメントを検索します。
`keys()`	指定した複数のドキュメント・キーを持つ複数のドキュメントを検索します。
`filter()`	フィルタ仕様(JSONで表される例による問合せ)と一致するドキュメントを検索します。
`version()`	指定したバージョンのドキュメントを検索します。通常、これは`key()`とともに使用されます。
`headerOnly()`	結果からドキュメント・コンテンツを除外します。
`skip()`	結果内で指定した数のドキュメントをスキップします。
`limit()`	結果ドキュメントの数を指定した数に制限します。

表8-2 読取り操作用のターミナル・メソッドの概要

メソッド	説明
`getOne()`	最大1つのドキュメントを戻す操作を作成して実行します。たとえば、非ターミナル・メソッド`key()`の呼出しを含む操作などです。
`getCursor()`	読取り操作の結果によってカーソルを取得します。
`count()`	操作で見つかったドキュメントの数をカウントします。
`getDocuments()`	問合せ基準に一致するドキュメントの配列を取得します。

表8-3 書込み操作用のターミナル・メソッドの概要

メソッド	説明
`replaceOne()`	1つのドキュメントを置き換えます。
`replaceOneAndGet()`	1つのドキュメントを置き換えて、結果ドキュメントを返します。
`remove()`	ドキュメントをコレクションから削除します。