クラス Query

メソッドの詳細

• query

  public static Query query(CriteriaDefinition criteriaDefinition)

  提供された CriteriaDefinition を使用して Query を作成する静的ファクトリメソッド。

  パラメーター:

  criteriaDefinition - null であってはなりません。

  戻り値:

  Query の新しいインスタンス。

  導入:

  1.6

• addCriteria

  public Query addCriteria(CriteriaDefinition criteriaDefinition)

  指定された CriteriaDefinition を現在の Query に追加します。

  パラメーター:

  criteriaDefinition - null であってはなりません。

  戻り値:

  this。

  導入:

  1.6

• fields

  public Field fields()

• skip

  public Query skip(long skip)

  結果を返す前にスキップするドキュメントの数を設定します。スキップを回避するには、ゼロまたは負の値を使用します。

  パラメーター:

  skip - スキップするドキュメントの数。スキップを回避するには、ゼロまたは負の値を使用します。

  戻り値:

  this。

• limit

  public Query limit(int limit)

  返されるドキュメントの数を limit に制限します。ゼロまたは負の値は無制限とみなされます。

  パラメーター:

  limit - 返されるドキュメントの数。無制限にする場合は 0 または負の数を使用します。

  戻り値:

  this。

• limit

  public Query limit(Limit limit)

  返されるドキュメントの数を Limit に制限します。

  パラメーター:

  limit - 返されるドキュメントの数。

  戻り値:

  this。

  導入:

  4.2

• withHint

  public Query withHint(StringSE hint)

  実行時に指定されたヒントを使用するようにクエリを構成します。hint は、インデックス名または json Document 表現のいずれかになります。

  パラメーター:

  hint - null または空であってはなりません。

  戻り値:

  this。

  関連事項:

  • Document.parse(String)

• withReadConcern

  public Query withReadConcern(com.mongodb.ReadConcern readConcern)

  実行時に指定された ReadConcern を使用するようにクエリを構成します。

  パラメーター:

  readConcern - null であってはなりません。

  戻り値:

  this。

  導入:

  3.1

• withReadPreference

  public Query withReadPreference(com.mongodb.ReadPreference readPreference)

  実行時に指定された ReadPreference を使用するようにクエリを構成します。

  パラメーター:

  readPreference - null であってはなりません。

  戻り値:

  this。

  導入:

  4.1

• hasReadConcern

  public boolean hasReadConcern()

  次で指定:

  インターフェース ReadConcernAware の hasReadConcern 

  戻り値:

  ReadConcern が設定されている場合は true。

• getReadConcern

  public com.mongodb.ReadConcern getReadConcern()

  次で指定:

  インターフェース ReadConcernAware の getReadConcern 

  戻り値:

  適用する ReadConcern、または何も設定されていない場合は null。

• hasReadPreference

  public boolean hasReadPreference()

  次で指定:

  インターフェース ReadPreferenceAware の hasReadPreference 

  戻り値:

  ReadPreference が設定されている場合は true。

• getReadPreference

  public com.mongodb.ReadPreference getReadPreference()

  次で指定:

  インターフェース ReadPreferenceAware の getReadPreference 

  戻り値:

  適用する ReadPreference、または何も設定されていない場合は null。

• withHint

  public Query withHint(org.bson.Document hint)

  実行時に指定された hint を使用するようにクエリを構成します。

  パラメーター:

  hint - null であってはなりません。

  戻り値:

  this。

  導入:

  2.2

• with

  public Query with(Pageable pageable)

  Query インスタンスに指定されたページ区切り情報を設定します。Pageable で定義された Sort インスタンスを適用するだけでなく、skip と limit を透過的に設定します。

  パラメーター:

  pageable - null であってはなりません。

  戻り値:

  this。

• with

  public Query with(ScrollPosition position)

  Query インスタンス上の指定されたカーソル位置を設定します。skip は透過的に設定されます。

  パラメーター:

  position - null であってはなりません。

  戻り値:

  this。

• with

  public Query with(OffsetScrollPosition position)

  Query インスタンス上の指定されたカーソル位置を設定します。skip は透過的に設定されます。

  パラメーター:

  position - null であってはなりません。

  戻り値:

  this。

• with

  public Query with(KeysetScrollPosition position)

  Query インスタンス上の指定されたカーソル位置を設定します。skip を透過的にリセットします。

  パラメーター:

  position - null であってはなりません。

  戻り値:

  this。

• hasKeyset

  public boolean hasKeyset()

• getKeyset

  @Nullable public KeysetScrollPosition getKeyset()

• with

  public Query with(Sort sort)

  Query インスタンスに Sort を追加します。

  パラメーター:

  sort - null であってはなりません。

  戻り値:

  this。

• getRestrictedTypes

  public SetSE<ClassSE<?>> getRestrictedTypes()

  戻り値:

  restrictedTypes

• restrict

  public Query restrict(ClassSE<?> type, ClassSE<?>... additionalTypes)

  指定された型とまったく同じドキュメントインスタンスのみを返すようにクエリを制限します。

  パラメーター:

  type - NULL ではない可能性があります

  additionalTypes - NULL ではない可能性があります

  戻り値:

  this。

• getQueryObject

  public org.bson.Document getQueryObject()

  戻り値:

  クエリ Document。

• getFieldsObject

  public org.bson.Document getFieldsObject()

  戻り値:

  フィールド Document。

• getSortObject

  public org.bson.Document getSortObject()

  戻り値:

  ソート Document。

