Google Git Google Git
Sign in
cos/third_party/docker/refs/heads/upstream/docker-29.x/./extpoints/storage/kv/v0
tree: 54a81b79b5497e714e26c1f129a359147c58e9e8 [search]
  1. protogen/
  2. kv.go
  3. README.md
  4. storage.go
  5. storage.proto
extpoints/storage/kv/v0/README.md

Persistent record storage

Store opaque key/value records without depending on host-local paths. Declare storagekv.Point.Dependency() and resolve a namespace during extension initialization:

kv, err := storagekv.GetKV(resolver, "org.my.extension")
if err != nil {
    return err
}

Use the namespace-bound helper for record operations:

err = kv.Create(ctx, "jobs/123", data)
data, err = kv.Get(ctx, "jobs/123")
err = kv.Update(ctx, "jobs/123", updatedData)
err = kv.Delete(ctx, "jobs/123")
err = kv.DeletePrefix(ctx, "jobs/")
page, err := kv.List(ctx, storagekv.ListOptions{Prefix: "jobs/"})

Record operations

  • Keys are logical strings, not paths; consumers own value encoding and schema versions.
  • Create requires an absent key; Update requires an existing key; Delete tolerates absence.
  • DeletePrefix atomically and durably removes all matching records; a nonempty prefix is required, and no matches (including a missing namespace) succeeds.
  • Individual writes are durable and atomic per record. DeletePrefix is the only multi-record atomic operation; there is no concurrent-update protection.
  • Listing is paginated, not a snapshot; continue with NextCursor using the same prefix.
  • The helper needs no Close; records survive provider restarts and extension removal.

Executable consumers register the generated protogen.ClientPoint with their SDK client-point registry. See storage.go for the full contract and size limits.

Namespace and trust model

Namespaces partition records for cooperative use; they are not an authorization boundary. All trusted installed extensions that can reach this provider can access any namespace. v0 performs no identity-based authorization, and namespace names do not authenticate ownership. Any future identity enforcement belongs in host-resolved identity and per-caller storage wiring. Identity enforcement must still allow explicit namespace sharing.

Persistence and lifecycle

Records are not purged automatically when an extension is absent or uninstalled. Each extension owns cleanup of its individual records. v0 stores no namespace ownership metadata and defines no garbage-collection policy; policy is deferred to v1. Do not delete the shared database to remove one extension's data. Corruption of the shared database affects all namespaces, and storage provides no automatic repair or replacement. Storage does not automatically compact the database or reclaim file space.