This article describes how to create and manage KV storage namespaces in the EdgeOne console, and how to bind namespaces to edge functions to enable read and write access to persistent data.
Note:
KV Storage is currently open via allowlist. If you need to use it, please contact us to apply for access. Directions
Creating a Namespace
1. Log in to EdgeOne, in the left menu bar, click Site List, in the site list, click the site you need to configure, and go to the site details page. 2. In the left navigation, click KV Storage to go to the KV Storage list page.
3. Click Create Namespace, and fill in the following information in the pop-up window:
|
Namespace | Required. It supports a maximum of 50 bytes. Allowed characters include letters, numbers, and hyphens. Hyphens cannot be used alone or consecutively, and cannot be placed at the beginning or end. Modification is not supported after creation. |
Description | Optional. A maximum of 200 bytes is supported. It can be modified at any time after creation. |
4. Click OK to complete namespace creation.
Note:
Each site can create up to 10 namespaces by default.
Manage KV key-value pairs
Add KV Key-Value Pair
1. In the KV Storage list page, click Manage in the row of the target namespace to go to the namespace details page.
2. In the KV pairs list area, click Add KV pair and fill in the following information in the pop-up window:
|
Key | Required. It supports a maximum of 512 bytes. Spaces and backslashes (\\) are not allowed. It cannot be modified after creation. |
Value | Required. Supports up to 1 MB. |
3. Click Create to complete the key-value pair addition.
View KV pairs
1. On the namespace details page, click View in the row of the target key-value pair.
2. In the viewing window, you can:
Copy the Key or Value content.
Click Download to download the Value locally.
Note:
Value is displayed in UTF-8 encoding. If the Value is binary data, it is recommended to download and view it using a binary viewer after downloading.
Edit KV key-value pair
1. On the namespace details page, click Edit in the row of the target key-value pair.
2. Modify the Value content and click OK in the editing window.
Note:
Key cannot be modified and can only be copied in the editing window.
Delete the KV key-value pair
1. On the namespace details page, click Delete in the row of the target key-value pair.
2. In the secondary confirmation pop-up window, click Confirm to delete after verifying.
Bind the namespace to edge functions
1. Log in to EdgeOne, click Site List in the left menu bar, select the target site in the site list, and go to the site details page. 2. In the left navigation, click Edge Functions > Function Management to go to the function management list page.
3. Click the Function Name of the target function to go to the function details page.
4. On the function details page, in the Extended Services module, click Add Service Binding, and fill in the following information in the pop-up window:
|
Variable Name | Required. The variable name used to access the KV namespace in the function code. It supports up to 50 bytes, allowing letters, numbers, and underscores. Numbers cannot be at the beginning. Duplicate names are not allowed within the same function. It cannot be modified after creation. |
Namespace | Required. Select the KV namespace to bind. Namespaces within the same site or across sites are supported. |
5. Click Confirm to complete the service binding. After the binding is successful, you can view the bound namespace information in the Extended Services list.
Unbind the service
1. In the Extended Services list on the function details page, click Unbind in the row of the target binding service.
2. In the confirmation pop-up window, click Confirm to unbind after verification.
Deleting a Namespace
1. On the KV Storage list page, click Delete in the row of the namespace to be deleted.
2. In the confirmation pop-up window, click Confirm after verification.
Note:
1. After deletion, the namespace is irrecoverable, and all KV key-value pair data within it will be cleared. Please back up important data in advance.
2. If the namespace is bound to functions, the deletion will fail. You need to unbind all service bindings from functions before deletion.
Reference