Skip to content

docs: per-query-type pages for searchable encryption (Equality / Match / Range) #5

@coderdan

Description

@coderdan

Summary

The previous docs site had three dedicated pages — Equality, Match, and Order / Range — under platform/searchable-encryption/supported-queries/{exact,match,range}/. These were the practical "what query do I want, what index do I create, what does the SQL look like" reference. The new docs absorb fragments of this into reference/eql-guide.mdx and cipherstash/encryption/searchable-encryption.mdx, but there's no per-query-type landing.

This pairs closely with #4 (CREATE INDEX guide). #4 is the table of which index for which query; this issue is the per-query reference page that explains the semantics, operators, and gotchas for each query type.

What's missing

Query type Old page New equivalent
Equality (=, IN) supported-queries/exact None — folded into eql-guide.mdx as a row in a table
Match (LIKE, free-text) supported-queries/match Brief mention in searchable-encryption.mdx; no operator reference
Range / Order (<, >, BETWEEN, ORDER BY) supported-queries/range One callout in searchable-encryption.mdx:134 about ore_block_u64_8_256() for ORDER BY

The old pages each covered:

  • Which JS/SDK predicate or SQL operator triggers the path
  • Which index type underpins it (unique / match / ore / bloom_filter / ste_vec)
  • Worked SQL examples
  • Performance characteristics and caveats

Suggested page structure

Either three pages under content/stack/cipherstash/encryption/queries/{equality,match,range}.mdx, or one expanded page cipherstash/encryption/queries.mdx with three top-level sections. Each section needs:

Reference material

  • Old pages live in cipherstash-js-suite git history at apps/docs/src/app/(articles)/platform/searchable-encryption/supported-queries/{exact,match,range}/page.md (commit 1c3d40ed^).
  • EQL repo's per-operator reference under docs/reference/.

Out of scope

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions