FetchOptions(Google App Engine API for Java)

com.google.appengine.api.datastore

クラス FetchOptions

  • java.lang.Object
    • com.google.appengine.api.datastore.FetchOptions


  • public final class FetchOptions
    extends java.lang.Object
    PreparedQuery の実行時に適用される制限、オフセット、およびチャンクサイズを記述します。

    limit は、クエリが返す結果の最大数です。

    offset は、結果を返すまでにスキップする結果の数です。オフセットによってスキップされた結果は、limit に対してカウントされません。
    注: offset を使用しても、スキップされたエンティティは内部で取得されます。これはクエリのレイテンシに影響し、そのようなエンティティの取得に必要なオペレーションに対してアプリケーションに課金されます。このようなコストは、カーソルを使用することで回避できます。

    startCursorendCursor は、結果セット内の位置を指す以前に生成されたカーソルです。指定された場合、クエリはこれらの位置で開始し、終了します。

    prefetchSize は、データストアへの最初の呼び出しで取得された結果の数です。

    chunkSize は、PreparedQuery.asIterator(FetchOptions) によって返された Iterator および PreparedQuery.asIterable(FetchOptions) によって返された Iterable の内部チャンク ストラテジーを決定します。

    limitoffsetcursor と異なり、prefetchSizechunkSizePreparedQuery の結果には影響しませんが、PreparedQuery のパフォーマンスにのみ影響します。

    使用上の注意:
    FetchOptions オブジェクトをインスタンス化するには、FetchOptions をインポートし、静的作成メソッドの後にインスタンス ミューテーター(必要な場合)を呼び出す方法を推奨します。

     import com.google.appengine.api.datastore.FetchOptions;
    
     Cursor cursor = ...
    
     ...
    
     // limit 10
     datastoreService.prepare(query).asList(FetchOptions.Builder.withLimit(10));
    
     // limit 10, start cursor
     datastoreService.prepare(query).asList(FetchOptions.Builder.withLimit(10).startCursor(cursor));
     
    • フィールドの詳細

      • DEFAULT_CHUNK_SIZE

        @Deprecated
        public static final int DEFAULT_CHUNK_SIZE
        サポート終了。 DEFAULT_CHUNK_SIZE を使用する代わりに、チャンクサイズを指定しません。
        関連情報:
        定数フィールド値
    • メソッドの詳細

      • 上限

        public FetchOptions limit(int limit)
        制限を設定します。limit の使用方法については、クラス javadoc をお読みください。
        パラメータ:
        limit - 設定する制限。非負でなければなりません。
        戻り値:
        this(チェーン用)
      • offset

        public FetchOptions offset(int offset)
        オフセットを設定します。オフセットの使用方法については、クラス javadoc をお読みください。
        パラメータ:
        offset - 設定するオフセット。0 以上でなければなりません。
        戻り値:
        this(チェーン用)
      • chunkSize

        public FetchOptions chunkSize(int chunkSize)
        チャンクサイズを設定します。チャンクサイズの使用方法については、クラス javadoc をお読みください。
        パラメータ:
        chunkSize - 設定するチャンクサイズ。0 より大きくなければなりません。
        戻り値:
        this(チェーン用)
      • prefetchSize

        public FetchOptions prefetchSize(int prefetchSize)
        プリフェッチするエンティティの数を設定します。
        パラメータ:
        prefetchSize - 設定するプリフェッチ サイズ。0 以上である必要があります。
        戻り値:
        this(チェーン用)
      • cursor

        @Deprecated
        public FetchOptions cursor(Cursor cursor)
        サポート終了。代わりに startCursor を使用します。
        クエリを開始するカーソルを設定します。
        パラメータ:
        cursor - 設定するカーソル
        戻り値:
        this(チェーン用)
      • startCursor

        public FetchOptions startCursor(Cursor startCursor)
        クエリを開始する位置にカーソルを設定します。
        パラメータ:
        startCursor - 設定するカーソル
        戻り値:
        this(チェーン用)
      • endCursor

        public FetchOptions endCursor(Cursor endCursor)
        クエリを終了する位置にカーソルを設定します。
        パラメータ:
        endCursor - 設定するカーソル
        戻り値:
        this(チェーン用)
      • getLimit

        public java.lang.Integer getLimit()
        戻り値:
        制限。制限が指定されていない場合は null
      • getOffset

        public java.lang.Integer getOffset()
        戻り値:
        オフセット。オフセットが指定されていない場合は null
      • getChunkSize

        public java.lang.Integer getChunkSize()
        戻り値:
        チャンクサイズ。チャンクサイズが指定されていない場合は null
      • getPrefetchSize

        public java.lang.Integer getPrefetchSize()
        戻り値:
        プリフェッチ サイズ。プリフェッチ サイズが指定されていない場合は null
      • getCursor

        @Deprecated
        public Cursor getCursor()
        サポート終了。代わりに getStartCursor() を使用します。
        戻り値:
        開始カーソル。カーソルが指定されていない場合は null
      • getStartCursor

        public Cursor getStartCursor()
        戻り値:
        開始カーソル。カーソルが指定されていない場合は null
      • getEndCursor

        public Cursor getEndCursor()
        戻り値:
        終了カーソル。終了カーソルが指定されていない場合は null
      • hashCode

        public int hashCode()
        オーバーライド:
        hashCode - クラス java.lang.Object
      • equals

        public boolean equals(java.lang.Object obj)
        オーバーライド:
        equals - クラス java.lang.Object
      • toString

        public java.lang.String toString()
        オーバーライド:
        toString - クラス java.lang.Object
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Java の App Engine スタンダード環境