Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
---
title: Delete key-value pairs
description: >-
To remove a key-value pair from KV Store, call the delete() method on your
KV instance.
meta_tags: 'kv store, api, functions, delete, remove, storage'
namespace: documentation_runtime_kv_store_delete
permalink: /documentation/runtime/api-reference/kv-store/delete/
menu_namespace: runtimeMenu
---

To remove a key-value pair from KV Store, call the `delete()` method on your
KV instance:

```javascript
await kv.delete(key);
```

## Example

An example of deleting a key-value pair from within a Function:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

try {
await kv.delete("user-session");

return new Response("Key deleted successfully", { status: 200 });
} catch (e) {
return new Response(e.message, { status: 500 });
}
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

---

## Reference

### `delete()` method

To remove a key-value pair, call the `delete()` method on your KV instance:

```javascript
await kv.delete(key);
```

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `key` | `string` | The key of the KV pair to delete. |

#### Response

| Response | Type | Description |
|----------|------|-------------|
| `response` | `Promise<void>` | A Promise that resolves when the deletion is complete. |

The `delete()` method returns a Promise that you should `await` to verify
successful deletion.

---

## Guidance

### Deleting non-existent keys

Deleting a key that doesn't exist will not throw an error. The operation
completes successfully regardless of whether the key existed:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

// This will succeed even if the key doesn't exist
await kv.delete("non-existent-key");

return new Response("Delete operation completed", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Eventual consistency

Like all KV Store operations, deletions are eventually consistent. After
deleting a key:

- The deletion is immediately visible in the same global network location.
- Other locations may still see the old value for up to 60 seconds (or the
duration of any `cacheTtl` that was set when reading the key).

### Conditional deletion

You may want to check if a key exists before deleting it, or perform
additional logic:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();
const key = "user-session";

// Check if key exists before deleting
const value = await kv.get(key, "text");

if (value === null) {
return new Response("Key not found", { status: 404 });
}

// Perform deletion
await kv.delete(key);

return new Response("Key deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting multiple keys

To delete multiple keys, you can use `Promise.all()`:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

const keysToDelete = ["key1", "key2", "key3"];

await Promise.all(keysToDelete.map(key => kv.delete(key)));

return new Response("All keys deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting namespaces

To delete an entire namespace (not just a key), use the static
`Azion.KV.delete()` method:

```javascript
async function handleRequest(request) {
const namespaceName = "my-namespace";

// Delete the entire namespace
await Azion.KV.delete(namespaceName);

return new Response("Namespace deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

:::caution
Deleting a namespace removes all key-value pairs within it. This operation
cannot be undone.
:::

---

## Related

- [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/)
- [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/)
- [KV Store API overview](/en/documentation/runtime/api-reference/kv-store/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
title: KV Store API
description: >-
The KV Store API provides methods to store, retrieve, and delete key-value
pairs from within your Functions.
meta_tags: 'kv store, api, functions, key-value, storage'
namespace: documentation_runtime_kv_store_api
permalink: /documentation/runtime/api-reference/kv-store/
menu_namespace: runtimeMenu
---

The KV Store API allows your Functions to interact with Azion's distributed
key-value storage directly from the runtime. This enables low-latency data
persistence and retrieval without external API calls.

## Initializing the KV client

You can initialize the KV client using the constructor or the `open` method:

```javascript
// Using the default namespace
const kv = new Azion.KV();

// Using a specific namespace
const kv = new Azion.KV("my-namespace");

// Using the open method (async)
const kv = await Azion.KV.open("my-namespace");
```

## Available methods

The `Azion.KV` class provides the following methods for data operations:

| Method | Description | Reference |
|--------|-------------|-----------|
| `put(key, value, options?)` | Store a key-value pair | [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/) |
| `get(key, type?, options?)` | Retrieve a value by key | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `getWithMetadata(key, type?, options?)` | Retrieve a value with its metadata | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `delete(key)` | Delete a key-value pair | [Delete key-value pairs](/en/documentation/runtime/api-reference/kv-store/delete/) |

## Namespace management

| Method | Description |
|--------|-------------|
| `new Azion.KV()` | Creates a KV instance using the default namespace |
| `new Azion.KV(name)` | Creates a KV instance for the specified namespace |
| `Azion.KV.open(name)` | Opens a namespace asynchronously |
| `Azion.KV.delete(name)` | Deletes a namespace |

:::note
Namespaces must be created via the [Azion API](https://api.azion.com/) or Console before they can be used in Functions. You cannot create namespaces from within Functions.
:::

## Supported value types

KV Store supports the following value types:

| Type | Description |
|------|-------------|
| `string` | Text data (UTF-8 encoded) |
| `object` | JSON-serializable objects (automatically stringified) |
| `ArrayBuffer` | Binary data |
| `ReadableStream` | Streaming data for large values |

## Limits

| Limit | Value |
|-------|-------|
| Key size | Up to 512 bytes (UTF-8) |
| Value size | Up to 25 MB per item |
| Metadata size | Up to 1024 bytes (JSON-serialized) |
| Per-key write rate | Up to 1 write per second to the same key |
| Minimum `expirationTtl` | 60 seconds |
| Minimum `cacheTtl` | 60 seconds |

## Eventual consistency

KV Store uses eventual consistency. Writes are immediately visible to other
requests in the same global network location, but can take up to 60 seconds
(or the value of the `cacheTtl` parameter) to be visible in other locations.

## Related documentation

- [KV Store reference](/en/documentation/products/store/kv-store/)
- [How to manage KV Store with Functions](/en/documentation/products/guides/kv-store/manage-with-functions/)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
---
title: Delete key-value pairs
description: >-
To remove a key-value pair from KV Store, call the delete() method on your
KV instance.
meta_tags: 'kv store, api, functions, delete, remove, storage'
namespace: documentation_runtime_kv_store_delete
permalink: /documentation/runtime/api-reference/kv-store/delete/
menu_namespace: runtimeMenu
---

To remove a key-value pair from KV Store, call the `delete()` method on your
KV instance:

```javascript
await kv.delete(key);
```

## Example

An example of deleting a key-value pair from within a Function:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

try {
await kv.delete("user-session");

return new Response("Key deleted successfully", { status: 200 });
} catch (e) {
return new Response(e.message, { status: 500 });
}
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

---

## Reference

### `delete()` method

To remove a key-value pair, call the `delete()` method on your KV instance:

```javascript
await kv.delete(key);
```

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `key` | `string` | The key of the KV pair to delete. |

#### Response

| Response | Type | Description |
|----------|------|-------------|
| `response` | `Promise<void>` | A Promise that resolves when the deletion is complete. |

The `delete()` method returns a Promise that you should `await` to verify
successful deletion.

---

## Guidance

### Deleting non-existent keys

Deleting a key that doesn't exist will not throw an error. The operation
completes successfully regardless of whether the key existed:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

// This will succeed even if the key doesn't exist
await kv.delete("non-existent-key");

return new Response("Delete operation completed", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Eventual consistency

Like all KV Store operations, deletions are eventually consistent. After
deleting a key:

- The deletion is immediately visible in the same global network location.
- Other locations may still see the old value for up to 60 seconds (or the
duration of any `cacheTtl` that was set when reading the key).

### Conditional deletion

You may want to check if a key exists before deleting it, or perform
additional logic:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();
const key = "user-session";

// Check if key exists before deleting
const value = await kv.get(key, "text");

if (value === null) {
return new Response("Key not found", { status: 404 });
}

// Perform deletion
await kv.delete(key);

return new Response("Key deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting multiple keys

To delete multiple keys, you can use `Promise.all()`:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

const keysToDelete = ["key1", "key2", "key3"];

await Promise.all(keysToDelete.map(key => kv.delete(key)));

return new Response("All keys deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting namespaces

To delete an entire namespace (not just a key), use the static
`Azion.KV.delete()` method:

```javascript
async function handleRequest(request) {
const namespaceName = "my-namespace";

// Delete the entire namespace
await Azion.KV.delete(namespaceName);

return new Response("Namespace deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

:::caution
Deleting a namespace removes all key-value pairs within it. This operation
cannot be undone.
:::

---

## Related

- [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/)
- [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/)
- [KV Store API overview](/en/documentation/runtime/api-reference/kv-store/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
title: KV Store API
description: >-
The KV Store API provides methods to store, retrieve, and delete key-value
pairs from within your Functions.
meta_tags: 'kv store, api, functions, key-value, storage'
namespace: documentation_runtime_kv_store_api
permalink: /documentation/runtime/api-reference/kv-store/
menu_namespace: runtimeMenu
---

The KV Store API allows your Functions to interact with Azion's distributed
key-value storage directly from the runtime. This enables low-latency data
persistence and retrieval without external API calls.

## Initializing the KV client

You can initialize the KV client using the constructor or the `open` method:

```javascript
// Using the default namespace
const kv = new Azion.KV();

// Using a specific namespace
const kv = new Azion.KV("my-namespace");

// Using the open method (async)
const kv = await Azion.KV.open("my-namespace");
```

## Available methods

The `Azion.KV` class provides the following methods for data operations:

| Method | Description | Reference |
|--------|-------------|-----------|
| `put(key, value, options?)` | Store a key-value pair | [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/) |
| `get(key, type?, options?)` | Retrieve a value by key | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `getWithMetadata(key, type?, options?)` | Retrieve a value with its metadata | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `delete(key)` | Delete a key-value pair | [Delete key-value pairs](/en/documentation/runtime/api-reference/kv-store/delete/) |

## Namespace management

| Method | Description |
|--------|-------------|
| `new Azion.KV()` | Creates a KV instance using the default namespace |
| `new Azion.KV(name)` | Creates a KV instance for the specified namespace |
| `Azion.KV.open(name)` | Opens a namespace asynchronously |
| `Azion.KV.delete(name)` | Deletes a namespace |

:::note
Namespaces must be created via the [Azion API](https://api.azion.com/) or Console before they can be used in Functions. You cannot create namespaces from within Functions.
:::

## Supported value types

KV Store supports the following value types:

| Type | Description |
|------|-------------|
| `string` | Text data (UTF-8 encoded) |
| `object` | JSON-serializable objects (automatically stringified) |
| `ArrayBuffer` | Binary data |
| `ReadableStream` | Streaming data for large values |

## Limits

| Limit | Value |
|-------|-------|
| Key size | Up to 512 bytes (UTF-8) |
| Value size | Up to 25 MB per item |
| Metadata size | Up to 1024 bytes (JSON-serialized) |
| Per-key write rate | Up to 1 write per second to the same key |
| Minimum `expirationTtl` | 60 seconds |
| Minimum `cacheTtl` | 60 seconds |

## Eventual consistency

KV Store uses eventual consistency. Writes are immediately visible to other
requests in the same global network location, but can take up to 60 seconds
(or the value of the `cacheTtl` parameter) to be visible in other locations.

## Related documentation

- [KV Store reference](/en/documentation/products/store/kv-store/)
- [How to manage KV Store with Functions](/en/documentation/products/guides/kv-store/manage-with-functions/)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
---
title: Delete key-value pairs
description: >-
To remove a key-value pair from KV Store, call the delete() method on your
KV instance.
meta_tags: 'kv store, api, functions, delete, remove, storage'
namespace: documentation_runtime_kv_store_delete
permalink: /documentation/runtime/api-reference/kv-store/delete/
menu_namespace: runtimeMenu
---

To remove a key-value pair from KV Store, call the `delete()` method on your
KV instance:

```javascript
await kv.delete(key);
```

## Example

An example of deleting a key-value pair from within a Function:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

try {
await kv.delete("user-session");

return new Response("Key deleted successfully", { status: 200 });
} catch (e) {
return new Response(e.message, { status: 500 });
}
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

---

## Reference

### `delete()` method

To remove a key-value pair, call the `delete()` method on your KV instance:

```javascript
await kv.delete(key);
```

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `key` | `string` | The key of the KV pair to delete. |

#### Response

| Response | Type | Description |
|----------|------|-------------|
| `response` | `Promise<void>` | A Promise that resolves when the deletion is complete. |

The `delete()` method returns a Promise that you should `await` to verify
successful deletion.

---

## Guidance

### Deleting non-existent keys

Deleting a key that doesn't exist will not throw an error. The operation
completes successfully regardless of whether the key existed:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

// This will succeed even if the key doesn't exist
await kv.delete("non-existent-key");

return new Response("Delete operation completed", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Eventual consistency

Like all KV Store operations, deletions are eventually consistent. After
deleting a key:

- The deletion is immediately visible in the same global network location.
- Other locations may still see the old value for up to 60 seconds (or the
duration of any `cacheTtl` that was set when reading the key).

### Conditional deletion

You may want to check if a key exists before deleting it, or perform
additional logic:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();
const key = "user-session";

// Check if key exists before deleting
const value = await kv.get(key, "text");

if (value === null) {
return new Response("Key not found", { status: 404 });
}

// Perform deletion
await kv.delete(key);

return new Response("Key deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting multiple keys

To delete multiple keys, you can use `Promise.all()`:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

const keysToDelete = ["key1", "key2", "key3"];

await Promise.all(keysToDelete.map(key => kv.delete(key)));

return new Response("All keys deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting namespaces

To delete an entire namespace (not just a key), use the static
`Azion.KV.delete()` method:

```javascript
async function handleRequest(request) {
const namespaceName = "my-namespace";

// Delete the entire namespace
await Azion.KV.delete(namespaceName);

return new Response("Namespace deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

:::caution
Deleting a namespace removes all key-value pairs within it. This operation
cannot be undone.
:::

---

## Related

- [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/)
- [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/)
- [KV Store API overview](/en/documentation/runtime/api-reference/kv-store/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
title: KV Store API
description: >-
The KV Store API provides methods to store, retrieve, and delete key-value
pairs from within your Functions.
meta_tags: 'kv store, api, functions, key-value, storage'
namespace: documentation_runtime_kv_store_api
permalink: /documentation/runtime/api-reference/kv-store/
menu_namespace: runtimeMenu
---

The KV Store API allows your Functions to interact with Azion's distributed
key-value storage directly from the runtime. This enables low-latency data
persistence and retrieval without external API calls.

## Initializing the KV client

You can initialize the KV client using the constructor or the `open` method:

```javascript
// Using the default namespace
const kv = new Azion.KV();

// Using a specific namespace
const kv = new Azion.KV("my-namespace");

// Using the open method (async)
const kv = await Azion.KV.open("my-namespace");
```

## Available methods

The `Azion.KV` class provides the following methods for data operations:

| Method | Description | Reference |
|--------|-------------|-----------|
| `put(key, value, options?)` | Store a key-value pair | [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/) |
| `get(key, type?, options?)` | Retrieve a value by key | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `getWithMetadata(key, type?, options?)` | Retrieve a value with its metadata | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `delete(key)` | Delete a key-value pair | [Delete key-value pairs](/en/documentation/runtime/api-reference/kv-store/delete/) |

## Namespace management

| Method | Description |
|--------|-------------|
| `new Azion.KV()` | Creates a KV instance using the default namespace |
| `new Azion.KV(name)` | Creates a KV instance for the specified namespace |
| `Azion.KV.open(name)` | Opens a namespace asynchronously |
| `Azion.KV.delete(name)` | Deletes a namespace |

:::note
Namespaces must be created via the [Azion API](https://api.azion.com/) or Console before they can be used in Functions. You cannot create namespaces from within Functions.
:::

## Supported value types

KV Store supports the following value types:

| Type | Description |
|------|-------------|
| `string` | Text data (UTF-8 encoded) |
| `object` | JSON-serializable objects (automatically stringified) |
| `ArrayBuffer` | Binary data |
| `ReadableStream` | Streaming data for large values |

## Limits

| Limit | Value |
|-------|-------|
| Key size | Up to 512 bytes (UTF-8) |
| Value size | Up to 25 MB per item |
| Metadata size | Up to 1024 bytes (JSON-serialized) |
| Per-key write rate | Up to 1 write per second to the same key |
| Minimum `expirationTtl` | 60 seconds |
| Minimum `cacheTtl` | 60 seconds |

## Eventual consistency

KV Store uses eventual consistency. Writes are immediately visible to other
requests in the same global network location, but can take up to 60 seconds
(or the value of the `cacheTtl` parameter) to be visible in other locations.

## Related documentation

- [KV Store reference](/en/documentation/products/store/kv-store/)
- [How to manage KV Store with Functions](/en/documentation/products/guides/kv-store/manage-with-functions/)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
---
title: Delete key-value pairs
description: >-
To remove a key-value pair from KV Store, call the delete() method on your
KV instance.
meta_tags: 'kv store, api, functions, delete, remove, storage'
namespace: documentation_runtime_kv_store_delete
permalink: /documentation/runtime/api-reference/kv-store/delete/
menu_namespace: runtimeMenu
---

To remove a key-value pair from KV Store, call the `delete()` method on your
KV instance:

```javascript
await kv.delete(key);
```

## Example

An example of deleting a key-value pair from within a Function:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

try {
await kv.delete("user-session");

return new Response("Key deleted successfully", { status: 200 });
} catch (e) {
return new Response(e.message, { status: 500 });
}
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

---

## Reference

### `delete()` method

To remove a key-value pair, call the `delete()` method on your KV instance:

```javascript
await kv.delete(key);
```

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `key` | `string` | The key of the KV pair to delete. |

#### Response

| Response | Type | Description |
|----------|------|-------------|
| `response` | `Promise<void>` | A Promise that resolves when the deletion is complete. |

The `delete()` method returns a Promise that you should `await` to verify
successful deletion.

---

## Guidance

### Deleting non-existent keys

Deleting a key that doesn't exist will not throw an error. The operation
completes successfully regardless of whether the key existed:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

// This will succeed even if the key doesn't exist
await kv.delete("non-existent-key");

return new Response("Delete operation completed", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Eventual consistency

Like all KV Store operations, deletions are eventually consistent. After
deleting a key:

- The deletion is immediately visible in the same global network location.
- Other locations may still see the old value for up to 60 seconds (or the
duration of any `cacheTtl` that was set when reading the key).

### Conditional deletion

You may want to check if a key exists before deleting it, or perform
additional logic:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();
const key = "user-session";

// Check if key exists before deleting
const value = await kv.get(key, "text");

if (value === null) {
return new Response("Key not found", { status: 404 });
}

// Perform deletion
await kv.delete(key);

return new Response("Key deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting multiple keys

To delete multiple keys, you can use `Promise.all()`:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

const keysToDelete = ["key1", "key2", "key3"];

await Promise.all(keysToDelete.map(key => kv.delete(key)));

return new Response("All keys deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting namespaces

To delete an entire namespace (not just a key), use the static
`Azion.KV.delete()` method:

```javascript
async function handleRequest(request) {
const namespaceName = "my-namespace";

// Delete the entire namespace
await Azion.KV.delete(namespaceName);

return new Response("Namespace deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

:::caution
Deleting a namespace removes all key-value pairs within it. This operation
cannot be undone.
:::

---

## Related

- [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/)
- [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/)
- [KV Store API overview](/en/documentation/runtime/api-reference/kv-store/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
title: KV Store API
description: >-
The KV Store API provides methods to store, retrieve, and delete key-value
pairs from within your Functions.
meta_tags: 'kv store, api, functions, key-value, storage'
namespace: documentation_runtime_kv_store_api
permalink: /documentation/runtime/api-reference/kv-store/
menu_namespace: runtimeMenu
---

The KV Store API allows your Functions to interact with Azion's distributed
key-value storage directly from the runtime. This enables low-latency data
persistence and retrieval without external API calls.

## Initializing the KV client

You can initialize the KV client using the constructor or the `open` method:

```javascript
// Using the default namespace
const kv = new Azion.KV();

// Using a specific namespace
const kv = new Azion.KV("my-namespace");

// Using the open method (async)
const kv = await Azion.KV.open("my-namespace");
```

## Available methods

The `Azion.KV` class provides the following methods for data operations:

| Method | Description | Reference |
|--------|-------------|-----------|
| `put(key, value, options?)` | Store a key-value pair | [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/) |
| `get(key, type?, options?)` | Retrieve a value by key | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `getWithMetadata(key, type?, options?)` | Retrieve a value with its metadata | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `delete(key)` | Delete a key-value pair | [Delete key-value pairs](/en/documentation/runtime/api-reference/kv-store/delete/) |

## Namespace management

| Method | Description |
|--------|-------------|
| `new Azion.KV()` | Creates a KV instance using the default namespace |
| `new Azion.KV(name)` | Creates a KV instance for the specified namespace |
| `Azion.KV.open(name)` | Opens a namespace asynchronously |
| `Azion.KV.delete(name)` | Deletes a namespace |

:::note
Namespaces must be created via the [Azion API](https://api.azion.com/) or Console before they can be used in Functions. You cannot create namespaces from within Functions.
:::

## Supported value types

KV Store supports the following value types:

| Type | Description |
|------|-------------|
| `string` | Text data (UTF-8 encoded) |
| `object` | JSON-serializable objects (automatically stringified) |
| `ArrayBuffer` | Binary data |
| `ReadableStream` | Streaming data for large values |

## Limits

| Limit | Value |
|-------|-------|
| Key size | Up to 512 bytes (UTF-8) |
| Value size | Up to 25 MB per item |
| Metadata size | Up to 1024 bytes (JSON-serialized) |
| Per-key write rate | Up to 1 write per second to the same key |
| Minimum `expirationTtl` | 60 seconds |
| Minimum `cacheTtl` | 60 seconds |

## Eventual consistency

KV Store uses eventual consistency. Writes are immediately visible to other
requests in the same global network location, but can take up to 60 seconds
(or the value of the `cacheTtl` parameter) to be visible in other locations.

## Related documentation

- [KV Store reference](/en/documentation/products/store/kv-store/)
- [How to manage KV Store with Functions](/en/documentation/products/guides/kv-store/manage-with-functions/)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
---
title: Delete key-value pairs
description: >-
To remove a key-value pair from KV Store, call the delete() method on your
KV instance.
meta_tags: 'kv store, api, functions, delete, remove, storage'
namespace: documentation_runtime_kv_store_delete
permalink: /documentation/runtime/api-reference/kv-store/delete/
menu_namespace: runtimeMenu
---

To remove a key-value pair from KV Store, call the `delete()` method on your
KV instance:

```javascript
await kv.delete(key);
```

## Example

An example of deleting a key-value pair from within a Function:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

try {
await kv.delete("user-session");

return new Response("Key deleted successfully", { status: 200 });
} catch (e) {
return new Response(e.message, { status: 500 });
}
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

---

## Reference

### `delete()` method

To remove a key-value pair, call the `delete()` method on your KV instance:

```javascript
await kv.delete(key);
```

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `key` | `string` | The key of the KV pair to delete. |

#### Response

| Response | Type | Description |
|----------|------|-------------|
| `response` | `Promise<void>` | A Promise that resolves when the deletion is complete. |

The `delete()` method returns a Promise that you should `await` to verify
successful deletion.

---

## Guidance

### Deleting non-existent keys

Deleting a key that doesn't exist will not throw an error. The operation
completes successfully regardless of whether the key existed:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

// This will succeed even if the key doesn't exist
await kv.delete("non-existent-key");

return new Response("Delete operation completed", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Eventual consistency

Like all KV Store operations, deletions are eventually consistent. After
deleting a key:

- The deletion is immediately visible in the same global network location.
- Other locations may still see the old value for up to 60 seconds (or the
duration of any `cacheTtl` that was set when reading the key).

### Conditional deletion

You may want to check if a key exists before deleting it, or perform
additional logic:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();
const key = "user-session";

// Check if key exists before deleting
const value = await kv.get(key, "text");

if (value === null) {
return new Response("Key not found", { status: 404 });
}

// Perform deletion
await kv.delete(key);

return new Response("Key deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting multiple keys

To delete multiple keys, you can use `Promise.all()`:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

const keysToDelete = ["key1", "key2", "key3"];

await Promise.all(keysToDelete.map(key => kv.delete(key)));

return new Response("All keys deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting namespaces

To delete an entire namespace (not just a key), use the static
`Azion.KV.delete()` method:

```javascript
async function handleRequest(request) {
const namespaceName = "my-namespace";

// Delete the entire namespace
await Azion.KV.delete(namespaceName);

return new Response("Namespace deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

:::caution
Deleting a namespace removes all key-value pairs within it. This operation
cannot be undone.
:::

---

## Related

- [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/)
- [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/)
- [KV Store API overview](/en/documentation/runtime/api-reference/kv-store/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
title: KV Store API
description: >-
The KV Store API provides methods to store, retrieve, and delete key-value
pairs from within your Functions.
meta_tags: 'kv store, api, functions, key-value, storage'
namespace: documentation_runtime_kv_store_api
permalink: /documentation/runtime/api-reference/kv-store/
menu_namespace: runtimeMenu
---

The KV Store API allows your Functions to interact with Azion's distributed
key-value storage directly from the runtime. This enables low-latency data
persistence and retrieval without external API calls.

## Initializing the KV client

You can initialize the KV client using the constructor or the `open` method:

```javascript
// Using the default namespace
const kv = new Azion.KV();

// Using a specific namespace
const kv = new Azion.KV("my-namespace");

// Using the open method (async)
const kv = await Azion.KV.open("my-namespace");
```

## Available methods

The `Azion.KV` class provides the following methods for data operations:

| Method | Description | Reference |
|--------|-------------|-----------|
| `put(key, value, options?)` | Store a key-value pair | [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/) |
| `get(key, type?, options?)` | Retrieve a value by key | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `getWithMetadata(key, type?, options?)` | Retrieve a value with its metadata | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `delete(key)` | Delete a key-value pair | [Delete key-value pairs](/en/documentation/runtime/api-reference/kv-store/delete/) |

## Namespace management

| Method | Description |
|--------|-------------|
| `new Azion.KV()` | Creates a KV instance using the default namespace |
| `new Azion.KV(name)` | Creates a KV instance for the specified namespace |
| `Azion.KV.open(name)` | Opens a namespace asynchronously |
| `Azion.KV.delete(name)` | Deletes a namespace |

:::note
Namespaces must be created via the [Azion API](https://api.azion.com/) or Console before they can be used in Functions. You cannot create namespaces from within Functions.
:::

## Supported value types

KV Store supports the following value types:

| Type | Description |
|------|-------------|
| `string` | Text data (UTF-8 encoded) |
| `object` | JSON-serializable objects (automatically stringified) |
| `ArrayBuffer` | Binary data |
| `ReadableStream` | Streaming data for large values |

## Limits

| Limit | Value |
|-------|-------|
| Key size | Up to 512 bytes (UTF-8) |
| Value size | Up to 25 MB per item |
| Metadata size | Up to 1024 bytes (JSON-serialized) |
| Per-key write rate | Up to 1 write per second to the same key |
| Minimum `expirationTtl` | 60 seconds |
| Minimum `cacheTtl` | 60 seconds |

## Eventual consistency

KV Store uses eventual consistency. Writes are immediately visible to other
requests in the same global network location, but can take up to 60 seconds
(or the value of the `cacheTtl` parameter) to be visible in other locations.

## Related documentation

- [KV Store reference](/en/documentation/products/store/kv-store/)
- [How to manage KV Store with Functions](/en/documentation/products/guides/kv-store/manage-with-functions/)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
---
title: Delete key-value pairs
description: >-
To remove a key-value pair from KV Store, call the delete() method on your
KV instance.
meta_tags: 'kv store, api, functions, delete, remove, storage'
namespace: documentation_runtime_kv_store_delete
permalink: /documentation/runtime/api-reference/kv-store/delete/
menu_namespace: runtimeMenu
---

To remove a key-value pair from KV Store, call the `delete()` method on your
KV instance:

```javascript
await kv.delete(key);
```

## Example

An example of deleting a key-value pair from within a Function:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

try {
await kv.delete("user-session");

return new Response("Key deleted successfully", { status: 200 });
} catch (e) {
return new Response(e.message, { status: 500 });
}
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

---

## Reference

### `delete()` method

To remove a key-value pair, call the `delete()` method on your KV instance:

```javascript
await kv.delete(key);
```

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `key` | `string` | The key of the KV pair to delete. |

#### Response

| Response | Type | Description |
|----------|------|-------------|
| `response` | `Promise<void>` | A Promise that resolves when the deletion is complete. |

The `delete()` method returns a Promise that you should `await` to verify
successful deletion.

---

## Guidance

### Deleting non-existent keys

Deleting a key that doesn't exist will not throw an error. The operation
completes successfully regardless of whether the key existed:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

// This will succeed even if the key doesn't exist
await kv.delete("non-existent-key");

return new Response("Delete operation completed", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Eventual consistency

Like all KV Store operations, deletions are eventually consistent. After
deleting a key:

- The deletion is immediately visible in the same global network location.
- Other locations may still see the old value for up to 60 seconds (or the
duration of any `cacheTtl` that was set when reading the key).

### Conditional deletion

You may want to check if a key exists before deleting it, or perform
additional logic:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();
const key = "user-session";

// Check if key exists before deleting
const value = await kv.get(key, "text");

if (value === null) {
return new Response("Key not found", { status: 404 });
}

// Perform deletion
await kv.delete(key);

return new Response("Key deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting multiple keys

To delete multiple keys, you can use `Promise.all()`:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

const keysToDelete = ["key1", "key2", "key3"];

await Promise.all(keysToDelete.map(key => kv.delete(key)));

return new Response("All keys deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting namespaces

To delete an entire namespace (not just a key), use the static
`Azion.KV.delete()` method:

```javascript
async function handleRequest(request) {
const namespaceName = "my-namespace";

// Delete the entire namespace
await Azion.KV.delete(namespaceName);

return new Response("Namespace deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

:::caution
Deleting a namespace removes all key-value pairs within it. This operation
cannot be undone.
:::

---

## Related

- [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/)
- [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/)
- [KV Store API overview](/en/documentation/runtime/api-reference/kv-store/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
title: KV Store API
description: >-
The KV Store API provides methods to store, retrieve, and delete key-value
pairs from within your Functions.
meta_tags: 'kv store, api, functions, key-value, storage'
namespace: documentation_runtime_kv_store_api
permalink: /documentation/runtime/api-reference/kv-store/
menu_namespace: runtimeMenu
---

The KV Store API allows your Functions to interact with Azion's distributed
key-value storage directly from the runtime. This enables low-latency data
persistence and retrieval without external API calls.

## Initializing the KV client

You can initialize the KV client using the constructor or the `open` method:

```javascript
// Using the default namespace
const kv = new Azion.KV();

// Using a specific namespace
const kv = new Azion.KV("my-namespace");

// Using the open method (async)
const kv = await Azion.KV.open("my-namespace");
```

## Available methods

The `Azion.KV` class provides the following methods for data operations:

| Method | Description | Reference |
|--------|-------------|-----------|
| `put(key, value, options?)` | Store a key-value pair | [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/) |
| `get(key, type?, options?)` | Retrieve a value by key | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `getWithMetadata(key, type?, options?)` | Retrieve a value with its metadata | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `delete(key)` | Delete a key-value pair | [Delete key-value pairs](/en/documentation/runtime/api-reference/kv-store/delete/) |

## Namespace management

| Method | Description |
|--------|-------------|
| `new Azion.KV()` | Creates a KV instance using the default namespace |
| `new Azion.KV(name)` | Creates a KV instance for the specified namespace |
| `Azion.KV.open(name)` | Opens a namespace asynchronously |
| `Azion.KV.delete(name)` | Deletes a namespace |

:::note
Namespaces must be created via the [Azion API](https://api.azion.com/) or Console before they can be used in Functions. You cannot create namespaces from within Functions.
:::

## Supported value types

KV Store supports the following value types:

| Type | Description |
|------|-------------|
| `string` | Text data (UTF-8 encoded) |
| `object` | JSON-serializable objects (automatically stringified) |
| `ArrayBuffer` | Binary data |
| `ReadableStream` | Streaming data for large values |

## Limits

| Limit | Value |
|-------|-------|
| Key size | Up to 512 bytes (UTF-8) |
| Value size | Up to 25 MB per item |
| Metadata size | Up to 1024 bytes (JSON-serialized) |
| Per-key write rate | Up to 1 write per second to the same key |
| Minimum `expirationTtl` | 60 seconds |
| Minimum `cacheTtl` | 60 seconds |

## Eventual consistency

KV Store uses eventual consistency. Writes are immediately visible to other
requests in the same global network location, but can take up to 60 seconds
(or the value of the `cacheTtl` parameter) to be visible in other locations.

## Related documentation

- [KV Store reference](/en/documentation/products/store/kv-store/)
- [How to manage KV Store with Functions](/en/documentation/products/guides/kv-store/manage-with-functions/)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
---
title: Delete key-value pairs
description: >-
To remove a key-value pair from KV Store, call the delete() method on your
KV instance.
meta_tags: 'kv store, api, functions, delete, remove, storage'
namespace: documentation_runtime_kv_store_delete
permalink: /documentation/runtime/api-reference/kv-store/delete/
menu_namespace: runtimeMenu
---

To remove a key-value pair from KV Store, call the `delete()` method on your
KV instance:

```javascript
await kv.delete(key);
```

## Example

An example of deleting a key-value pair from within a Function:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

try {
await kv.delete("user-session");

return new Response("Key deleted successfully", { status: 200 });
} catch (e) {
return new Response(e.message, { status: 500 });
}
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

---

## Reference

### `delete()` method

To remove a key-value pair, call the `delete()` method on your KV instance:

```javascript
await kv.delete(key);
```

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `key` | `string` | The key of the KV pair to delete. |

#### Response

| Response | Type | Description |
|----------|------|-------------|
| `response` | `Promise<void>` | A Promise that resolves when the deletion is complete. |

The `delete()` method returns a Promise that you should `await` to verify
successful deletion.

---

## Guidance

### Deleting non-existent keys

Deleting a key that doesn't exist will not throw an error. The operation
completes successfully regardless of whether the key existed:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

// This will succeed even if the key doesn't exist
await kv.delete("non-existent-key");

return new Response("Delete operation completed", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Eventual consistency

Like all KV Store operations, deletions are eventually consistent. After
deleting a key:

- The deletion is immediately visible in the same global network location.
- Other locations may still see the old value for up to 60 seconds (or the
duration of any `cacheTtl` that was set when reading the key).

### Conditional deletion

You may want to check if a key exists before deleting it, or perform
additional logic:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();
const key = "user-session";

// Check if key exists before deleting
const value = await kv.get(key, "text");

if (value === null) {
return new Response("Key not found", { status: 404 });
}

// Perform deletion
await kv.delete(key);

return new Response("Key deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting multiple keys

To delete multiple keys, you can use `Promise.all()`:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

const keysToDelete = ["key1", "key2", "key3"];

await Promise.all(keysToDelete.map(key => kv.delete(key)));

return new Response("All keys deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting namespaces

To delete an entire namespace (not just a key), use the static
`Azion.KV.delete()` method:

```javascript
async function handleRequest(request) {
const namespaceName = "my-namespace";

// Delete the entire namespace
await Azion.KV.delete(namespaceName);

return new Response("Namespace deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

:::caution
Deleting a namespace removes all key-value pairs within it. This operation
cannot be undone.
:::

---

## Related

- [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/)
- [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/)
- [KV Store API overview](/en/documentation/runtime/api-reference/kv-store/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
title: KV Store API
description: >-
The KV Store API provides methods to store, retrieve, and delete key-value
pairs from within your Functions.
meta_tags: 'kv store, api, functions, key-value, storage'
namespace: documentation_runtime_kv_store_api
permalink: /documentation/runtime/api-reference/kv-store/
menu_namespace: runtimeMenu
---

The KV Store API allows your Functions to interact with Azion's distributed
key-value storage directly from the runtime. This enables low-latency data
persistence and retrieval without external API calls.

## Initializing the KV client

You can initialize the KV client using the constructor or the `open` method:

```javascript
// Using the default namespace
const kv = new Azion.KV();

// Using a specific namespace
const kv = new Azion.KV("my-namespace");

// Using the open method (async)
const kv = await Azion.KV.open("my-namespace");
```

## Available methods

The `Azion.KV` class provides the following methods for data operations:

| Method | Description | Reference |
|--------|-------------|-----------|
| `put(key, value, options?)` | Store a key-value pair | [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/) |
| `get(key, type?, options?)` | Retrieve a value by key | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `getWithMetadata(key, type?, options?)` | Retrieve a value with its metadata | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `delete(key)` | Delete a key-value pair | [Delete key-value pairs](/en/documentation/runtime/api-reference/kv-store/delete/) |

## Namespace management

| Method | Description |
|--------|-------------|
| `new Azion.KV()` | Creates a KV instance using the default namespace |
| `new Azion.KV(name)` | Creates a KV instance for the specified namespace |
| `Azion.KV.open(name)` | Opens a namespace asynchronously |
| `Azion.KV.delete(name)` | Deletes a namespace |

:::note
Namespaces must be created via the [Azion API](https://api.azion.com/) or Console before they can be used in Functions. You cannot create namespaces from within Functions.
:::

## Supported value types

KV Store supports the following value types:

| Type | Description |
|------|-------------|
| `string` | Text data (UTF-8 encoded) |
| `object` | JSON-serializable objects (automatically stringified) |
| `ArrayBuffer` | Binary data |
| `ReadableStream` | Streaming data for large values |

## Limits

| Limit | Value |
|-------|-------|
| Key size | Up to 512 bytes (UTF-8) |
| Value size | Up to 25 MB per item |
| Metadata size | Up to 1024 bytes (JSON-serialized) |
| Per-key write rate | Up to 1 write per second to the same key |
| Minimum `expirationTtl` | 60 seconds |
| Minimum `cacheTtl` | 60 seconds |

## Eventual consistency

KV Store uses eventual consistency. Writes are immediately visible to other
requests in the same global network location, but can take up to 60 seconds
(or the value of the `cacheTtl` parameter) to be visible in other locations.

## Related documentation

- [KV Store reference](/en/documentation/products/store/kv-store/)
- [How to manage KV Store with Functions](/en/documentation/products/guides/kv-store/manage-with-functions/)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
---
title: Delete key-value pairs
description: >-
To remove a key-value pair from KV Store, call the delete() method on your
KV instance.
meta_tags: 'kv store, api, functions, delete, remove, storage'
namespace: documentation_runtime_kv_store_delete
permalink: /documentation/runtime/api-reference/kv-store/delete/
menu_namespace: runtimeMenu
---

To remove a key-value pair from KV Store, call the `delete()` method on your
KV instance:

```javascript
await kv.delete(key);
```

## Example

An example of deleting a key-value pair from within a Function:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

try {
await kv.delete("user-session");

return new Response("Key deleted successfully", { status: 200 });
} catch (e) {
return new Response(e.message, { status: 500 });
}
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

---

## Reference

### `delete()` method

To remove a key-value pair, call the `delete()` method on your KV instance:

```javascript
await kv.delete(key);
```

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `key` | `string` | The key of the KV pair to delete. |

#### Response

| Response | Type | Description |
|----------|------|-------------|
| `response` | `Promise<void>` | A Promise that resolves when the deletion is complete. |

The `delete()` method returns a Promise that you should `await` to verify
successful deletion.

---

## Guidance

### Deleting non-existent keys

Deleting a key that doesn't exist will not throw an error. The operation
completes successfully regardless of whether the key existed:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

// This will succeed even if the key doesn't exist
await kv.delete("non-existent-key");

return new Response("Delete operation completed", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Eventual consistency

Like all KV Store operations, deletions are eventually consistent. After
deleting a key:

- The deletion is immediately visible in the same global network location.
- Other locations may still see the old value for up to 60 seconds (or the
duration of any `cacheTtl` that was set when reading the key).

### Conditional deletion

You may want to check if a key exists before deleting it, or perform
additional logic:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();
const key = "user-session";

// Check if key exists before deleting
const value = await kv.get(key, "text");

if (value === null) {
return new Response("Key not found", { status: 404 });
}

// Perform deletion
await kv.delete(key);

return new Response("Key deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting multiple keys

To delete multiple keys, you can use `Promise.all()`:

```javascript
async function handleRequest(request) {
const kv = new Azion.KV();

const keysToDelete = ["key1", "key2", "key3"];

await Promise.all(keysToDelete.map(key => kv.delete(key)));

return new Response("All keys deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

### Deleting namespaces

To delete an entire namespace (not just a key), use the static
`Azion.KV.delete()` method:

```javascript
async function handleRequest(request) {
const namespaceName = "my-namespace";

// Delete the entire namespace
await Azion.KV.delete(namespaceName);

return new Response("Namespace deleted", { status: 200 });
}

addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
```

:::caution
Deleting a namespace removes all key-value pairs within it. This operation
cannot be undone.
:::

---

## Related

- [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/)
- [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/)
- [KV Store API overview](/en/documentation/runtime/api-reference/kv-store/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
title: KV Store API
description: >-
The KV Store API provides methods to store, retrieve, and delete key-value
pairs from within your Functions.
meta_tags: 'kv store, api, functions, key-value, storage'
namespace: documentation_runtime_kv_store_api
permalink: /documentation/runtime/api-reference/kv-store/
menu_namespace: runtimeMenu
---

The KV Store API allows your Functions to interact with Azion's distributed
key-value storage directly from the runtime. This enables low-latency data
persistence and retrieval without external API calls.

## Initializing the KV client

You can initialize the KV client using the constructor or the `open` method:

```javascript
// Using the default namespace
const kv = new Azion.KV();

// Using a specific namespace
const kv = new Azion.KV("my-namespace");

// Using the open method (async)
const kv = await Azion.KV.open("my-namespace");
```

## Available methods

The `Azion.KV` class provides the following methods for data operations:

| Method | Description | Reference |
|--------|-------------|-----------|
| `put(key, value, options?)` | Store a key-value pair | [Write key-value pairs](/en/documentation/runtime/api-reference/kv-store/write/) |
| `get(key, type?, options?)` | Retrieve a value by key | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `getWithMetadata(key, type?, options?)` | Retrieve a value with its metadata | [Read key-value pairs](/en/documentation/runtime/api-reference/kv-store/read/) |
| `delete(key)` | Delete a key-value pair | [Delete key-value pairs](/en/documentation/runtime/api-reference/kv-store/delete/) |

## Namespace management

| Method | Description |
|--------|-------------|
| `new Azion.KV()` | Creates a KV instance using the default namespace |
| `new Azion.KV(name)` | Creates a KV instance for the specified namespace |
| `Azion.KV.open(name)` | Opens a namespace asynchronously |
| `Azion.KV.delete(name)` | Deletes a namespace |

:::note
Namespaces must be created via the [Azion API](https://api.azion.com/) or Console before they can be used in Functions. You cannot create namespaces from within Functions.
:::

## Supported value types

KV Store supports the following value types:

| Type | Description |
|------|-------------|
| `string` | Text data (UTF-8 encoded) |
| `object` | JSON-serializable objects (automatically stringified) |
| `ArrayBuffer` | Binary data |
| `ReadableStream` | Streaming data for large values |

## Limits

| Limit | Value |
|-------|-------|
| Key size | Up to 512 bytes (UTF-8) |
| Value size | Up to 25 MB per item |
| Metadata size | Up to 1024 bytes (JSON-serialized) |
| Per-key write rate | Up to 1 write per second to the same key |
| Minimum `expirationTtl` | 60 seconds |
| Minimum `cacheTtl` | 60 seconds |

## Eventual consistency

KV Store uses eventual consistency. Writes are immediately visible to other
requests in the same global network location, but can take up to 60 seconds
(or the value of the `cacheTtl` parameter) to be visible in other locations.

## Related documentation

- [KV Store reference](/en/documentation/products/store/kv-store/)
- [How to manage KV Store with Functions](/en/documentation/products/guides/kv-store/manage-with-functions/)
Loading