You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: comprehensive update to EQL function reference
Fix critical documentation issues and add missing function documentation:
- Fix return type names: change eql_v2_* to eql_v2.* for index term
extraction functions (hmac_256, blake3, bloom_filter, ore_block_u64_8_256)
- Add missing function equivalents for Supabase compatibility:
ilike(), lt(), lte(), gt(), gte()
- Document configuration lifecycle functions: migrate_config(),
activate_config(), discard(), reload_config()
- Add aggregate functions: min(), max()
- Document jsonb overloads for JSONB path and array functions
- Add new Utility Functions section with version(), to_encrypted(),
to_jsonb(), check_encrypted()
- Standardize terminology: change "context" to "prefix" for ste_vec
index configuration
- Update table of contents to include new sections
This update brings the documentation in line with actual implementation
and test behavior, addressing 15+ previously undocumented functions.
Copy file name to clipboardExpand all lines: docs/reference/index-config.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,11 +105,16 @@ Try to ensure that the string you search for is at least as long as the `tokenLe
105
105
106
106
An ste_vec index on a encrypted JSONB column enables the use of PostgreSQL's `@>` and `<@`[containment operators](https://www.postgresql.org/docs/16/functions-json.html#FUNCTIONS-JSONB-OP-TABLE).
107
107
108
-
An ste_vec index requires one piece of configuration: the `context` (a string) which is passed as an info string to a MAC (Message Authenticated Code).
109
-
This ensures that all of the encrypted values are unique to that context.
110
-
We recommend that you use the table and column name as a the context (e.g. `users/name`).
108
+
An ste_vec index requires one piece of configuration: the `prefix` (a string) which is passed as an info string to a MAC (Message Authenticated Code).
109
+
This ensures that all of the encrypted values are unique to that prefix.
110
+
We recommend that you use the table and column name as the prefix (e.g. `users/name`).
111
111
112
-
Within a dataset, encrypted columns indexed using an `ste_vec` that use different contexts can't be compared.
112
+
**Example:**
113
+
```json
114
+
{"prefix": "users/encrypted_json"}
115
+
```
116
+
117
+
Within a dataset, encrypted columns indexed using an `ste_vec` that use different prefixes can't be compared.
113
118
Containment queries that manage to mix index terms from multiple columns will never return a positive result.
0 commit comments