次の方法で共有

FetchXml を使用したページ結果

  • [アーティクル]

ページ サイズを設定することで、リクエストごとに取得される行数の制限を指定できます。 ページングを使用すると、クエリの基準に一致するすべてのレコードを表すデータの連続ページを効率的な方法で取得できます。

既定の最大ページサイズは 5,000 行です。 ページサイズを設定しない場合、Dataverse は一度に 5,000 行までのデータを返します。 さらに多くの行を取得するには、追加のリクエストを送信する必要があります。

注意

  • ページングでは 要素の取り込み top 属性を使用しないでください。 クエリの結果を制限するこれらのさまざまな方法には互換性がありません。
  • 順序付けは、一貫したページング結果を得る上で重要な役割を果たします。 ご注文とページングについて

ページング モデル

Dataverse にが 2 つのページング モデルがあります: 単純 と ページング Cookie:

シンプル

  • 取り込み要素 count と page 属性のみを使用します
  • 小規模なデータセットのみに適しています
  • 50,000 レコードを超えるデータ セットを返すことはできません
  • 行数が増えるとパフォーマンスが低下する

ページング Cookie

シンプルなページング

リクエストを送信する前に、取り込み要素 page 属性を 1 に、count 属性をページ サイズに設定することで、最初のページにリクエストすることができます：

<fetch count='3' page='1'>
  <entity name='account'>
    <attribute name='name' />
    <order attribute='name' />
    <order attribute='accountid' />
  </entity>
</fetch>

次の 3 つのレコードを取得するには、page 値を指定して別のリクエストを送信します。

<fetch count='3' page='2'>
  <entity name='account'>
    <attribute name='name' />
    <order attribute='name' />
    <order attribute='accountid' />    
  </entity>
</fetch>

レガシー ページング と呼ばれることもある単純なページングでは、Dataverse は現在のページまでのクエリの結果をすべて取得し、そのページに必要な数のレコードを選択し、残りは無視します。 これにより、データを素早く前後にページ移動したり、特定のページにスキップしたりすることができます。 ただし、レコードの合計数は 50,000 に制限されており、複雑なクエリや任意に並べ替えられた個別のクエリ結果に対してパフォーマンスの問題が発生する可能性があります。

単純なページングは​​小さいデータ セットにはうまく機能しますが、データ セット内の行数が増加すると、パフォーマンスが低下します。 単純なページングを使用して取得できる行の合計数は 50,000 です。 あらゆるケースで最高のパフォーマンスを得るには、ページング Cookie を一貫して使用することをお勧めします。

ページング Cookie

最初のページをリクエストした後に、さらに取得すべき行がある場合、Dataverse通常 は、次のページのリクエストで使われるページング Cookie を返します。

ページング Cookie には、結果の最初と最後のレコードに関するデータが含まれており、Dataverse データの次の行をできるだけ早く取得するため、指定された場合には使用する必要があります。 ページング Cookie 内のデータを修正すべきではありません。取り込み要素 の paging-cookie 属性に値を設定し、後続のリクエストのために page 属性の値をインクリメントするだけです。

ページング Cookie をサポートしないクエリ

一部のクエリはページング cookie をサポートしていません。 ページング Cookie がクエリでサポートされていない場合、結果としてページング Cookie 値は返されません。 たとえば、クエリを使用して並べ替えると、link-entity 属性はページング Cookie をサポートしていない可能性があります。

Dataverse がページング Cookie を返さない場合、ページング モデルは、それに付随するすべての制限を伴う単純なページングに戻ります。

ページング cookie をどのように使用するかは、SDK for .NET または Web API のどちらを使用しているかによって異なります。

次の RetrieveAll 静的メソッドは、FetchXml クエリに一致するすべてのレコードを返し、レコード数がページ サイズを超える場合は複数のリクエストを送信します。

各リクエストの後、メソッドは EntityCollection.MoreRecords プロパティ をチェックして、条件に一致するレコードがさらにあるかどうかを判断します。 さらにレコードがある場合、メソッドは返された EntityCollection.PagingCookie プロパティ の値を 取り込み要素 の paging-cookie 属性に設定し、別のリクエストを送信します。

/// <summary>
/// Returns all records matching the criteria
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance.</param>
/// <param name="fetchXml">The fetchXml Query string</param>
/// <param name="pageSize">The page size to use. Default is 5000</param>
/// <returns>All the records that match the criteria</returns>
static EntityCollection RetrieveAll(IOrganizationService service, string fetchXml, int pageSize = 5000)
{

    // The records to return
    List<Entity> entities = new();

    XElement fetchNode = XElement.Parse(fetchXml);

    int page = 1; //Start with page 1

    //Set the page
    fetchNode.SetAttributeValue("page", page);

    // Set the page size
    fetchNode.SetAttributeValue("count", pageSize);

    while (true)
    {
        // Get the page
        EntityCollection results = service.RetrieveMultiple(new FetchExpression(fetchNode.ToString()));

        entities.AddRange(results.Entities);

        if (!results.MoreRecords)
        {
            break;
        }

        // Set the fetch paging-cookie attribute with the paging cookie from the previous query
        fetchNode.SetAttributeValue("paging-cookie", results.PagingCookie);

        fetchNode.SetAttributeValue("page", page++);
    }
    return new EntityCollection(entities);
}

次の手順で、クイック スタート: SDK for .NETリクエスト (C#) の実行 サンプルを調整して、FetchXml クエリをテストできます。

  1. Program クラスに RetrieveAll 静的メソッドを追加します。
  2. Main メソッドを以下のように変更します:
static void Main(string[] args)
{
    using (ServiceClient serviceClient = new(connectionString))
    {
        if (serviceClient.IsReady)
        {
            //WhoAmIResponse response = 
            //    (WhoAmIResponse)serviceClient.Execute(new WhoAmIRequest());

            //Console.WriteLine("User ID is {0}.", response.UserId);

            string fetchQuery = @"<fetch count='3' page='1'>
                <entity name='contact'>
                    <attribute name='fullname'/>
                    <attribute name='jobtitle'/>
                    <attribute name='annualincome'/>
                    <order descending='true' attribute='fullname'/>
                </entity>
        </fetch>";

            EntityCollection records = RetrieveAll(service: serviceClient,
                        fetchXml: fetchQuery,
                        pageSize: 25);

            Console.WriteLine($"Success: {records.Entities.Count}");
        }
        else
        {
            Console.WriteLine(
                "A web service connection was not established.");
        }
    }

    // Pause the console so it does not close.
    Console.WriteLine("Press the <Enter> key to exit.");
    Console.ReadLine();
}

重要

このクエリは、条件に一致するすべてのレコードを返します。 結果を制限するには、フィルター要素を必ず含めてください。

次の手順

データ集計の方法について解説します。

データの集計

注意

ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。