Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
VitorAEltz wants to merge 12 commits into
base: main
Choose a base branch
from
Open

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

VitorAEltz wants to merge 12 commits into from

Conversation

@VitorAEltz
Copy link
Contributor

@VitorAEltz VitorAEltz commented Feb 10, 2026 •
edited
Loading

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

LuizaVSantos and others added 10 commits August 28, 2025 12:30
@LuizaVSantos
feat: added kv store reference
a296930
@VitorAEltz @MarianaReisAlcantara
Apply suggestion from @MarianaReisAlcantara
dadc805 
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@VitorAEltz @MarianaReisAlcantara
Apply suggestions from code review
0eb64ba 
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@VitorAEltz @MarianaReisAlcantara
Apply suggestion from @MarianaReisAlcantara
754fb72 
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@VitorAEltz @MarianaReisAlcantara
Apply suggestion from @MarianaReisAlcantara
335b94f 
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@VitorAEltz @MarianaReisAlcantara
Apply suggestion from @MarianaReisAlcantara
15917b4 
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@VitorAEltz @MarianaReisAlcantara
Apply suggestion from @MarianaReisAlcantara
152cf7d 
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@VitorAEltz @MarianaReisAlcantara
Apply suggestion from @MarianaReisAlcantara
2566c39 
Co-authored-by: MarianaReisAlcantara <mariana.alcantara@azion.com>
@VitorAEltz
Merge branch 'main' of github.com:aziontech/docs into kvstore-referemce
599a2be
@VitorAEltz
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.
@VitorAEltz VitorAEltz requested a review from a team as a code owner February 10, 2026 16:39
@VitorAEltz VitorAEltz added the do not merge Waiting for decision or deploy label Feb 10, 2026
@VitorAEltz
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
@VitorAEltz
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

do not merge Waiting for decision or deploy

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@VitorAEltz @LuizaVSantos