Skip to content

Commit d3424e1

Browse files
Merge pull request #304632 from EXPEkesheth/patch-741433
Revise reindex job parameters in documentation
2 parents 32cb902 + ba4d8cc commit d3424e1

1 file changed

Lines changed: 16 additions & 40 deletions

File tree

articles/healthcare-apis/fhir/how-to-run-a-reindex.md

Lines changed: 16 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: How to run a reindex job in FHIR service - Azure Health Data Services
3-
description: How to run a reindex job to index any search or sort parameters that haven't yet been indexed in your database
3+
description: How to run a reindex job to index any search or sort parameters that are not yet indexed in your database
44
author: expekesheth
55
ms.service: azure-health-data-services
66
ms.subservice: fhir
@@ -78,15 +78,11 @@ Content-Location: https://{{FHIR URL}}/_operations/reindex/560c7c61-2c70-4c54-b8
7878
"valueString": "Queued"
7979
},
8080
{
81-
"name": "maximumConcurrency",
82-
"valueDecimal": 3.0
83-
},
84-
{
85-
"name": "queryDelayIntervalInMilliseconds",
86-
"valueDecimal": 500.0
81+
"name": "maximumNumberOfResourcesPerQuery",
82+
"valueDecimal": 100.0
8783
},
8884
{
89-
"name": "maximumNumberOfResourcesPerQuery",
85+
"name": "maximumNumberOfResourcesPerWrite",
9086
"valueDecimal": 100.0
9187
}
9288
]
@@ -113,7 +109,7 @@ content-type: application/fhir+json
113109
}
114110
```
115111
> [!NOTE]
116-
> To check the status of, or cancel a reindex job, you need the reindex ID. This is the `"id"` carried in the `"parameter"` value of the response. In the preceding example, the ID for the reindex job would be `560c7c61-2c70-4c54-b86d-c53a9d29495e`.
112+
> To check the status of, or cancel a reindex job, you need the reindex ID. Reindex ID is the `"id"` carried in the `"parameter"` value of the response. In the preceding example, the ID for the reindex job would be `560c7c61-2c70-4c54-b86d-c53a9d29495e`.
117113
118114
## How to check the status of a reindex job
119115

@@ -167,10 +163,6 @@ Here's an example response.
167163
"name": "status",
168164
"valueString": "Completed"
169165
},
170-
{
171-
"name": "maximumConcurrency",
172-
"valueDecimal": 3.0
173-
},
174166
{
175167
"name": "resources",
176168
"valueString": "{{LIST_OF_IMPACTED_RESOURCES}}"
@@ -184,11 +176,11 @@ Here's an example response.
184176
"valueString": "{{LIST_OF_SEARCHPARAM_URLS}}"
185177
},
186178
{
187-
"name": "queryDelayIntervalInMilliseconds",
188-
"valueDecimal": 500.0
179+
"name": "maximumNumberOfResourcesPerQuery",
180+
"valueDecimal": 100.0
189181
},
190182
{
191-
"name": "maximumNumberOfResourcesPerQuery",
183+
"name": "maximumNumberOfResourcesPerWrite",
192184
"valueDecimal": 100.0
193185
}
194186
]
@@ -199,7 +191,7 @@ The following information is shown in the preceding response:
199191

200192
* `totalResourcesToReindex`: Includes the total number of resources that are being reindexed in this job.
201193

202-
* `resourcesSuccessfullyReindexed`: The total number of resources that have already been reindexed in this job.
194+
* `resourcesSuccessfullyReindexed`: The total number of resources reindexed in this job.
203195

204196
* `progress`: Reindex job percent complete. Equals `resourcesSuccessfullyReindexed`/`totalResourcesToReindex` x 100.
205197

@@ -219,20 +211,8 @@ If you need to cancel a reindex job, use a `DELETE` call and specify the reindex
219211

220212
## Performance considerations
221213

222-
A reindex job can be quite performance intensive. The FHIR service offers throttling controls to help manage how a reindex job runs on your database.
223-
224-
> [!NOTE]
225-
> It is not uncommon on large datasets for a reindex job to run for days.
226-
227-
Below is a table outlining the available parameters, defaults, and recommended ranges for controlling reindex job compute resources. You can use these parameters to either speed up the process (use more compute) or slow down the process (use less compute).
228-
229-
| **Parameter** | **Description** | **Default** | **Available Range** |
230-
| --------------------------------- | ---------------------------- | ------------------ | ------------------------------- |
231-
| `QueryDelayIntervalInMilliseconds` | The delay between each batch of resources being kicked off during the reindex job. A smaller number speeds up the job while a larger number slows it down. | 500 MS (.5 seconds) | 50 to 500000 |
232-
| `MaximumResourcesPerQuery` | The maximum number of resources included in the batch to be reindexed. | 100 | 1-5000 |
233-
| `MaximumConcurrency` | The number of batches done at a time. | 1 | 1-10 |
234-
235-
If you want to use any of the preceding parameters, you can pass them into the `Parameters` resource when you send the initial `POST` request to start a reindex job.
214+
A reindex job can be quite performance intensive. The FHIR service offers throttling controls to help manage how a reindex job runs on your database. You can use `MaximumResourcesPerQuery` parameter to either speed up the process (use more compute) or slow down the process (use less compute). `MaximumResourcesPerQuery` parameter allows to set the maximum number of resources included in the batch to be reindexed. The default value is 100 and you can set value between 1-5000.
215+
Sample request with the parameter:
236216

237217
```json
238218

@@ -241,24 +221,20 @@ content-type: application/fhir+json
241221
{
242222
"resourceType": "Parameters",
243223
"parameter": [
244-
{
245-
"name": "maximumConcurrency",
246-
"valueInteger": "3"
247-
},
248-
{
249-
"name": "queryDelayIntervalInMilliseconds",
250-
"valueInteger": "1000"
251-
},
252224
{
253225
"name": "maximumNumberOfResourcesPerQuery",
254226
"valueInteger": "1"
255227
}
256228
]
257229
}
258230
```
231+
232+
> [!NOTE]
233+
> It is not uncommon on large datasets for a reindex job to run for days.
234+
259235
## Next steps
260236

261-
In this article, you've learned how to perform a reindex job in your FHIR service. To learn how to define custom search parameters, see
237+
In this article, you learned how to perform a reindex job in your FHIR service. To learn how to define custom search parameters, see
262238

263239
>[!div class="nextstepaction"]
264240
>[Defining custom search parameters](how-to-do-custom-search.md)

0 commit comments

Comments
 (0)