Skip to content

docs(golang): lead the encrypt quickstart with EQL v4 columns - #1176

Merged
coderdan merged 1 commit into
test/golang-eql-v4from
docs/golang-eql-v4-tag-grammar
Oct 13, 2026
Merged

coderdan merged 1 commit into
test/golang-eql-v4from
docs/golang-eql-v4-tag-grammar

Conversation

@coderdan

Copy link
Copy Markdown
Contributor

Summary

The encrypt README and package doc (what go doc .../encrypt prints) open with the index= grammar: encrypt,index=equality;match, a uint32 field under ore, Fields.Email.Equality, and separate byte columns. The stashgen README and the EQL v4 alpha setup guide use encrypt_into= and Fields.Email.Query, with one eql_v4_* column per field. A developer who reads the package docs first writes tags for a storage model the guide does not cover.

Found while building a small patients app against v0.1.0-alpha.1 from the setup guide alone: the guide's steps worked first time, but go doc described a different quickstart.

Changes

  • Quickstart, encrypt/README.md and encrypt/doc.go: step 2 declares encrypt_into=TextEq, TextMatch and Integer (with an int32) and says the Go field type must match. Step 5 builds the search term with Fields.Email.Query. Step 6 stores each field as one eql_v4 column, says to install eql-v4-install.sql first, and shows the $1::eql_v4.query_text_eq cast.
  • index= stays documented. Step 6 names it as the alternative and links to "What is stored". The README no longer calls example/ "the eight steps as a program", because the example still uses index=.

Docs only; no code changes.

Verification

  • gofmt and go vet ./encrypt/ are clean, and go doc ./encrypt renders the new steps.
  • The quickstart struct's shapes (TextEq, TextMatch, int32 Integer) generate with stashgen at v0.1.0-alpha.1. Rows built from them insert into eql_v4_* columns and answer = and @@ in PostgreSQL 17.

Related

Stacked on #1165.

@coderdan
coderdan requested a review from a team as a code owner October 13, 2026 01:52
@changeset-bot

changeset-bot Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 53e5cca

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 3cf56ad9-e4f9-420c-9d5e-995dca1c5ad5

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-13T01:54:33.289512Z 8650228 PR opened
🔒 Security Review ✅ Completed 2026-10-13T01:55:12.631304Z 8650228 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderdan
coderdan force-pushed the docs/golang-eql-v4-tag-grammar branch from 8650228 to 0d45671 Compare October 13, 2026 02:23

@auxesis auxesis left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clear and simple, thanks @coderdan.

@coderdan
coderdan force-pushed the docs/golang-eql-v4-tag-grammar branch from 0d45671 to 053e629 Compare October 13, 2026 03:32
@coderdan
coderdan force-pushed the docs/golang-eql-v4-tag-grammar branch from 053e629 to 37dffbc Compare October 13, 2026 04:10
The encrypt README and package doc opened with the index= grammar
(Ciphertext plus term byte columns, Fields.Email.Equality), while the
stashgen README and the EQL v4 alpha setup guide use encrypt_into= and
Fields.Email.Query. A reader starting from go doc wrote tags the guide
does not describe, for a storage model it does not cover.

Both quickstarts now declare encrypt_into fields, build the query with
Query, and store each field as one eql_v4 column, with the install step
and the query cast. The index= form stays documented and is named as the
alternative; the example program still uses it, and the README now says
so rather than calling it the eight steps.
@coderdan
coderdan force-pushed the docs/golang-eql-v4-tag-grammar branch from 37dffbc to 53e5cca Compare October 13, 2026 09:46
@coderdan
coderdan merged commit 679ff4d into test/golang-eql-v4 Oct 13, 2026
37 of 58 checks passed
@coderdan
coderdan deleted the docs/golang-eql-v4-tag-grammar branch October 13, 2026 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants