Skip to content

docs: add Drizzle adapter API reference page #9

@coderdan

Description

@coderdan

Summary

The old docs had reference/drizzle — a dedicated API reference for the Drizzle adapter (@cipherstash/drizzle). The new docs have a single guide-style page at content/stack/cipherstash/encryption/drizzle.mdx, but no companion reference for the public surface (encryptedType, extractEncryptionSchema, createEncryptionOperators, the encrypted query operators, batched and/or, EQL migrations).

What's missing

Users reading drizzle.mdx get walkthrough-flow examples but not:

  • A complete, sortable table of encrypted query operators and what each maps to in EQL
  • encryptedType column-builder configuration surface
  • createEncryptionOperators signature and the operator object it returns
  • extractEncryptionSchema — when you'd use it and what it returns
  • Migration helpers for installing/upgrading EQL from a Drizzle migration

Suggested page

content/stack/reference/drizzle.mdx — keep cipherstash/encryption/drizzle.mdx as the guide and link from there. Mirror the structure of #8 (SDK reference) so the two refs feel consistent.

Reference material

Old page in cipherstash-js-suite git history at apps/docs/src/app/(articles)/reference/drizzle/page.md (commit 1c3d40ed^). Public surface lives in @cipherstash/drizzle — the existing drizzle agent skill referenced in CLAUDE.md is the canonical source.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions