The edgekv Developer Hub

Welcome to the edgekv developer hub. You'll find comprehensive guides and documentation to help you start working with edgekv as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

FAQ

Find answers to commonly-asked questions about EdgeKV.

What are the main EdgeKV features?

EdgeKV product features include:

  • Key-Value database. Stores data in string or JSON format.
  • JavaScript helper library. Abstracts CRUD data operations on EdgeKV databases from inside EdgeWorkers code.
  • Replicated storage. Ensures high availability of stored data by replicating it across multiple geographic locations.
  • Administrative API. Enables control of EdgeKV database functions outside EdgeWorkers code.
  • Tokenized access. Enforces access controls to EdgeKV databases.

What are the prerequisites for EdgeKV?

The primary prerequisite for EdgeKV is the EdgeWorkers Dynamic Compute product on contract. EdgeWorkers itself requires an underlying ‚ÄčAkamai‚Äč delivery product. Refer to the EdgeWorkers limitations section for a complete list of supported delivery products.

How do I gain access to EdgeKV?

If you're an ‚ÄčAkamai‚Äč customer interested in participating in the EdgeKV program, you can use the Marketplace app store to provision EdgeKV, or speak with your ‚ÄčAkamai‚Äč account representative. If you're not a current ‚ÄčAkamai‚Äč customer, submit a request using this form.

Does EdgeKV use a strong or eventual consistency model?

EdgeKV uses an eventual consistency model to achieve high availability.

Why is the initialization command failing?

First, make sure you have API credentials for a user at the top level group under your account. If you still get a failure, you can try calling the initialize API endpoint or CLI command again.

If initialization continues to fail, capture the API response or CLI command output. We'll also need the response from the GET /edgekv/v1/initialize API or the output of the edgekv show status CLI command to help debug the problem.

If this problem persists, contact ‚ÄčAkamai‚Äč support at edgeworkers@akamai.com.

When I write a value, why doesn't it show up immediately?

EdgeKV is an eventually consistent system. This means that there's a period of time (called the ‚Äúinconsistency window‚ÄĚ) when a write operation must propagate across the network to update that object. Before a read operation can be consistently completed against that object, this window of time must expire. This period of time is 10 seconds or less in the majority of cases.

How do I create a group?

Groups can only be created in tandem with the creation of an item to store in that group. They cannot be directly created. A group is automatically created for you if it doesn't already exist when using an API call or a CLI command.

How is data stored in EdgeKV?

EdgeKV stores data as unstructured text objects that are not strongly typed. Please specify the data return format using the getText() or getJSON() library helper method. ‚ÄčAkamai‚Äč automatically transforms text into a JSON object.

Why is my ‚ÄčAkamai‚Äč token not working from my code bundle?

There are two sets of credentials that can be used for EdgeKV. The token created in ‚ÄčAkamai Control Center‚Äč (‚ÄúEdgeGrid‚ÄĚ) is only used for making calls against the Administrative API. The other token, the EdgeKV access token, is included in the EdgeWorkers code bundle to control access to an EdgeKV namespace.

Why do I get an error when I try to initialize a database?

If you receive an error indicating that, ‚ÄúThe client does not have the grant needed for the request,‚ÄĚ your API client is missing the required READ-WRITE access level. For instructions on how to add it, refer to the Get started section in the EdgeKV API documentation.

Updated about a month ago


FAQ


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.