Create an EdgeKV-enabled EdgeWorkers function

Learn how to enhance your EdgeWorkers code with an EdgeKV key-value database.

Before you begin, we recommend that you review the Get Started section in the EdgeWorkers documentation. These instructions include a Hello World tutorial that illustrates an end-to-end EdgeWorkers example.

👍

EdgeWorkers functions running on the production network can only be used with EdgeKV namespaces created on the production network. Similarly, EdgeWorkers running on the staging network can only access EdgeKV namespaces created on the staging network. This is to ensure separation of concerns for security reasons.

Prerequisites

Before you start, ensure you have these prerequisites:

👍

You can use the information generated by an EdgeWorkers HTTP sub-request to troubleshoot your EdgeKV database. When enabling enhanced debug headers for EdgeWorkers you need to include the akamai-x-ew-debug-subs header to return information about EdgeKV.

Below is a high-level overview of the steps required to create an EdgeKV-enabled EdgeWorkers function.

StepLinkDescription
1Create an EdgeWorkers functionEdgeKV is enabling technology for EdgeWorkers. You need to build an EdgeWorkers function using the Dynamic Compute resource tier to use an EdgeKV database.
2Add data to your EdgeKV databaseYou need to initialize your EdgeKV database and populate it with data via an API or CLI call.
3Create a code bundleCreate a code bundle that includes the EdgeKV helper library and your access token file.
4Activate your EdgeWorkers functionUpload your EdgeKV-enabled EdgeWorkers function and activate and test it on the staging network.