[EDU-6737]feat:kv store documentation - #2019

Merged
egermano merged 17 commits into
mainfrom
EDU-6737-feat-kv-store-documentation
May 21, 2026
Merged

[EDU-6737]feat:kv store documentation#2019
egermano merged 17 commits into
mainfrom
EDU-6737-feat-kv-store-documentation

Conversation

@vitor-eltz-azion

@vitor-eltz-azionvitor-eltz-azion commented Feb 10, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

PR Description

Title

docs: Add comprehensive KV Store documentation with examples, API reference, and Redis compatibility guide

Summary

This PR introduces complete documentation for the KV Store product, including reference documentation, practical guides, and API reference in both English and Portuguese. The documentation is inspired by Cloudflare's KV documentation structure for familiarity and ease of use.

Changes

New Files (16)

Reference Documentation (EN/PT-BR)

  • src/content/docs/en/pages/main-menu/reference/store/kv-store/kv-store.mdx
  • src/content/docs/pt-br/pages/menu-principal/referencia/store/kv-store/kv-store.mdx

Guides (EN/PT-BR)

  • src/content/docs/en/pages/guides/kv-store/manage-data.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/gerenciar-com-funcoes.mdx
  • src/content/docs/en/pages/guides/kv-store/redis-compatibility.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/compatibilidade-redis.mdx

API Reference (EN)

  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx

API Reference (PT-BR)

  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx

Content Added

Reference Documentation

  • Product overview and use cases
  • Cloudflare Workers KV API compatibility mention
  • How it works (namespaces, keys, value types)
  • Data resilience architecture
  • Namespace management via API (create, list, retrieve)
  • Complete Azion.KV class reference with all methods
  • Put options (metadata, expiration, expirationTtl)
  • Get options (cacheTtl)
  • Get types (text, json, arrayBuffer, stream)
  • Service plan limits table
  • Minimum TTL values (60 seconds for both expirationTtl and cacheTtl)
  • Limitations section (no list(), no multi-key transactions, namespace management via API only)

Guide Documentation

  • Step-by-step function creation
  • Storing data (string, JSON, with options)
  • Retrieving data (single key, multiple keys, with metadata)
  • Deleting data
  • Working with binary data (ArrayBuffer)
  • Working with streams (ReadableStream)
  • Using specific namespaces for data isolation

Redis Compatibility Guide (NEW)

  • Installation of azion SDK package
  • Redis-like client pattern with createClient()
  • Event-based error handling
  • Hash operations (hSet, hGetAll, hVals)
  • Provider detection (native vs API)
  • Complete Redis method mapping table

API Reference (Cloudflare-inspired structure)

  • index.mdx: Overview, initialization, available methods, limits
  • write.mdx: put() method with parameters, options, examples, guidance on expiration and metadata
  • read.mdx: get() and getWithMetadata() methods with type options, cacheTtl, single/multiple key retrieval
  • delete.mdx: delete() method with namespace deletion

Code Examples

20+ working JavaScript examples covering:

  • kv.put() with strings, objects, ArrayBuffer, and streams
  • kv.get() with different return types (text, json, arrayBuffer, stream)
  • kv.getWithMetadata() for value + metadata retrieval
  • kv.delete() for key removal
  • Namespace initialization (new Azion.KV(), Azion.KV.open())
  • Namespace deletion (Azion.KV.delete())
  • Redis-compatible SDK usage (createClient(), hSet, hGetAll, hVals)

Terminology Updates

  • Removed "Edge" terminology throughout (Edge Functions → Functions, Edge Application → Application)
  • Updated to align with current Azion product naming conventions

Related

LuizaVSantosand others added 10 commits August 28, 2025 12:30
@LuizaVSantos
feat: added kv store reference
a296930
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
dadc805
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestions from code review
0eb64ba
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
754fb72
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
335b94f
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
15917b4
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
152cf7d
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
2566c39
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion
Merge branch 'main' of github.com:aziontech/docs into kvstore-referemce
599a2be
@vitor-eltz-azion
docs: expand KV Store documentation with comprehensive examples and A…
df13fca
…PI reference
Add detailed usage examples for storing, retrieving, and deleting data in KV Store. Include examples for working with different data types (text, JSON, binary, streams), metadata handling, multiple key operations, and namespace management. Update guide structure with clearer sections and add API reference documentation for namespace and key management operations. Fix meta tags and namespace references.
@vitor-eltz-azion
vitor-eltz-azion requested a review from a team as a code ownerFebruary 10, 2026 16:39
@vitor-eltz-azionvitor-eltz-azion added the do not merge Waiting for decision or deploy label Feb 10, 2026
@vitor-eltz-azion
docs: add KV Store API reference documentation with read, write, and …
619c597
…delete operations
Add comprehensive API reference pages for KV Store operations including methods for reading key-value pairs (get, getWithMetadata), writing data (put), and deleting entries. Include detailed parameter descriptions, response types, usage examples, and guidance for handling different data types (text, JSON, binary, streams), metadata, multiple keys, and namespace management. Document eventual consistency behavior
@vitor-eltz-azion
docs: update KV Store namespace limits to 1000 across all service plans
7784d8a
Update namespace limits from varying values (10/50/200) to a unified limit of 1000 namespaces for all service plans (Developer, Business, Enterprise, and Mission Critical) in both English and Portuguese documentation.
gabriel-alves-azion
gabriel-alves-azion previously approved these changes May 7, 2026
View reviewed changes
@gabriel-alves-azion
gabriel-alves-azionforce-pushed the EDU-6737-feat-kv-store-documentation branch from 9546399 to 04a9152CompareMay 14, 2026 20:09
@gabriel-alves-aziongabriel-alves-azion added documentation Improvements or additions to documentation and removed do not merge Waiting for decision or deploy labels May 19, 2026
@egermano
egermano merged commit 47c784d into mainMay 21, 2026
3 checks passed
@egermano
egermano deleted the EDU-6737-feat-kv-store-documentation branch May 21, 2026 12:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

