Skip to content

Commit 2db34ca

Browse files
laurabrenlaurabren
authored
Merge pull request #190005 from HeidiSteen/heidist-work
Configure and run indexers
2 parents 414a32e + da73321 commit 2db34ca

9 files changed

+110
-115
lines changed

‎articles/search/search-file-storage-integration.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,9 @@ In the [search index](search-what-is-an-index.md), add fields to accept the cont
132132

133133
## Configure and run the file indexer
134134

135-
Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors. Under "configuration", you can specify which files are indexed by file type or by properties on the files themselves.
135+
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
136136

137-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) to use the predefined data source and search index.
137+
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
138138

139139
```http
140140
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
@@ -143,11 +143,11 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
143143
"dataSourceName" : "my-file-datasource",
144144
"targetIndexName" : "my-search-index",
145145
"parameters": {
146-
"batchSize": null,
147-
"maxFailedItems": null,
148-
"maxFailedItemsPerBatch": null,
149-
"base64EncodeKeys": null,
150-
"configuration": {
146+
"batchSize": null,
147+
"maxFailedItems": null,
148+
"maxFailedItemsPerBatch": null,
149+
"base64EncodeKeys": null,
150+
"configuration": {
151151
"indexedFileNameExtensions" : ".pdf,.docx",
152152
"excludedFileNameExtensions" : ".png,.jpeg"
153153
}
@@ -167,6 +167,8 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
167167

168168
1. See [Create an indexer](search-howto-create-indexers.md) for more information about other properties.
169169

170+
An indexer runs automatically when it's created. You can prevent this by setting "disabled" to true. To control indexer execution, [run an indexer on demand](search-howto-run-reset-indexers.md) or [put it on a schedule](search-howto-schedule-indexers.md).
171+
170172
## Check indexer status
171173

172174
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request:

‎articles/search/search-howto-connecting-azure-sql-database-to-azure-search-using-indexers.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ In a [search index](search-what-is-an-index.md), add fields to accept values fro
111111
112112
## Configure and run the Azure SQL indexer
113113
114-
Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
114+
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
115115
116116
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
117117
@@ -126,13 +126,13 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
126126
"disabled": null,
127127
"schedule": null,
128128
"parameters": {
129-
"batchSize": null,
130-
"maxFailedItems": 0,
131-
"maxFailedItemsPerBatch": 0,
132-
"base64EncodeKeys": false,
133-
"configuration": {
134-
"queryTimeout": "00:05:00",
135-
"disableOrderByHighWaterMarkColumn": false
129+
"batchSize": null,
130+
"maxFailedItems": 0,
131+
"maxFailedItemsPerBatch": 0,
132+
"base64EncodeKeys": false,
133+
"configuration": {
134+
"queryTimeout": "00:05:00",
135+
"disableOrderByHighWaterMarkColumn": false
136136
}
137137
},
138138
"fieldMappings": [],

‎articles/search/search-howto-index-azure-data-lake-storage.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -133,11 +133,11 @@ In a [search index](search-what-is-an-index.md), add fields to accept the conten
133133

134134
1. Add fields for standard metadata properties. The indexer can read custom metadata properties, [standard metadata](#indexing-blob-metadata) properties, and [content-specific metadata](search-blob-metadata-properties.md) properties.
135135

136-
## Configure the ADLS Gen2 indexer
136+
## Configure and run the ADLS Gen2 indexer
137137

138-
Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors. The "configuration" section determines what content gets indexed.
138+
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
139139

140-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) to use the predefined data source and search index.
140+
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
141141

142142
```http
143143
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
@@ -146,17 +146,17 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
146146
"dataSourceName" : "my-adlsgen2-datasource",
147147
"targetIndexName" : "my-search-index",
148148
"parameters": {
149-
"batchSize": null,
150-
"maxFailedItems": null,
151-
"maxFailedItemsPerBatch": null,
152-
"base64EncodeKeys": null,
153-
"configuration:" {
154-
"indexedFileNameExtensions" : ".pdf,.docx",
155-
"excludedFileNameExtensions" : ".png,.jpeg",
156-
"dataToExtract": "contentAndMetadata",
157-
"parsingMode": "default",
158-
"imageAction": "none"
159-
}
149+
"batchSize": null,
150+
"maxFailedItems": null,
151+
"maxFailedItemsPerBatch": null,
152+
"base64EncodeKeys": null,
153+
"configuration:" {
154+
"indexedFileNameExtensions" : ".pdf,.docx",
155+
"excludedFileNameExtensions" : ".png,.jpeg",
156+
"dataToExtract": "contentAndMetadata",
157+
"parsingMode": "default",
158+
"imageAction": "none"
159+
}
160160
},
161161
"schedule" : { },
162162
"fieldMappings" : [ ]
@@ -181,9 +181,9 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
181181

182182
In blob indexing, you can often omit field mappings because the indexer has built-in support for mapping the "content" and metadata properties to similarly named and typed fields in an index. For metadata properties, the indexer will automatically replace hyphens `-` with underscores in the search index.
183183

184-
1. See [Create an indexer](search-howto-create-indexers.md) for more information about other properties.
184+
1. See [Create an indexer](search-howto-create-indexers.md) for more information about other properties. For the full list of parameter descriptions, see [Blob configuration parameters](/rest/api/searchservice/create-indexer#blob-configuration-parameters) in the REST API.
185185

186-
For the full list of parameter descriptions, see [Blob configuration parameters](/rest/api/searchservice/create-indexer#blob-configuration-parameters) in the REST API.
186+
An indexer runs automatically when it's created. You can prevent this by setting "disabled" to true. To control indexer execution, [run an indexer on demand](search-howto-run-reset-indexers.md) or [put it on a schedule](search-howto-schedule-indexers.md).
187187

188188
## Check indexer status
189189

‎articles/search/search-howto-index-cosmosdb-gremlin.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,9 @@ In a [search index](search-what-is-an-index.md), add fields to accept the source
160160

161161
## Configure and run the Cosmos DB indexer
162162

163-
Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
163+
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
164164

165-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) to use the predefined data source and search index.
165+
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
166166

167167
```http
168168
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
@@ -175,12 +175,12 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
175175
"disabled": null,
176176
"schedule": null,
177177
"parameters": {
178-
"batchSize": null,
179-
"maxFailedItems": 0,
180-
"maxFailedItemsPerBatch": 0,
181-
"base64EncodeKeys": false,
182-
"configuration": {}
183-
},
178+
"batchSize": null,
179+
"maxFailedItems": 0,
180+
"maxFailedItemsPerBatch": 0,
181+
"base64EncodeKeys": false,
182+
"configuration": {}
183+
},
184184
"fieldMappings": [],
185185
"encryptionKey": null
186186
}
@@ -190,6 +190,8 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
190190
191191
1. See [Create an indexer](search-howto-create-indexers.md) for more information about other properties.
192192
193+
An indexer runs automatically when it's created. You can prevent this by setting "disabled" to true. To control indexer execution, [run an indexer on demand](search-howto-run-reset-indexers.md) or [put it on a schedule](search-howto-schedule-indexers.md).
194+
193195
## Check indexer status
194196
195197
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request:

‎articles/search/search-howto-index-cosmosdb-mongodb.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,9 @@ In a [search index](search-what-is-an-index.md), add fields to accept the source
143143
144144
## Configure and run the Cosmos DB indexer
145145
146-
Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
146+
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
147147
148-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) to use the predefined data source and search index.
148+
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
149149
150150
```http
151151
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
@@ -158,12 +158,12 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
158158
"disabled": null,
159159
"schedule": null,
160160
"parameters": {
161-
"batchSize": null,
162-
"maxFailedItems": 0,
163-
"maxFailedItemsPerBatch": 0,
164-
"base64EncodeKeys": false,
165-
"configuration": {}
166-
},
161+
"batchSize": null,
162+
"maxFailedItems": 0,
163+
"maxFailedItemsPerBatch": 0,
164+
"base64EncodeKeys": false,
165+
"configuration": {}
166+
},
167167
"fieldMappings": [],
168168
"encryptionKey": null
169169
}
@@ -173,6 +173,8 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
173173
174174
1. See [Create an indexer](search-howto-create-indexers.md) for more information about other properties.
175175
176+
An indexer runs automatically when it's created. You can prevent this by setting "disabled" to true. To control indexer execution, [run an indexer on demand](search-howto-run-reset-indexers.md) or [put it on a schedule](search-howto-schedule-indexers.md).
177+
176178
## Check indexer status
177179
178180
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request:

‎articles/search/search-howto-index-cosmosdb.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -203,9 +203,9 @@ In a [search index](search-what-is-an-index.md), add fields to accept the source
203203
204204
## Configure and run the Cosmos DB indexer
205205
206-
Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
206+
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
207207
208-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index.
208+
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
209209
210210
```http
211211
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
@@ -218,12 +218,12 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
218218
"disabled": null,
219219
"schedule": null,
220220
"parameters": {
221-
"batchSize": null,
222-
"maxFailedItems": 0,
223-
"maxFailedItemsPerBatch": 0,
224-
"base64EncodeKeys": false,
225-
"configuration": {}
226-
},
221+
"batchSize": null,
222+
"maxFailedItems": 0,
223+
"maxFailedItemsPerBatch": 0,
224+
"base64EncodeKeys": false,
225+
"configuration": {}
226+
},
227227
"fieldMappings": [],
228228
"encryptionKey": null
229229
}

‎articles/search/search-howto-index-mysql.md

Lines changed: 24 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -105,51 +105,34 @@ If the primary key in the source table matches the document key (in this case, "
105105

106106
## Configure and run the MySQL indexer
107107

108-
Once the index and data source have been created, you're ready to create the indexer.
108+
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
109109

110-
[Create or Update Indexer](/rest/api/searchservice/create-indexer) specifies the predefined data source and search index.
110+
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
111111

112-
```http
113-
POST https://[search service name].search.windows.net/indexers?api-version=2020-06-30
114-
115-
{
116-
"name" : "hotels-mysql-idxr",
117-
"dataSourceName" : "hotels-mysql-ds",
118-
"targetIndexName" : "hotels-mysql-ix",
119-
"disabled": null,
120-
"schedule": null,
121-
"parameters": {
122-
"batchSize": null,
123-
"maxFailedItems": null,
124-
"maxFailedItemsPerBatch": null,
125-
"base64EncodeKeys": null,
126-
"configuration": { }
127-
},
128-
"fieldMappings" : [ ],
129-
"encryptionKey": null
130-
}
131-
```
132-
133-
By default, the indexer runs when it's created on the search service. You can set "disabled" to true if you want to run the indexer manually.
134-
135-
You can now [run the indexer](search-howto-run-reset-indexers.md), [monitor status](search-howto-monitor-indexers.md), or [schedule indexer execution](search-howto-schedule-indexers.md).
136-
137-
To put the indexer on a schedule, set the "schedule" property when creating or updating the indexer. Here is an example of a schedule that runs every 15 minutes.
112+
```http
113+
POST https://[search service name].search.windows.net/indexers?api-version=2020-06-30
114+
115+
{
116+
"name" : "hotels-mysql-idxr",
117+
"dataSourceName" : "hotels-mysql-ds",
118+
"targetIndexName" : "hotels-mysql-ix",
119+
"disabled": null,
120+
"schedule": null,
121+
"parameters": {
122+
"batchSize": null,
123+
"maxFailedItems": null,
124+
"maxFailedItemsPerBatch": null,
125+
"base64EncodeKeys": null,
126+
"configuration": { }
127+
},
128+
"fieldMappings" : [ ],
129+
"encryptionKey": null
130+
}
131+
```
138132
139-
```http
140-
PUT https://[search service name].search.windows.net/indexers/hotels-mysql-idxr?api-version=2020-06-30
141-
Content-Type: application/json
142-
api-key: [admin-key]
133+
1. [Specify field mappings](search-indexer-field-mappings.md) if there are differences in field name or type, or if you need multiple versions of a source field in the search index.
143134
144-
{
145-
"dataSourceName" : "hotels-mysql-ds",
146-
"targetIndexName" : "hotels-mysql-ix",
147-
"schedule" : {
148-
"interval" : "PT15M",
149-
"startTime" : "2022-01-01T00:00:00Z"
150-
}
151-
}
152-
```
135+
An indexer runs automatically when it's created. You can prevent this by setting "disabled" to true. To control indexer execution, [run an indexer on demand](search-howto-run-reset-indexers.md) or [put it on a schedule](search-howto-schedule-indexers.md).
153136
154137
## Check indexer status
155138

‎articles/search/search-howto-indexing-azure-blob-storage.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,11 @@ In a [search index](search-what-is-an-index.md), add fields to accept the conten
127127

128128
1. Add fields for standard metadata properties. The indexer can read custom metadata properties, [standard metadata](#indexing-blob-metadata) properties, and [content-specific metadata](search-blob-metadata-properties.md) properties.
129129

130-
## Configure the blob indexer
130+
## Configure and run the blob indexer
131131

132-
Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors. The "configuration" section determines what content gets indexed.
132+
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
133133

134-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) to use the predefined data source and search index.
134+
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
135135

136136
```http
137137
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
@@ -140,17 +140,17 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
140140
"dataSourceName" : "my-blob-datasource",
141141
"targetIndexName" : "my-search-index",
142142
"parameters": {
143-
"batchSize": null,
144-
"maxFailedItems": null,
145-
"maxFailedItemsPerBatch": null,
146-
"base64EncodeKeys": null,
147-
"configuration:" {
148-
"indexedFileNameExtensions" : ".pdf,.docx",
149-
"excludedFileNameExtensions" : ".png,.jpeg",
150-
"dataToExtract": "contentAndMetadata",
151-
"parsingMode": "default",
152-
"imageAction": "none"
153-
}
143+
"batchSize": null,
144+
"maxFailedItems": null,
145+
"maxFailedItemsPerBatch": null,
146+
"base64EncodeKeys": null,
147+
"configuration:" {
148+
"indexedFileNameExtensions" : ".pdf,.docx",
149+
"excludedFileNameExtensions" : ".png,.jpeg",
150+
"dataToExtract": "contentAndMetadata",
151+
"parsingMode": "default",
152+
"imageAction": "none"
153+
}
154154
},
155155
"schedule" : { },
156156
"fieldMappings" : [ ]
@@ -175,9 +175,9 @@ Indexer configuration specifies the inputs, parameters, and properties controlli
175175

176176
In blob indexing, you can often omit field mappings because the indexer has built-in support for mapping the "content" and metadata properties to similarly named and typed fields in an index. For metadata properties, the indexer will automatically replace hyphens `-` with underscores in the search index.
177177

178-
1. See [Create an indexer](search-howto-create-indexers.md) for more information about other properties.
178+
1. See [Create an indexer](search-howto-create-indexers.md) for more information about other properties. For the full list of parameter descriptions, see [Blob configuration parameters](/rest/api/searchservice/create-indexer#blob-configuration-parameters) in the REST API.
179179

180-
For the full list of parameter descriptions, see [Blob configuration parameters](/rest/api/searchservice/create-indexer#blob-configuration-parameters) in the REST API.
180+
An indexer runs automatically when it's created. You can prevent this by setting "disabled" to true. To control indexer execution, [run an indexer on demand](search-howto-run-reset-indexers.md) or [put it on a schedule](search-howto-schedule-indexers.md).
181181

182182
## Check indexer status
183183

0 commit comments

Comments
 (0)