Built-in plug-ins

Install or remove built-in plug-ins

Update IK dictionaries

Standard update

The standard update method updates the dictionary on all nodes in an Elasticsearch cluster. If you choose the standard update method, Elasticsearch will send the uploaded dictionary file to all nodes in the cluster, modify the IKAnalyzer.cfg.xml file, and then restart the nodes to load the uploaded dictionary file.

Standard update example

1. Log on to the Alibaba Cloud Elasticsearch console, and click the ID of the Elasticsearch instance that you want to update IK dictionaries for.
2. In the left-side navigation pane, click Plug-ins, locate the plug-in that you want to update, click Standard Update in the Actions column.
   
   
3. In the Plug-in Configuration dialog box, click Configure.
   
   
4. Click Upload DIC File under IK Main Dictionary, and upload a custom main dictionary file.
   
   
   Note You can upload a dic file or add an OSS file. If the content of the dictionary file stored in the cloud or on your local host changes, you must use these methods to manually upload the dictionary file to update the dictionary.
5. Notice This operation will restart the Elasticsearch instance. Make sure that your businesses are not affected before you confirm the operation.
   Scroll down to the bottom, select This operation will restart the instance. Continue? to confirm the operation, and click Save.
   
   
6. After the cluster is restarted, log on to the Kibana console, and then run the following command to verify the update is effective:

   GET _analyze
   {
   "analyzer": "ik_smart",
   "text": ["tokens in your updated dictionary"]
   }

   Notice

   • You cannot delete the built-in main dictionary and stopword list.
   • Whether you upload a new dictionary file, remove a dictionary file, or update the dictionary content, the standard update operation always requires Elasticsearch to restart the cluster.
   • You can perform the standard update operation only when the status of the cluster is healthy.

Rolling update

When the content of your dictionary file changes, you can use the rolling update method to update the dictionary. After you upload the latest dictionary file, the Elasticsearch nodes will automatically load the file.

When you perform a rolling update, if the dictionary file list changes, all nodes in the cluster need to reload the dictionary configuration. For example, when you upload a new dictionary file or delete an existing dictionary file, the changes will be updated to the IKAnalyzer.cfg.xml file.

The procedure of rolling update is similar to standard update. If this is the first time that you have uploaded a dictionary file, you must edit the IKAnalyzer.cfg.xml configuration file. This means that Elasticsearch needs to restart the cluster to reload the configuration file.

Rolling update example

1. Log on to the Alibaba Cloud Elasticsearch console and click the ID of the Elasticsearch instance that you want to update the dictionaries for.
2. In the left-side navigation pane, click Plug-ins, locate the plug-in that you need to update, and click Rolling Update in the Actions column.
   
   
3. In the Plug-in Configuration dialog box, click Configure.
   
   
4. Click Upload DIC File under IK Main Dictionary, and upload a custom main dictionary file.
   
   
   
   Note You can upload a dic file or add an OSS file. If the content of the dictionary file stored in the cloud or on your local host changes, you must use these methods to manually upload the dictionary file to update the dictionary.
5. Notice This operation will restart the Elasticsearch instance. Make sure that your businesses are not affected before you confirm the operation.
   Scroll down to the bottom, select the This operation will restart the instance. Continue? check box to confirm the operation, and click Save. Elasticsearch needs to restart the cluster only if this is the first time that you have uploaded a dictionary file.
   
   

   After you click Save, the cluster will perform a rolling update. After the rolling update is complete, the updated dictionary takes effect.

   If you need to add tokens to or remove tokens from the updated dictionary, follow these steps to replace the a_10words.dic dictionary file.

6. In the rolling update dialog box, delete the existing dictionary file, and then upload a new dictionary file named as a_10words.dic.

   This task changes the content of an existing dictionary file on the cluster. Therefore, Elasticsearch does not need to restart the cluster for the update to take effect, as shown in the following figure.

7. Click Save.
   The plug-in on the nodes of the Elasticsearch cluster will automatically load the dictionary file. The time that each node takes to load the dictionary file varies. Please wait for the new dictionary to take effect. It may take about two minutes for all nodes to upload the dictionary file. You can log on to the Kibana console and run the following command to verify that the new dictionary is effective.

   GET _analyze
   {
   "analyzer": "ik_smart",
   "text": ["tokens in your updated dictionary"]
   }

   Note You can not use the rolling update method to edit the built-in main dictionary. If you want to modify the built-in main dictionary, use the standard update method.

For more information, see elasticsearch-analysis-ik.