3 more reviewers
@egermanoegermanoegermano approved these changes
@VitorEltzVitorEltzVitorEltz approved these changes
@gabriel-alves-aziongabriel-alves-aziongabriel-alves-azion left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentationImprovements or additions to documentation

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@vitor-eltz-azion@egermano@VitorEltz@gabriel-alves-azion@LuizaVSantos
, '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
[EDU-6737]feat:kv store documentation - #2019
Merged
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
May 21, 2026
Merged
[EDU-6737]feat:kv store documentation#2019
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
Conversation
@vitor-eltz-azion
@vitor-eltz-azionvitor-eltz-azion
commented
Feb 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
PR Description
Title
docs: Add comprehensive KV Store documentation with examples, API reference, and Redis compatibility guide
Summary
This PR introduces complete documentation for the KV Store product, including reference documentation, practical guides, and API reference in both English and Portuguese. The documentation is inspired by Cloudflare's KV documentation structure for familiarity and ease of use.
Changes
New Files (16)
Reference Documentation (EN/PT-BR)
  • src/content/docs/en/pages/main-menu/reference/store/kv-store/kv-store.mdx
  • src/content/docs/pt-br/pages/menu-principal/referencia/store/kv-store/kv-store.mdx
Guides (EN/PT-BR)
  • src/content/docs/en/pages/guides/kv-store/manage-data.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/gerenciar-com-funcoes.mdx
  • src/content/docs/en/pages/guides/kv-store/redis-compatibility.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/compatibilidade-redis.mdx
API Reference (EN)
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
API Reference (PT-BR)
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
Content Added
Reference Documentation
  • Product overview and use cases
  • Cloudflare Workers KV API compatibility mention
  • How it works (namespaces, keys, value types)
  • Data resilience architecture
  • Namespace management via API (create, list, retrieve)
  • Complete Azion.KV class reference with all methods
  • Put options (metadata, expiration, expirationTtl)
  • Get options (cacheTtl)
  • Get types (text, json, arrayBuffer, stream)
  • Service plan limits table
  • Minimum TTL values (60 seconds for both expirationTtl and cacheTtl)
  • Limitations section (no list(), no multi-key transactions, namespace management via API only)
Guide Documentation
  • Step-by-step function creation
  • Storing data (string, JSON, with options)
  • Retrieving data (single key, multiple keys, with metadata)
  • Deleting data
  • Working with binary data (ArrayBuffer)
  • Working with streams (ReadableStream)
  • Using specific namespaces for data isolation
Redis Compatibility Guide (NEW)
  • Installation of azion SDK package
  • Redis-like client pattern with createClient()
  • Event-based error handling
  • Hash operations (hSet, hGetAll, hVals)
  • Provider detection (native vs API)
  • Complete Redis method mapping table
API Reference (Cloudflare-inspired structure)
  • index.mdx: Overview, initialization, available methods, limits
  • write.mdx: put() method with parameters, options, examples, guidance on expiration and metadata
  • read.mdx: get() and getWithMetadata() methods with type options, cacheTtl, single/multiple key retrieval
  • delete.mdx: delete() method with namespace deletion
Code Examples
20+ working JavaScript examples covering:
  • kv.put() with strings, objects, ArrayBuffer, and streams
  • kv.get() with different return types (text, json, arrayBuffer, stream)
  • kv.getWithMetadata() for value + metadata retrieval
  • kv.delete() for key removal
  • Namespace initialization (new Azion.KV(), Azion.KV.open())
  • Namespace deletion (Azion.KV.delete())
  • Redis-compatible SDK usage (createClient(), hSet, hGetAll, hVals)
Terminology Updates
  • Removed "Edge" terminology throughout (Edge Functions → Functions, Edge Application → Application)
  • Updated to align with current Azion product naming conventions
Related
LuizaVSantosand others
added 10 commits
August 28, 2025 12:30
@LuizaVSantos
feat: added kv store reference
a296930
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
dadc805
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestions from code review
0eb64ba
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
754fb72
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
335b94f
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
15917b4
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
152cf7d
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
2566c39
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion
Merge branch 'main' of github.com:aziontech/docs into kvstore-referemce
599a2be
@vitor-eltz-azion
docs: expand KV Store documentation with comprehensive examples and A…
df13fca
…PI reference
Add detailed usage examples for storing, retrieving, and deleting data in KV Store. Include examples for working with different data types (text, JSON, binary, streams), metadata handling, multiple key operations, and namespace management. Update guide structure with clearer sections and add API reference documentation for namespace and key management operations. Fix meta tags and namespace references.
@vitor-eltz-azion
vitor-eltz-azion
requested a review
from a team
as a code ownerFebruary 10, 2026 16:39
@vitor-eltz-azionvitor-eltz-azion
added
the 
do not merge
Waiting for decision or deploy
label
Feb 10, 2026
@vitor-eltz-azion
docs: add KV Store API reference documentation with read, write, and …
619c597
…delete operations
Add comprehensive API reference pages for KV Store operations including methods for reading key-value pairs (get, getWithMetadata), writing data (put), and deleting entries. Include detailed parameter descriptions, response types, usage examples, and guidance for handling different data types (text, JSON, binary, streams), metadata, multiple keys, and namespace management. Document eventual consistency behavior
@vitor-eltz-azion
docs: update KV Store namespace limits to 1000 across all service plans
7784d8a
Update namespace limits from varying values (10/50/200) to a unified limit of 1000 namespaces for all service plans (Developer, Business, Enterprise, and Mission Critical) in both English and Portuguese documentation.
gabriel-alves-azion
gabriel-alves-azion
previously approved these changes
May 7, 2026
View reviewed changes
@gabriel-alves-azion
gabriel-alves-azionforce-pushed
the
EDU-6737-feat-kv-store-documentation
branch
from
9546399 to
04a9152CompareMay 14, 2026 20:09
@gabriel-alves-aziongabriel-alves-azion
added

documentation
Improvements or additions to documentation
and removed

do not merge
Waiting for decision or deploy
labels
May 19, 2026
@egermano
egermano
merged commit 47c784d
into
mainMay 21, 2026

3 checks passed

@egermano
egermano
deleted the

EDU-6737-feat-kv-store-documentation

branch
May 21, 2026 12:13
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


3 more reviewers

@egermanoegermanoegermano approved these changes
@VitorEltzVitorEltzVitorEltz approved these changes
@gabriel-alves-aziongabriel-alves-aziongabriel-alves-azion left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

documentationImprovements or additions to documentation

Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@vitor-eltz-azion@egermano@VitorEltz@gabriel-alves-azion@LuizaVSantos