• isSorted

  public boolean isSorted()

  Query にソートパラメーターがある場合は true を返します。

  戻り値:

  ソートされている場合は true。

  導入:

  2.2

  関連事項:

  • Sort.isSorted()

• getSkip

  public long getSkip()

  スキップするドキュメントの数を取得します。ゼロまたは負の値はスキップしないことを示します。

  戻り値:

  スキップするドキュメントの数

• isLimited

  public boolean isLimited()

  クエリが limited であるかどうかを返します。

  戻り値:

  クエリが制限されている場合は true、それ以外の場合は false です。

  導入:

  4.1

• getLimit

  public int getLimit()

  返されるドキュメントの最大数を取得します。ゼロまたは負の値は制限がないことを示します。

  戻り値:

  返されるドキュメントの数。

  関連事項:

  • isLimited()

• getHint

  @Nullable public StringSE getHint()

  戻り値:

  null でもかまいません。

• maxTimeMsec

  public Query maxTimeMsec(long maxTimeMsec)

  パラメーター:

  maxTimeMsec -

  戻り値:

  this。

  導入:

  1.6

  関連事項:

  • Meta.setMaxTimeMsec(long)

• maxTime

  public Query maxTime(DurationSE timeout)

  パラメーター:

  timeout - null であってはなりません。

  戻り値:

  this。

  導入:

  2.1

  関連事項:

  • Meta.setMaxTime(Duration)

• comment

  public Query comment(StringSE comment)

  プロファイルログに伝達されるクエリにコメントを追加します。

  パラメーター:

  comment - null であってはなりません。

  戻り値:

  this。

  導入:

  1.6

  関連事項:

  • Meta.setComment(String)

• allowDiskUse

  public Query allowDiskUse(boolean allowDiskUse)

  集計ステージとクエリの一時ファイルへの書き込みを有効にします。true に設定すると、集計ステージは dbPath ディレクトリの _tmp サブディレクトリにデータを書き込むことができます。

  MongoDB 4.2 以降では、メモリ制限により集計ステージで一時ファイルにデータが書き込まれた場合、プロファイラーログメッセージと診断ログメッセージに usedDisk インジケーターが含まれるようになりました。

  パラメーター:

  allowDiskUse -

  戻り値:

  this。

  導入:

  3.2

  関連事項:

  • Meta.setAllowDiskUse(Boolean)

• cursorBatchSize

  public Query cursorBatchSize(int batchSize)

  各レスポンスバッチで返されるドキュメントの数を設定します。
  制限なしの場合は 0 (ゼロ) を使用します。負の制限は、単一のバッチを返した後にカーソルを閉じ、クライアントが後続のバッチを要求しないことをサーバーに示します。

  パラメーター:

  batchSize - バッチごとに返されるドキュメントの数。

  戻り値:

  this。

  導入:

  2.1

  関連事項:

  • Meta.setCursorBatchSize(int)

• noCursorTimeout

  public Query noCursorTimeout()

  戻り値:

  this。

  導入:

  1.10

  関連事項:

  • Meta.CursorOption.NO_TIMEOUT

• exhaust

  public Query exhaust()

  戻り値:

  this。

  導入:

  1.10

  関連事項:

  • Meta.CursorOption.EXHAUST

• allowSecondaryReads

  public Query allowSecondaryReads()

  レプリカのクエリを許可します。

  戻り値:

  this。

  導入:

  3.0.2

  関連事項:

  • Meta.CursorOption.SECONDARY_READS

• partialResults

  public Query partialResults()

  戻り値:

  this。

  導入:

  1.10

  関連事項:

  • Meta.CursorOption.PARTIAL

• getMeta

  public Meta getMeta()

  戻り値:

  決して null にはなりません。

  導入:

  1.6

• setMeta

  public void setMeta(Meta meta)

  パラメーター:

  meta - null であってはなりません。

  導入:

  1.6

• collation

  public Query collation(@Nullable Collation collation)

  文字列比較に言語固有のルールを適用して Collation を設定します。

  パラメーター:

  collation - null でもかまいません。

  戻り値:

  this。

  導入:

  2.0

• getCollation

  public OptionalSE<Collation> getCollation()

  文字列比較の言語固有のルールを定義する Collation を取得します。

  戻り値:

  決して null にはなりません。

  導入:

  2.0

• getCriteria

  protected ListSE<CriteriaDefinition> getCriteria()

• of

  public static Query of(Query source)

  指定された Query の独立したコピーを作成します。
  結果の Query は、指定されたソースの binary equalSE にはなりませんが、実行時に同じ結果が作成されるという点では意味的に同等です。

  パラメーター:

  source - 参照に使用するソース Query。null にすることはできません。

  戻り値:

  新しい Query。

  導入:

  2.2

• toString

  public StringSE toString()

  オーバーライド:

  クラス ObjectSE の toString 

• equals

  public boolean equals(@Nullable ObjectSE obj)

  オーバーライド:

  クラス ObjectSE の equalsSE 

• querySettingsEquals

  protected boolean querySettingsEquals(Query that)

  指定された Query の設定がこのクエリと等しいかどうかをテストします。

  パラメーター:

  that -

  戻り値:

• hashCode

  public int hashCode()

  オーバーライド:

  クラス ObjectSE の hashCode 

• isRestrictedTypeKey

  @DeprecatedSE public static boolean isRestrictedTypeKey(StringSE key)

  使用すべきではありません。

  制限された型の処理は今後大幅に変更されるため、このメソッドを呼び出さないでください。

  指定されたキーが型制限情報を保持するために使用されるキーであるかどうかを返します。

  パラメーター:

  key -

  戻り値: