Skip to content

Commit 1ec3a64

Browse files
JoanneHendricksonVesaJuvonen
authored andcommitted
Update export-amr-api.md (SharePoint#4697)
Content update: Edits per PM to the Asynchronous metadata read api.
1 parent 607425d commit 1ec3a64

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/apis/export-amr-api.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ The following provides high level guidelines for implementing the asynchronous m
212212

213213
### Sharepoint Migration Export (Asynchronous Metadata Read) API Example
214214

215-
#### Scenario: Large FileShare with nested files/folders
215+
#### Scenario: Large file share with nested files/folders
216216

217217
Suggestion:
218218

@@ -224,6 +224,8 @@ Suggestion:
224224
a. Issue CreateSPAsyncReadJob with URL = root URL (e.g. <spam><spam>www.contoso.com/my-resource-document/a<spam><spam>) </br>
225225
b. Issue CreateSPAsyncReadJob with URL = root URL (e.g. <spam><spam>www.contoso.com/my-resource-document/b<spam><spam>)
226226

227+
>[!NOTE]
228+
>This scenario is only recommended for top level folders or if the sub-folder contains greater than 100k of objects. The performance of the asynchronous metadata read api is not as effective when reading a small set of items.
227229
228230
#### Scenario: Tenant to tenant or large Sharepoint Migration
229231

@@ -259,9 +261,11 @@ By default, each URL supports up to 1 million limits. At the start of the migrat
259261

260262

261263
## Performance Expectation
262-
The preliminary performance test provides a rough estimate of more than 200 items per second throughput. This does not account for any potential throttle over the network. If the read asynchronous function fails to reach the server due to throttling, then performance will be impacted. At the start of read asynchronous migration, the server calculates the number of objects to confirm that it is within the 1 million object limit, hence there is an overhead.
264+
The preliminary performance test provides a rough estimate of more than 200 items per second throughput. This does not account for any potential throttle over the network. If the read asynchronous function fails to reach the server due to throttling, then performance will be impacted.
265+
266+
This measure of throughput assumes the software package has a sufficient items per read. The recommendation is to read greater than 10K per package. This is because at the start of read asynchronous migration, the server calculates the number of objects to confirm that it is within the 1 million object limit, hence there is an overhead. If only a few thousand are being read, it results in a less than ideal performance.
263267

264-
For single read query or small items read (e.g. hundreds of items), it is faster to use Graph API or RESTful/CSOM query as the asynchronous read metadata will have the overhead cost.
268+
For single read query or small items read (e.g. 1000 items), it is faster to use Graph API or RESTful/CSOM query as the asynchronous read metadata will have the overhead cost.
265269

266270
However, one of the key performance benefits of the asynchronous metadata read is the ability to balance the server-side load and the backend query is much more efficient than individual CSOM load reducing your chance of throttling.
267271

0 commit comments

Comments
 (0)