, '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
[EDU-6737]feat:kv store documentation - #2019
Merged
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
May 21, 2026
Merged
[EDU-6737]feat:kv store documentation#2019
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
Conversation
@vitor-eltz-azion
@vitor-eltz-azionvitor-eltz-azion
commented
Feb 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
PR Description
Title
docs: Add comprehensive KV Store documentation with examples, API reference, and Redis compatibility guide
Summary
This PR introduces complete documentation for the KV Store product, including reference documentation, practical guides, and API reference in both English and Portuguese. The documentation is inspired by Cloudflare's KV documentation structure for familiarity and ease of use.
Changes
New Files (16)
Reference Documentation (EN/PT-BR)
  • src/content/docs/en/pages/main-menu/reference/store/kv-store/kv-store.mdx
  • src/content/docs/pt-br/pages/menu-principal/referencia/store/kv-store/kv-store.mdx
Guides (EN/PT-BR)
  • src/content/docs/en/pages/guides/kv-store/manage-data.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/gerenciar-com-funcoes.mdx
  • src/content/docs/en/pages/guides/kv-store/redis-compatibility.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/compatibilidade-redis.mdx
API Reference (EN)
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
API Reference (PT-BR)
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
Content Added
Reference Documentation
  • Product overview and use cases
  • Cloudflare Workers KV API compatibility mention
  • How it works (namespaces, keys, value types)
  • Data resilience architecture
  • Namespace management via API (create, list, retrieve)
  • Complete Azion.KV class reference with all methods
  • Put options (metadata, expiration, expirationTtl)
  • Get options (cacheTtl)
  • Get types (text, json, arrayBuffer, stream)
  • Service plan limits table
  • Minimum TTL values (60 seconds for both expirationTtl and cacheTtl)
  • Limitations section (no list(), no multi-key transactions, namespace management via API only)
Guide Documentation
  • Step-by-step function creation
  • Storing data (string, JSON, with options)
  • Retrieving data (single key, multiple keys, with metadata)
  • Deleting data
  • Working with binary data (ArrayBuffer)
  • Working with streams (ReadableStream)
  • Using specific namespaces for data isolation
Redis Compatibility Guide (NEW)
  • Installation of azion SDK package
  • Redis-like client pattern with createClient()
  • Event-based error handling
  • Hash operations (hSet, hGetAll, hVals)
  • Provider detection (native vs API)
  • Complete Redis method mapping table
API Reference (Cloudflare-inspired structure)
  • index.mdx: Overview, initialization, available methods, limits
  • write.mdx: put() method with parameters, options, examples, guidance on expiration and metadata
  • read.mdx: get() and getWithMetadata() methods with type options, cacheTtl, single/multiple key retrieval
  • delete.mdx: delete() method with namespace deletion
Code Examples
20+ working JavaScript examples covering:
  • kv.put() with strings, objects, ArrayBuffer, and streams
  • kv.get() with different return types (text, json, arrayBuffer, stream)
  • kv.getWithMetadata() for value + metadata retrieval
  • kv.delete() for key removal
  • Namespace initialization (new Azion.KV(), Azion.KV.open())
  • Namespace deletion (Azion.KV.delete())
  • Redis-compatible SDK usage (createClient(), hSet, hGetAll, hVals)
Terminology Updates
  • Removed "Edge" terminology throughout (Edge Functions → Functions, Edge Application → Application)
  • Updated to align with current Azion product naming conventions
Related
LuizaVSantosand others
added 10 commits
August 28, 2025 12:30
@LuizaVSantos
feat: added kv store reference
a296930
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
dadc805
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestions from code review
0eb64ba
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
754fb72
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
335b94f
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
15917b4
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
152cf7d
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
2566c39
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion
Merge branch 'main' of github.com:aziontech/docs into kvstore-referemce
599a2be
@vitor-eltz-azion
docs: expand KV Store documentation with comprehensive examples and A…
df13fca
…PI reference
Add detailed usage examples for storing, retrieving, and deleting data in KV Store. Include examples for working with different data types (text, JSON, binary, streams), metadata handling, multiple key operations, and namespace management. Update guide structure with clearer sections and add API reference documentation for namespace and key management operations. Fix meta tags and namespace references.
@vitor-eltz-azion
vitor-eltz-azion
requested a review
from a team
as a code ownerFebruary 10, 2026 16:39
@vitor-eltz-azionvitor-eltz-azion
added
the 
do not merge
Waiting for decision or deploy
label
Feb 10, 2026
@vitor-eltz-azion
docs: add KV Store API reference documentation with read, write, and …
619c597
…delete operations
Add comprehensive API reference pages for KV Store operations including methods for reading key-value pairs (get, getWithMetadata), writing data (put), and deleting entries. Include detailed parameter descriptions, response types, usage examples, and guidance for handling different data types (text, JSON, binary, streams), metadata, multiple keys, and namespace management. Document eventual consistency behavior
@vitor-eltz-azion
docs: update KV Store namespace limits to 1000 across all service plans
7784d8a
Update namespace limits from varying values (10/50/200) to a unified limit of 1000 namespaces for all service plans (Developer, Business, Enterprise, and Mission Critical) in both English and Portuguese documentation.
gabriel-alves-azion
gabriel-alves-azion
previously approved these changes
May 7, 2026
View reviewed changes
@gabriel-alves-azion
gabriel-alves-azionforce-pushed
the
EDU-6737-feat-kv-store-documentation
branch
from
9546399 to
04a9152CompareMay 14, 2026 20:09
@gabriel-alves-aziongabriel-alves-azion
added

documentation
Improvements or additions to documentation
and removed

do not merge
Waiting for decision or deploy
labels
May 19, 2026
@egermano
egermano
merged commit 47c784d
into
mainMay 21, 2026

3 checks passed

@egermano
egermano
deleted the

EDU-6737-feat-kv-store-documentation

branch
May 21, 2026 12:13
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


3 more reviewers

@egermanoegermanoegermano approved these changes
@VitorEltzVitorEltzVitorEltz approved these changes
@gabriel-alves-aziongabriel-alves-aziongabriel-alves-azion left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

documentationImprovements or additions to documentation

Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@vitor-eltz-azion@egermano@VitorEltz@gabriel-alves-azion@LuizaVSantos

