PolarSearch has built-in plugins, such as polar-analysis-ik and analysis-ansj, and supports features like synonym hot updates. You can also upload your own custom dictionaries. This document describes how to add, use, and manage these dictionaries.
Enable plugin upload space
-
Log in to the PolarDB console. In the left-side navigation pane, click Clusters. Select the region where your cluster is located, and then click the target cluster ID to open the cluster details page.
-
In the left-side navigation pane, navigate to . On the Plugin Management tab, click Enable Plugin Upload Space.
Dictionary management
On the Plugin Management tab, you can manage dictionaries for any plugin that uses them.
-
Log in to the PolarDB console. In the left-side navigation pane, click Clusters. Select the region where your cluster is located, and then click the target cluster ID to open the cluster details page.
-
In the left-side navigation pane, navigate to and open the Plugin Management tab.
-
On the dictionary management page, you can view information such as dictionary file names, dictionary types, and file sizes. You can also add, update, and delete dictionary files.
Dictionary overview
|
Plugin name |
Description |
Dictionary type |
Actions |
|
cluster-dict-management |
The default cluster-level dictionary management plugin. It provides a centralized way to manage stopword and synonym dictionaries. |
Stopword dictionary, Synonym dictionary |
Upload Dictionary, Delete Dictionary |
|
polar-analysis-ik |
A lightweight, Java-based Chinese tokenizer that supports fine-grained and smart tokenization. |
Main dictionary, Stopword dictionary |
Upload Dictionary, Delete Dictionary, Enable/Disable Dictionary, Hot Update |
|
analysis-ansj |
A Chinese tokenizer plugin based on the n-gram model. |
Main dictionary, Stopword dictionary, Synonym dictionary, Ambiguity dictionary, Configuration file |
Upload Dictionary, Delete Dictionary |
|
analysis-dynamic-synonym |
A synonym dictionary hot update plugin. |
Synonym dictionary |
Upload Dictionary, Delete Dictionary, Enable/Disable Dictionary, Hot Update |
Upload a dictionary
While a dictionary is uploading, the Upload Dictionary button is disabled (grayed out). You can click Refresh to check the status. The upload is complete when the Upload Dictionary button is enabled (turns blue).
-
In the row for the desired plugin, click Dictionary Definition to open its management page.
-
Click Upload Dictionary. In the dialog box that appears, select the local dictionary file you want to upload, click OK, and wait for the upload to complete.
Delete a dictionary
During the dictionary deletion process, the Upload Dictionary button is disabled (grayed out). You can click Refresh to check the status. The deletion is complete when the button is enabled (turns blue).
-
In the row for the desired plugin, click Dictionary Definition to open its management page.
-
Click Delete, and then click OK in the confirmation dialog box.
Enable or disable a dictionary
This feature is currently supported only by the polar-analysis-ik plugin.
An enabled state indicates that the IK analyzer has loaded the dictionary into memory. A disabled state indicates that the IK analyzer has removed it from memory.
While a dictionary is being enabled or disabled, the corresponding button is disabled (grayed out). You can click Refresh to check the status. The operation is complete when the button is enabled (turns blue).
Hot update a dictionary
You can only hot-update enabled dictionaries. This feature is currently supported only by the polar-analysis-ik plugin.
During a hot update, the dictionary's status changes to Updating. You can click Refresh to check the progress. The hot update is complete when the status returns to Enabled.
-
In the row for the desired plugin, click Dictionary Definition to open its management page.
-
Click Rolling Update and upload a dictionary with the same name to hot-update its content.