, '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
[EDU-6737]feat:kv store documentation - #2019
Merged
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
May 21, 2026
Merged
[EDU-6737]feat:kv store documentation#2019
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
Conversation
@vitor-eltz-azion
@vitor-eltz-azionvitor-eltz-azion
commented
Feb 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
PR Description
Title
docs: Add comprehensive KV Store documentation with examples, API reference, and Redis compatibility guide
Summary
This PR introduces complete documentation for the KV Store product, including reference documentation, practical guides, and API reference in both English and Portuguese. The documentation is inspired by Cloudflare's KV documentation structure for familiarity and ease of use.
Changes
New Files (16)
Reference Documentation (EN/PT-BR)
  • src/content/docs/en/pages/main-menu/reference/store/kv-store/kv-store.mdx
  • src/content/docs/pt-br/pages/menu-principal/referencia/store/kv-store/kv-store.mdx
Guides (EN/PT-BR)
  • src/content/docs/en/pages/guides/kv-store/manage-data.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/gerenciar-com-funcoes.mdx
  • src/content/docs/en/pages/guides/kv-store/redis-compatibility.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/compatibilidade-redis.mdx
API Reference (EN)
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
API Reference (PT-BR)
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
Content Added
Reference Documentation
  • Product overview and use cases
  • Cloudflare Workers KV API compatibility mention
  • How it works (namespaces, keys, value types)
  • Data resilience architecture
  • Namespace management via API (create, list, retrieve)
  • Complete Azion.KV class reference with all methods
  • Put options (metadata, expiration, expirationTtl)
  • Get options (cacheTtl)
  • Get types (text, json, arrayBuffer, stream)
  • Service plan limits table
  • Minimum TTL values (60 seconds for both expirationTtl and cacheTtl)
  • Limitations section (no list(), no multi-key transactions, namespace management via API only)
Guide Documentation
  • Step-by-step function creation
  • Storing data (string, JSON, with options)
  • Retrieving data (single key, multiple keys, with metadata)
  • Deleting data
  • Working with binary data (ArrayBuffer)
  • Working with streams (ReadableStream)
  • Using specific namespaces for data isolation
Redis Compatibility Guide (NEW)
  • Installation of azion SDK package
  • Redis-like client pattern with createClient()
  • Event-based error handling
  • Hash operations (hSet, hGetAll, hVals)
  • Provider detection (native vs API)
  • Complete Redis method mapping table
API Reference (Cloudflare-inspired structure)
  • index.mdx: Overview, initialization, available methods, limits
  • write.mdx: put() method with parameters, options, examples, guidance on expiration and metadata
  • read.mdx: get() and getWithMetadata() methods with type options, cacheTtl, single/multiple key retrieval
  • delete.mdx: delete() method with namespace deletion
Code Examples
20+ working JavaScript examples covering:
  • kv.put() with strings, objects, ArrayBuffer, and streams
  • kv.get() with different return types (text, json, arrayBuffer, stream)
  • kv.getWithMetadata() for value + metadata retrieval
  • kv.delete() for key removal
  • Namespace initialization (new Azion.KV(), Azion.KV.open())
  • Namespace deletion (Azion.KV.delete())
  • Redis-compatible SDK usage (createClient(), hSet, hGetAll, hVals)
Terminology Updates
  • Removed "Edge" terminology throughout (Edge Functions → Functions, Edge Application → Application)
  • Updated to align with current Azion product naming conventions
Related
LuizaVSantosand others
added 10 commits
August 28, 2025 12:30
@LuizaVSantos
feat: added kv store reference
a296930
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
dadc805
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestions from code review
0eb64ba
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
754fb72
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
335b94f
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
15917b4
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
152cf7d
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
2566c39
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion
Merge branch 'main' of github.com:aziontech/docs into kvstore-referemce
599a2be
@vitor-eltz-azion
docs: expand KV Store documentation with comprehensive examples and A…
df13fca
…PI reference
Add detailed usage examples for storing, retrieving, and deleting data in KV Store. Include examples for working with different data types (text, JSON, binary, streams), metadata handling, multiple key operations, and namespace management. Update guide structure with clearer sections and add API reference documentation for namespace and key management operations. Fix meta tags and namespace references.
@vitor-eltz-azion
vitor-eltz-azion
requested a review
from a team
as a code ownerFebruary 10, 2026 16:39
@vitor-eltz-azionvitor-eltz-azion
added
the 
do not merge
Waiting for decision or deploy
label
Feb 10, 2026
@vitor-eltz-azion
docs: add KV Store API reference documentation with read, write, and …
619c597
…delete operations
Add comprehensive API reference pages for KV Store operations including methods for reading key-value pairs (get, getWithMetadata), writing data (put), and deleting entries. Include detailed parameter descriptions, response types, usage examples, and guidance for handling different data types (text, JSON, binary, streams), metadata, multiple keys, and namespace management. Document eventual consistency behavior
@vitor-eltz-azion
docs: update KV Store namespace limits to 1000 across all service plans
7784d8a
Update namespace limits from varying values (10/50/200) to a unified limit of 1000 namespaces for all service plans (Developer, Business, Enterprise, and Mission Critical) in both English and Portuguese documentation.
gabriel-alves-azion
gabriel-alves-azion
previously approved these changes
May 7, 2026
View reviewed changes
@gabriel-alves-azion
gabriel-alves-azionforce-pushed
the
EDU-6737-feat-kv-store-documentation
branch
from
9546399 to
04a9152CompareMay 14, 2026 20:09
@gabriel-alves-aziongabriel-alves-azion
added

documentation
Improvements or additions to documentation
and removed

do not merge
Waiting for decision or deploy
labels
May 19, 2026
@egermano
egermano
merged commit 47c784d
into
mainMay 21, 2026

3 checks passed

@egermano
egermano
deleted the

EDU-6737-feat-kv-store-documentation

branch
May 21, 2026 12:13
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


3 more reviewers

@egermanoegermanoegermano approved these changes
@VitorEltzVitorEltzVitorEltz approved these changes
@gabriel-alves-aziongabriel-alves-aziongabriel-alves-azion left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

documentationImprovements or additions to documentation

Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@vitor-eltz-azion@egermano@VitorEltz@gabriel-alves-azion@LuizaVSantos

, '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
[EDU-6737]feat:kv store documentation - #2019
Merged
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
May 21, 2026
Merged
[EDU-6737]feat:kv store documentation#2019
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
Conversation
@vitor-eltz-azion
@vitor-eltz-azionvitor-eltz-azion
commented
Feb 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
PR Description
Title
docs: Add comprehensive KV Store documentation with examples, API reference, and Redis compatibility guide
Summary
This PR introduces complete documentation for the KV Store product, including reference documentation, practical guides, and API reference in both English and Portuguese. The documentation is inspired by Cloudflare's KV documentation structure for familiarity and ease of use.
Changes
New Files (16)
Reference Documentation (EN/PT-BR)
  • src/content/docs/en/pages/main-menu/reference/store/kv-store/kv-store.mdx
  • src/content/docs/pt-br/pages/menu-principal/referencia/store/kv-store/kv-store.mdx
Guides (EN/PT-BR)
  • src/content/docs/en/pages/guides/kv-store/manage-data.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/gerenciar-com-funcoes.mdx
  • src/content/docs/en/pages/guides/kv-store/redis-compatibility.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/compatibilidade-redis.mdx
API Reference (EN)
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
API Reference (PT-BR)
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
Content Added
Reference Documentation
  • Product overview and use cases
  • Cloudflare Workers KV API compatibility mention
  • How it works (namespaces, keys, value types)
  • Data resilience architecture
  • Namespace management via API (create, list, retrieve)
  • Complete Azion.KV class reference with all methods
  • Put options (metadata, expiration, expirationTtl)
  • Get options (cacheTtl)
  • Get types (text, json, arrayBuffer, stream)
  • Service plan limits table
  • Minimum TTL values (60 seconds for both expirationTtl and cacheTtl)
  • Limitations section (no list(), no multi-key transactions, namespace management via API only)
Guide Documentation
  • Step-by-step function creation
  • Storing data (string, JSON, with options)
  • Retrieving data (single key, multiple keys, with metadata)
  • Deleting data
  • Working with binary data (ArrayBuffer)
  • Working with streams (ReadableStream)
  • Using specific namespaces for data isolation
Redis Compatibility Guide (NEW)
  • Installation of azion SDK package
  • Redis-like client pattern with createClient()
  • Event-based error handling
  • Hash operations (hSet, hGetAll, hVals)
  • Provider detection (native vs API)
  • Complete Redis method mapping table
API Reference (Cloudflare-inspired structure)
  • index.mdx: Overview, initialization, available methods, limits
  • write.mdx: put() method with parameters, options, examples, guidance on expiration and metadata
  • read.mdx: get() and getWithMetadata() methods with type options, cacheTtl, single/multiple key retrieval
  • delete.mdx: delete() method with namespace deletion
Code Examples
20+ working JavaScript examples covering:
  • kv.put() with strings, objects, ArrayBuffer, and streams
  • kv.get() with different return types (text, json, arrayBuffer, stream)
  • kv.getWithMetadata() for value + metadata retrieval
  • kv.delete() for key removal
  • Namespace initialization (new Azion.KV(), Azion.KV.open())
  • Namespace deletion (Azion.KV.delete())
  • Redis-compatible SDK usage (createClient(), hSet, hGetAll, hVals)
Terminology Updates
  • Removed "Edge" terminology throughout (Edge Functions → Functions, Edge Application → Application)
  • Updated to align with current Azion product naming conventions
Related
LuizaVSantosand others
added 10 commits
August 28, 2025 12:30
@LuizaVSantos
feat: added kv store reference
a296930
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
dadc805
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestions from code review
0eb64ba
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
754fb72
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
335b94f
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
15917b4
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
152cf7d
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
2566c39
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion
Merge branch 'main' of github.com:aziontech/docs into kvstore-referemce
599a2be
@vitor-eltz-azion
docs: expand KV Store documentation with comprehensive examples and A…
df13fca
…PI reference
Add detailed usage examples for storing, retrieving, and deleting data in KV Store. Include examples for working with different data types (text, JSON, binary, streams), metadata handling, multiple key operations, and namespace management. Update guide structure with clearer sections and add API reference documentation for namespace and key management operations. Fix meta tags and namespace references.
@vitor-eltz-azion
vitor-eltz-azion
requested a review
from a team
as a code ownerFebruary 10, 2026 16:39
@vitor-eltz-azionvitor-eltz-azion
added
the 
do not merge
Waiting for decision or deploy
label
Feb 10, 2026
@vitor-eltz-azion
docs: add KV Store API reference documentation with read, write, and …
619c597
…delete operations
Add comprehensive API reference pages for KV Store operations including methods for reading key-value pairs (get, getWithMetadata), writing data (put), and deleting entries. Include detailed parameter descriptions, response types, usage examples, and guidance for handling different data types (text, JSON, binary, streams), metadata, multiple keys, and namespace management. Document eventual consistency behavior
@vitor-eltz-azion
docs: update KV Store namespace limits to 1000 across all service plans
7784d8a
Update namespace limits from varying values (10/50/200) to a unified limit of 1000 namespaces for all service plans (Developer, Business, Enterprise, and Mission Critical) in both English and Portuguese documentation.
gabriel-alves-azion
gabriel-alves-azion
previously approved these changes
May 7, 2026
View reviewed changes
@gabriel-alves-azion
gabriel-alves-azionforce-pushed
the
EDU-6737-feat-kv-store-documentation
branch
from
9546399 to
04a9152CompareMay 14, 2026 20:09
@gabriel-alves-aziongabriel-alves-azion
added

documentation
Improvements or additions to documentation
and removed

do not merge
Waiting for decision or deploy
labels
May 19, 2026
@egermano
egermano
merged commit 47c784d
into
mainMay 21, 2026

3 checks passed

@egermano
egermano
deleted the

EDU-6737-feat-kv-store-documentation

branch
May 21, 2026 12:13
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


3 more reviewers

@egermanoegermanoegermano approved these changes
@VitorEltzVitorEltzVitorEltz approved these changes
@gabriel-alves-aziongabriel-alves-aziongabriel-alves-azion left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

documentationImprovements or additions to documentation

Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@vitor-eltz-azion@egermano@VitorEltz@gabriel-alves-azion@LuizaVSantos

, '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
[EDU-6737]feat:kv store documentation - #2019
Merged
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
May 21, 2026
Merged
[EDU-6737]feat:kv store documentation#2019
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
Conversation
@vitor-eltz-azion
@vitor-eltz-azionvitor-eltz-azion
commented
Feb 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
PR Description
Title
docs: Add comprehensive KV Store documentation with examples, API reference, and Redis compatibility guide
Summary
This PR introduces complete documentation for the KV Store product, including reference documentation, practical guides, and API reference in both English and Portuguese. The documentation is inspired by Cloudflare's KV documentation structure for familiarity and ease of use.
Changes
New Files (16)
Reference Documentation (EN/PT-BR)
  • src/content/docs/en/pages/main-menu/reference/store/kv-store/kv-store.mdx
  • src/content/docs/pt-br/pages/menu-principal/referencia/store/kv-store/kv-store.mdx
Guides (EN/PT-BR)
  • src/content/docs/en/pages/guides/kv-store/manage-data.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/gerenciar-com-funcoes.mdx
  • src/content/docs/en/pages/guides/kv-store/redis-compatibility.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/compatibilidade-redis.mdx
API Reference (EN)
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
API Reference (PT-BR)
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
Content Added
Reference Documentation
  • Product overview and use cases
  • Cloudflare Workers KV API compatibility mention
  • How it works (namespaces, keys, value types)
  • Data resilience architecture
  • Namespace management via API (create, list, retrieve)
  • Complete Azion.KV class reference with all methods
  • Put options (metadata, expiration, expirationTtl)
  • Get options (cacheTtl)
  • Get types (text, json, arrayBuffer, stream)
  • Service plan limits table
  • Minimum TTL values (60 seconds for both expirationTtl and cacheTtl)
  • Limitations section (no list(), no multi-key transactions, namespace management via API only)
Guide Documentation
  • Step-by-step function creation
  • Storing data (string, JSON, with options)
  • Retrieving data (single key, multiple keys, with metadata)
  • Deleting data
  • Working with binary data (ArrayBuffer)
  • Working with streams (ReadableStream)
  • Using specific namespaces for data isolation
Redis Compatibility Guide (NEW)
  • Installation of azion SDK package
  • Redis-like client pattern with createClient()
  • Event-based error handling
  • Hash operations (hSet, hGetAll, hVals)
  • Provider detection (native vs API)
  • Complete Redis method mapping table
API Reference (Cloudflare-inspired structure)
  • index.mdx: Overview, initialization, available methods, limits
  • write.mdx: put() method with parameters, options, examples, guidance on expiration and metadata
  • read.mdx: get() and getWithMetadata() methods with type options, cacheTtl, single/multiple key retrieval
  • delete.mdx: delete() method with namespace deletion
Code Examples
20+ working JavaScript examples covering:
  • kv.put() with strings, objects, ArrayBuffer, and streams
  • kv.get() with different return types (text, json, arrayBuffer, stream)
  • kv.getWithMetadata() for value + metadata retrieval
  • kv.delete() for key removal
  • Namespace initialization (new Azion.KV(), Azion.KV.open())
  • Namespace deletion (Azion.KV.delete())
  • Redis-compatible SDK usage (createClient(), hSet, hGetAll, hVals)
Terminology Updates
  • Removed "Edge" terminology throughout (Edge Functions → Functions, Edge Application → Application)
  • Updated to align with current Azion product naming conventions
Related
LuizaVSantosand others
added 10 commits
August 28, 2025 12:30
@LuizaVSantos
feat: added kv store reference
a296930
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
dadc805
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestions from code review
0eb64ba
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
754fb72
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
335b94f
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
15917b4
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
152cf7d
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
2566c39
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion
Merge branch 'main' of github.com:aziontech/docs into kvstore-referemce
599a2be
@vitor-eltz-azion
docs: expand KV Store documentation with comprehensive examples and A…
df13fca
…PI reference
Add detailed usage examples for storing, retrieving, and deleting data in KV Store. Include examples for working with different data types (text, JSON, binary, streams), metadata handling, multiple key operations, and namespace management. Update guide structure with clearer sections and add API reference documentation for namespace and key management operations. Fix meta tags and namespace references.
@vitor-eltz-azion
vitor-eltz-azion
requested a review
from a team
as a code ownerFebruary 10, 2026 16:39
@vitor-eltz-azionvitor-eltz-azion
added
the 
do not merge
Waiting for decision or deploy
label
Feb 10, 2026
@vitor-eltz-azion
docs: add KV Store API reference documentation with read, write, and …
619c597
…delete operations
Add comprehensive API reference pages for KV Store operations including methods for reading key-value pairs (get, getWithMetadata), writing data (put), and deleting entries. Include detailed parameter descriptions, response types, usage examples, and guidance for handling different data types (text, JSON, binary, streams), metadata, multiple keys, and namespace management. Document eventual consistency behavior
@vitor-eltz-azion
docs: update KV Store namespace limits to 1000 across all service plans
7784d8a
Update namespace limits from varying values (10/50/200) to a unified limit of 1000 namespaces for all service plans (Developer, Business, Enterprise, and Mission Critical) in both English and Portuguese documentation.
gabriel-alves-azion
gabriel-alves-azion
previously approved these changes
May 7, 2026
View reviewed changes
@gabriel-alves-azion
gabriel-alves-azionforce-pushed
the
EDU-6737-feat-kv-store-documentation
branch
from
9546399 to
04a9152CompareMay 14, 2026 20:09
@gabriel-alves-aziongabriel-alves-azion
added

documentation
Improvements or additions to documentation
and removed

do not merge
Waiting for decision or deploy
labels
May 19, 2026
@egermano
egermano
merged commit 47c784d
into
mainMay 21, 2026

3 checks passed

@egermano
egermano
deleted the

EDU-6737-feat-kv-store-documentation

branch
May 21, 2026 12:13
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


3 more reviewers

@egermanoegermanoegermano approved these changes
@VitorEltzVitorEltzVitorEltz approved these changes
@gabriel-alves-aziongabriel-alves-aziongabriel-alves-azion left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

documentationImprovements or additions to documentation

Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@vitor-eltz-azion@egermano@VitorEltz@gabriel-alves-azion@LuizaVSantos

, '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
[EDU-6737]feat:kv store documentation - #2019
Merged
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
May 21, 2026
Merged
[EDU-6737]feat:kv store documentation#2019
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
Conversation
@vitor-eltz-azion
@vitor-eltz-azionvitor-eltz-azion
commented
Feb 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
PR Description
Title
docs: Add comprehensive KV Store documentation with examples, API reference, and Redis compatibility guide
Summary
This PR introduces complete documentation for the KV Store product, including reference documentation, practical guides, and API reference in both English and Portuguese. The documentation is inspired by Cloudflare's KV documentation structure for familiarity and ease of use.
Changes
New Files (16)
Reference Documentation (EN/PT-BR)
  • src/content/docs/en/pages/main-menu/reference/store/kv-store/kv-store.mdx
  • src/content/docs/pt-br/pages/menu-principal/referencia/store/kv-store/kv-store.mdx
Guides (EN/PT-BR)
  • src/content/docs/en/pages/guides/kv-store/manage-data.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/gerenciar-com-funcoes.mdx
  • src/content/docs/en/pages/guides/kv-store/redis-compatibility.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/compatibilidade-redis.mdx
API Reference (EN)
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
API Reference (PT-BR)
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
Content Added
Reference Documentation
  • Product overview and use cases
  • Cloudflare Workers KV API compatibility mention
  • How it works (namespaces, keys, value types)
  • Data resilience architecture
  • Namespace management via API (create, list, retrieve)
  • Complete Azion.KV class reference with all methods
  • Put options (metadata, expiration, expirationTtl)
  • Get options (cacheTtl)
  • Get types (text, json, arrayBuffer, stream)
  • Service plan limits table
  • Minimum TTL values (60 seconds for both expirationTtl and cacheTtl)
  • Limitations section (no list(), no multi-key transactions, namespace management via API only)
Guide Documentation
  • Step-by-step function creation
  • Storing data (string, JSON, with options)
  • Retrieving data (single key, multiple keys, with metadata)
  • Deleting data
  • Working with binary data (ArrayBuffer)
  • Working with streams (ReadableStream)
  • Using specific namespaces for data isolation
Redis Compatibility Guide (NEW)
  • Installation of azion SDK package
  • Redis-like client pattern with createClient()
  • Event-based error handling
  • Hash operations (hSet, hGetAll, hVals)
  • Provider detection (native vs API)
  • Complete Redis method mapping table
API Reference (Cloudflare-inspired structure)
  • index.mdx: Overview, initialization, available methods, limits
  • write.mdx: put() method with parameters, options, examples, guidance on expiration and metadata
  • read.mdx: get() and getWithMetadata() methods with type options, cacheTtl, single/multiple key retrieval
  • delete.mdx: delete() method with namespace deletion
Code Examples
20+ working JavaScript examples covering:
  • kv.put() with strings, objects, ArrayBuffer, and streams
  • kv.get() with different return types (text, json, arrayBuffer, stream)
  • kv.getWithMetadata() for value + metadata retrieval
  • kv.delete() for key removal
  • Namespace initialization (new Azion.KV(), Azion.KV.open())
  • Namespace deletion (Azion.KV.delete())
  • Redis-compatible SDK usage (createClient(), hSet, hGetAll, hVals)
Terminology Updates
  • Removed "Edge" terminology throughout (Edge Functions → Functions, Edge Application → Application)
  • Updated to align with current Azion product naming conventions
Related
LuizaVSantosand others
added 10 commits
August 28, 2025 12:30
@LuizaVSantos
feat: added kv store reference
a296930
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
dadc805
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestions from code review
0eb64ba
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
754fb72
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
335b94f
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
15917b4
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
152cf7d
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
2566c39
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion
Merge branch 'main' of github.com:aziontech/docs into kvstore-referemce
599a2be
@vitor-eltz-azion
docs: expand KV Store documentation with comprehensive examples and A…
df13fca
…PI reference
Add detailed usage examples for storing, retrieving, and deleting data in KV Store. Include examples for working with different data types (text, JSON, binary, streams), metadata handling, multiple key operations, and namespace management. Update guide structure with clearer sections and add API reference documentation for namespace and key management operations. Fix meta tags and namespace references.
@vitor-eltz-azion
vitor-eltz-azion
requested a review
from a team
as a code ownerFebruary 10, 2026 16:39
@vitor-eltz-azionvitor-eltz-azion
added
the 
do not merge
Waiting for decision or deploy
label
Feb 10, 2026
@vitor-eltz-azion
docs: add KV Store API reference documentation with read, write, and …
619c597
…delete operations
Add comprehensive API reference pages for KV Store operations including methods for reading key-value pairs (get, getWithMetadata), writing data (put), and deleting entries. Include detailed parameter descriptions, response types, usage examples, and guidance for handling different data types (text, JSON, binary, streams), metadata, multiple keys, and namespace management. Document eventual consistency behavior
@vitor-eltz-azion
docs: update KV Store namespace limits to 1000 across all service plans
7784d8a
Update namespace limits from varying values (10/50/200) to a unified limit of 1000 namespaces for all service plans (Developer, Business, Enterprise, and Mission Critical) in both English and Portuguese documentation.
gabriel-alves-azion
gabriel-alves-azion
previously approved these changes
May 7, 2026
View reviewed changes
@gabriel-alves-azion
gabriel-alves-azionforce-pushed
the
EDU-6737-feat-kv-store-documentation
branch
from
9546399 to
04a9152CompareMay 14, 2026 20:09
@gabriel-alves-aziongabriel-alves-azion
added

documentation
Improvements or additions to documentation
and removed

do not merge
Waiting for decision or deploy
labels
May 19, 2026
@egermano
egermano
merged commit 47c784d
into
mainMay 21, 2026

3 checks passed

@egermano
egermano
deleted the

EDU-6737-feat-kv-store-documentation

branch
May 21, 2026 12:13
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


3 more reviewers

@egermanoegermanoegermano approved these changes
@VitorEltzVitorEltzVitorEltz approved these changes
@gabriel-alves-aziongabriel-alves-aziongabriel-alves-azion left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

documentationImprovements or additions to documentation

Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@vitor-eltz-azion@egermano@VitorEltz@gabriel-alves-azion@LuizaVSantos

, '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
[EDU-6737]feat:kv store documentation - #2019
Merged
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
May 21, 2026
Merged
[EDU-6737]feat:kv store documentation#2019
egermano merged 17 commits into
mainfrom 
EDU-6737-feat-kv-store-documentation
Conversation
@vitor-eltz-azion
@vitor-eltz-azionvitor-eltz-azion
commented
Feb 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
PR Description
Title
docs: Add comprehensive KV Store documentation with examples, API reference, and Redis compatibility guide
Summary
This PR introduces complete documentation for the KV Store product, including reference documentation, practical guides, and API reference in both English and Portuguese. The documentation is inspired by Cloudflare's KV documentation structure for familiarity and ease of use.
Changes
New Files (16)
Reference Documentation (EN/PT-BR)
  • src/content/docs/en/pages/main-menu/reference/store/kv-store/kv-store.mdx
  • src/content/docs/pt-br/pages/menu-principal/referencia/store/kv-store/kv-store.mdx
Guides (EN/PT-BR)
  • src/content/docs/en/pages/guides/kv-store/manage-data.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/gerenciar-com-funcoes.mdx
  • src/content/docs/en/pages/guides/kv-store/redis-compatibility.mdx
  • src/content/docs/pt-br/pages/guias/kv-store/compatibilidade-redis.mdx
API Reference (EN)
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
API Reference (PT-BR)
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/index.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/write.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/read.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/kv-store/delete.mdx
Content Added
Reference Documentation
  • Product overview and use cases
  • Cloudflare Workers KV API compatibility mention
  • How it works (namespaces, keys, value types)
  • Data resilience architecture
  • Namespace management via API (create, list, retrieve)
  • Complete Azion.KV class reference with all methods
  • Put options (metadata, expiration, expirationTtl)
  • Get options (cacheTtl)
  • Get types (text, json, arrayBuffer, stream)
  • Service plan limits table
  • Minimum TTL values (60 seconds for both expirationTtl and cacheTtl)
  • Limitations section (no list(), no multi-key transactions, namespace management via API only)
Guide Documentation
  • Step-by-step function creation
  • Storing data (string, JSON, with options)
  • Retrieving data (single key, multiple keys, with metadata)
  • Deleting data
  • Working with binary data (ArrayBuffer)
  • Working with streams (ReadableStream)
  • Using specific namespaces for data isolation
Redis Compatibility Guide (NEW)
  • Installation of azion SDK package
  • Redis-like client pattern with createClient()
  • Event-based error handling
  • Hash operations (hSet, hGetAll, hVals)
  • Provider detection (native vs API)
  • Complete Redis method mapping table
API Reference (Cloudflare-inspired structure)
  • index.mdx: Overview, initialization, available methods, limits
  • write.mdx: put() method with parameters, options, examples, guidance on expiration and metadata
  • read.mdx: get() and getWithMetadata() methods with type options, cacheTtl, single/multiple key retrieval
  • delete.mdx: delete() method with namespace deletion
Code Examples
20+ working JavaScript examples covering:
  • kv.put() with strings, objects, ArrayBuffer, and streams
  • kv.get() with different return types (text, json, arrayBuffer, stream)
  • kv.getWithMetadata() for value + metadata retrieval
  • kv.delete() for key removal
  • Namespace initialization (new Azion.KV(), Azion.KV.open())
  • Namespace deletion (Azion.KV.delete())
  • Redis-compatible SDK usage (createClient(), hSet, hGetAll, hVals)
Terminology Updates
  • Removed "Edge" terminology throughout (Edge Functions → Functions, Edge Application → Application)
  • Updated to align with current Azion product naming conventions
Related
LuizaVSantosand others
added 10 commits
August 28, 2025 12:30
@LuizaVSantos
feat: added kv store reference
a296930
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
dadc805
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestions from code review
0eb64ba
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
754fb72
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
335b94f
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
15917b4
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
152cf7d
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion@MarianaReisAlcantara
Apply suggestion from@MarianaReisAlcantara
2566c39
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@vitor-eltz-azion
Merge branch 'main' of github.com:aziontech/docs into kvstore-referemce
599a2be
@vitor-eltz-azion
docs: expand KV Store documentation with comprehensive examples and A…
df13fca
…PI reference
Add detailed usage examples for storing, retrieving, and deleting data in KV Store. Include examples for working with different data types (text, JSON, binary, streams), metadata handling, multiple key operations, and namespace management. Update guide structure with clearer sections and add API reference documentation for namespace and key management operations. Fix meta tags and namespace references.
@vitor-eltz-azion
vitor-eltz-azion
requested a review
from a team
as a code ownerFebruary 10, 2026 16:39
@vitor-eltz-azionvitor-eltz-azion
added
the 
do not merge
Waiting for decision or deploy
label
Feb 10, 2026
@vitor-eltz-azion
docs: add KV Store API reference documentation with read, write, and …
619c597
…delete operations
Add comprehensive API reference pages for KV Store operations including methods for reading key-value pairs (get, getWithMetadata), writing data (put), and deleting entries. Include detailed parameter descriptions, response types, usage examples, and guidance for handling different data types (text, JSON, binary, streams), metadata, multiple keys, and namespace management. Document eventual consistency behavior
@vitor-eltz-azion
docs: update KV Store namespace limits to 1000 across all service plans
7784d8a
Update namespace limits from varying values (10/50/200) to a unified limit of 1000 namespaces for all service plans (Developer, Business, Enterprise, and Mission Critical) in both English and Portuguese documentation.
gabriel-alves-azion
gabriel-alves-azion
previously approved these changes
May 7, 2026
View reviewed changes
@gabriel-alves-azion
gabriel-alves-azionforce-pushed
the
EDU-6737-feat-kv-store-documentation
branch
from
9546399 to
04a9152CompareMay 14, 2026 20:09
@gabriel-alves-aziongabriel-alves-azion
added

documentation
Improvements or additions to documentation
and removed

do not merge
Waiting for decision or deploy
labels
May 19, 2026
@egermano
egermano
merged commit 47c784d
into
mainMay 21, 2026

3 checks passed

@egermano
egermano
deleted the

EDU-6737-feat-kv-store-documentation

branch
May 21, 2026 12:13
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


3 more reviewers

@egermanoegermanoegermano approved these changes
@VitorEltzVitorEltzVitorEltz approved these changes
@gabriel-alves-aziongabriel-alves-aziongabriel-alves-azion left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

documentationImprovements or additions to documentation

Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

5 participants

@vitor-eltz-azion@egermano@VitorEltz@gabriel-alves-azion@LuizaVSantos