Skip to content

Commit 246701b

Browse files
tobyhedetobyhede
authored
Merge pull request #141 from cipherstash/add-doxygen-sql-comments
docs(sql): Add Doxygen-style documentation (Phase 1-2: Core modules)
2 parents ac6a360 + 619049f commit 246701b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+4693
-352
lines changed

‎docs/development/documentation-blockers.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Documentation Blockers
2+
3+
Bugs found during documentation process:
4+
5+
## Format
6+
- [ ] BUG FOUND: function_name
7+
Issue: [description]
8+
GitHub Issue: #XXX (if created)
9+
Action: [what was done]
10+
Blocking documentation: Yes/No
11+
12+
---
13+

‎docs/development/documentation-inventory.md‎

Lines changed: 373 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,373 @@
1+
# SQL Documentation Inventory
2+
3+
Generated: Mon 27 Oct 2025 11:39:50 AEDT
4+
5+
## src/blake3/compare.sql
6+
7+
- CREATE FUNCTION eql_v2.compare_blake3(a eql_v2_encrypted, b eql_v2_encrypted)
8+
9+
## src/blake3/functions.sql
10+
11+
- CREATE FUNCTION eql_v2.blake3(val jsonb)
12+
- CREATE FUNCTION eql_v2.blake3(val eql_v2_encrypted)
13+
- CREATE FUNCTION eql_v2.has_blake3(val jsonb)
14+
- CREATE FUNCTION eql_v2.has_blake3(val eql_v2_encrypted)
15+
16+
## src/blake3/types.sql
17+
18+
- CREATE DOMAIN eql_v2.blake3 AS text;
19+
20+
## src/bloom_filter/functions.sql
21+
22+
- CREATE FUNCTION eql_v2.bloom_filter(val jsonb)
23+
- CREATE FUNCTION eql_v2.bloom_filter(val eql_v2_encrypted)
24+
- CREATE FUNCTION eql_v2.has_bloom_filter(val jsonb)
25+
- CREATE FUNCTION eql_v2.has_bloom_filter(val eql_v2_encrypted)
26+
27+
## src/bloom_filter/types.sql
28+
29+
- CREATE DOMAIN eql_v2.bloom_filter AS smallint[];
30+
31+
## src/common.sql
32+
33+
- CREATE FUNCTION eql_v2.bytea_eq(a bytea, b bytea) RETURNS boolean AS $$
34+
- CREATE FUNCTION eql_v2.jsonb_array_to_bytea_array(val jsonb)
35+
- CREATE FUNCTION eql_v2.log(s text)
36+
- CREATE FUNCTION eql_v2.log(ctx text, s text)
37+
38+
## src/config/constraints.sql
39+
40+
- CREATE FUNCTION eql_v2.config_get_indexes(val jsonb)
41+
- CREATE FUNCTION eql_v2.config_check_indexes(val jsonb)
42+
- CREATE FUNCTION eql_v2.config_check_cast(val jsonb)
43+
- CREATE FUNCTION eql_v2.config_check_tables(val jsonb)
44+
- CREATE FUNCTION eql_v2.config_check_version(val jsonb)
45+
46+
## src/config/functions.sql
47+
48+
- CREATE FUNCTION eql_v2.add_search_config(table_name text, column_name text, index_name text, cast_as text DEFAULT 'text', opts jsonb DEFAULT '{}', migrating boolean DEFAULT false)
49+
- CREATE FUNCTION eql_v2.remove_search_config(table_name text, column_name text, index_name text, migrating boolean DEFAULT false)
50+
- CREATE FUNCTION eql_v2.modify_search_config(table_name text, column_name text, index_name text, cast_as text DEFAULT 'text', opts jsonb DEFAULT '{}', migrating boolean DEFAULT false)
51+
- CREATE FUNCTION eql_v2.migrate_config()
52+
- CREATE FUNCTION eql_v2.activate_config()
53+
- CREATE FUNCTION eql_v2.discard()
54+
- CREATE FUNCTION eql_v2.add_column(table_name text, column_name text, cast_as text DEFAULT 'text', migrating boolean DEFAULT false)
55+
- CREATE FUNCTION eql_v2.remove_column(table_name text, column_name text, migrating boolean DEFAULT false)
56+
- CREATE FUNCTION eql_v2.reload_config()
57+
- CREATE FUNCTION eql_v2.config() RETURNS TABLE (
58+
59+
## src/config/functions_private.sql
60+
61+
- CREATE FUNCTION eql_v2.config_default(config jsonb)
62+
- CREATE FUNCTION eql_v2.config_add_table(table_name text, config jsonb)
63+
- CREATE FUNCTION eql_v2.config_add_column(table_name text, column_name text, config jsonb)
64+
- CREATE FUNCTION eql_v2.config_add_cast(table_name text, column_name text, cast_as text, config jsonb)
65+
- CREATE FUNCTION eql_v2.config_add_index(table_name text, column_name text, index_name text, opts jsonb, config jsonb)
66+
- CREATE FUNCTION eql_v2.config_match_default()
67+
68+
## src/config/indexes.sql
69+
70+
71+
## src/config/tables.sql
72+
73+
74+
## src/config/types.sql
75+
76+
77+
## src/crypto.sql
78+
79+
80+
## src/encrypted/aggregates.sql
81+
82+
- CREATE FUNCTION eql_v2.min(a eql_v2_encrypted, b eql_v2_encrypted)
83+
- CREATE AGGREGATE eql_v2.min(eql_v2_encrypted)
84+
- CREATE FUNCTION eql_v2.max(a eql_v2_encrypted, b eql_v2_encrypted)
85+
- CREATE AGGREGATE eql_v2.max(eql_v2_encrypted)
86+
87+
## src/encrypted/casts.sql
88+
89+
- CREATE FUNCTION eql_v2.to_encrypted(data jsonb)
90+
- CREATE FUNCTION eql_v2.to_encrypted(data text)
91+
- CREATE FUNCTION eql_v2.to_jsonb(e public.eql_v2_encrypted)
92+
93+
## src/encrypted/compare.sql
94+
95+
- CREATE FUNCTION eql_v2.compare_literal(a eql_v2_encrypted, b eql_v2_encrypted)
96+
97+
## src/encrypted/constraints.sql
98+
99+
- CREATE FUNCTION eql_v2._encrypted_check_i(val jsonb)
100+
- CREATE FUNCTION eql_v2._encrypted_check_i_ct(val jsonb)
101+
- CREATE FUNCTION eql_v2._encrypted_check_v(val jsonb)
102+
- CREATE FUNCTION eql_v2._encrypted_check_c(val jsonb)
103+
- CREATE FUNCTION eql_v2.check_encrypted(val jsonb)
104+
- CREATE FUNCTION eql_v2.check_encrypted(val eql_v2_encrypted)
105+
106+
## src/encrypted/functions.sql
107+
108+
- CREATE FUNCTION eql_v2.ciphertext(val jsonb)
109+
- CREATE FUNCTION eql_v2.ciphertext(val eql_v2_encrypted)
110+
- CREATE FUNCTION eql_v2._first_grouped_value(jsonb, jsonb)
111+
- CREATE AGGREGATE eql_v2.grouped_value(jsonb) (
112+
- CREATE FUNCTION eql_v2.add_encrypted_constraint(table_name TEXT, column_name TEXT)
113+
- CREATE FUNCTION eql_v2.remove_encrypted_constraint(table_name TEXT, column_name TEXT)
114+
- CREATE FUNCTION eql_v2.meta_data(val jsonb)
115+
- CREATE FUNCTION eql_v2.meta_data(val eql_v2_encrypted)
116+
117+
## src/encrypted/types.sql
118+
119+
120+
## src/encryptindex/functions.sql
121+
122+
- CREATE FUNCTION eql_v2.diff_config(a JSONB, b JSONB)
123+
- CREATE FUNCTION eql_v2.select_pending_columns()
124+
- CREATE FUNCTION eql_v2.select_target_columns()
125+
- CREATE FUNCTION eql_v2.ready_for_encryption()
126+
- CREATE FUNCTION eql_v2.create_encrypted_columns()
127+
- CREATE FUNCTION eql_v2.rename_encrypted_columns()
128+
- CREATE FUNCTION eql_v2.count_encrypted_with_active_config(table_name TEXT, column_name TEXT)
129+
130+
## src/hmac_256/compare.sql
131+
132+
- CREATE FUNCTION eql_v2.compare_hmac_256(a eql_v2_encrypted, b eql_v2_encrypted)
133+
134+
## src/hmac_256/functions.sql
135+
136+
- CREATE FUNCTION eql_v2.hmac_256(val jsonb)
137+
- CREATE FUNCTION eql_v2.has_hmac_256(val jsonb)
138+
- CREATE FUNCTION eql_v2.has_hmac_256(val eql_v2_encrypted)
139+
- CREATE FUNCTION eql_v2.hmac_256(val eql_v2_encrypted)
140+
141+
## src/hmac_256/types.sql
142+
143+
- CREATE DOMAIN eql_v2.hmac_256 AS text;
144+
145+
## src/jsonb/functions.sql
146+
147+
- CREATE FUNCTION eql_v2.jsonb_path_query(val jsonb, selector text)
148+
- CREATE FUNCTION eql_v2.jsonb_path_query(val eql_v2_encrypted, selector eql_v2_encrypted)
149+
- CREATE FUNCTION eql_v2.jsonb_path_query(val eql_v2_encrypted, selector text)
150+
- CREATE FUNCTION eql_v2.jsonb_path_exists(val jsonb, selector text)
151+
- CREATE FUNCTION eql_v2.jsonb_path_exists(val eql_v2_encrypted, selector eql_v2_encrypted)
152+
- CREATE FUNCTION eql_v2.jsonb_path_exists(val eql_v2_encrypted, selector text)
153+
- CREATE FUNCTION eql_v2.jsonb_path_query_first(val jsonb, selector text)
154+
- CREATE FUNCTION eql_v2.jsonb_path_query_first(val eql_v2_encrypted, selector eql_v2_encrypted)
155+
- CREATE FUNCTION eql_v2.jsonb_path_query_first(val eql_v2_encrypted, selector text)
156+
- CREATE FUNCTION eql_v2.jsonb_array_length(val jsonb)
157+
- CREATE FUNCTION eql_v2.jsonb_array_length(val eql_v2_encrypted)
158+
- CREATE FUNCTION eql_v2.jsonb_array_elements(val jsonb)
159+
- CREATE FUNCTION eql_v2.jsonb_array_elements(val eql_v2_encrypted)
160+
- CREATE FUNCTION eql_v2.jsonb_array_elements_text(val jsonb)
161+
- CREATE FUNCTION eql_v2.jsonb_array_elements_text(val eql_v2_encrypted)
162+
163+
## src/operators/->.sql
164+
165+
- CREATE FUNCTION eql_v2."->"(e eql_v2_encrypted, selector text)
166+
- CREATE OPERATOR ->(
167+
- CREATE FUNCTION eql_v2."->"(e eql_v2_encrypted, selector eql_v2_encrypted)
168+
- CREATE OPERATOR ->(
169+
- CREATE FUNCTION eql_v2."->"(e eql_v2_encrypted, selector integer)
170+
- CREATE OPERATOR ->(
171+
172+
## src/operators/->>.sql
173+
174+
- CREATE FUNCTION eql_v2."->>"(e eql_v2_encrypted, selector text)
175+
- CREATE OPERATOR ->> (
176+
- CREATE FUNCTION eql_v2."->>"(e eql_v2_encrypted, selector eql_v2_encrypted)
177+
- CREATE OPERATOR ->> (
178+
179+
## src/operators/<.sql
180+
181+
- CREATE FUNCTION eql_v2.lt(a eql_v2_encrypted, b eql_v2_encrypted)
182+
- CREATE FUNCTION eql_v2."<"(a eql_v2_encrypted, b eql_v2_encrypted)
183+
- CREATE OPERATOR <(
184+
- CREATE FUNCTION eql_v2."<"(a eql_v2_encrypted, b jsonb)
185+
- CREATE OPERATOR <(
186+
- CREATE FUNCTION eql_v2."<"(a jsonb, b eql_v2_encrypted)
187+
- CREATE OPERATOR <(
188+
189+
## src/operators/<=.sql
190+
191+
- CREATE FUNCTION eql_v2.lte(a eql_v2_encrypted, b eql_v2_encrypted)
192+
- CREATE FUNCTION eql_v2."<="(a eql_v2_encrypted, b eql_v2_encrypted)
193+
- CREATE OPERATOR <=(
194+
- CREATE FUNCTION eql_v2."<="(a eql_v2_encrypted, b jsonb)
195+
- CREATE OPERATOR <=(
196+
- CREATE FUNCTION eql_v2."<="(a jsonb, b eql_v2_encrypted)
197+
- CREATE OPERATOR <=(
198+
199+
## src/operators/<>.sql
200+
201+
- CREATE FUNCTION eql_v2.neq(a eql_v2_encrypted, b eql_v2_encrypted)
202+
- CREATE FUNCTION eql_v2."<>"(a eql_v2_encrypted, b eql_v2_encrypted)
203+
- CREATE OPERATOR <> (
204+
- CREATE FUNCTION eql_v2."<>"(a eql_v2_encrypted, b jsonb)
205+
- CREATE OPERATOR <> (
206+
- CREATE FUNCTION eql_v2."<>"(a jsonb, b eql_v2_encrypted)
207+
- CREATE OPERATOR <> (
208+
209+
## src/operators/<@.sql
210+
211+
- CREATE FUNCTION eql_v2."<@"(a eql_v2_encrypted, b eql_v2_encrypted)
212+
- CREATE OPERATOR <@(
213+
214+
## src/operators/=.sql
215+
216+
- CREATE FUNCTION eql_v2.eq(a eql_v2_encrypted, b eql_v2_encrypted)
217+
- CREATE FUNCTION eql_v2."="(a eql_v2_encrypted, b eql_v2_encrypted)
218+
- CREATE OPERATOR = (
219+
- CREATE FUNCTION eql_v2."="(a eql_v2_encrypted, b jsonb)
220+
- CREATE OPERATOR = (
221+
- CREATE FUNCTION eql_v2."="(a jsonb, b eql_v2_encrypted)
222+
- CREATE OPERATOR = (
223+
224+
## src/operators/>.sql
225+
226+
- CREATE FUNCTION eql_v2.gt(a eql_v2_encrypted, b eql_v2_encrypted)
227+
- CREATE FUNCTION eql_v2.">"(a eql_v2_encrypted, b eql_v2_encrypted)
228+
- CREATE OPERATOR >(
229+
- CREATE FUNCTION eql_v2.">"(a eql_v2_encrypted, b jsonb)
230+
- CREATE OPERATOR >(
231+
- CREATE FUNCTION eql_v2.">"(a jsonb, b eql_v2_encrypted)
232+
- CREATE OPERATOR >(
233+
234+
## src/operators/>=.sql
235+
236+
- CREATE FUNCTION eql_v2.gte(a eql_v2_encrypted, b eql_v2_encrypted)
237+
- CREATE FUNCTION eql_v2.">="(a eql_v2_encrypted, b eql_v2_encrypted)
238+
- CREATE OPERATOR >=(
239+
- CREATE FUNCTION eql_v2.">="(a eql_v2_encrypted, b jsonb)
240+
- CREATE OPERATOR >=(
241+
- CREATE FUNCTION eql_v2.">="(a jsonb, b eql_v2_encrypted)
242+
- CREATE OPERATOR >=(
243+
244+
## src/operators/@>.sql
245+
246+
- CREATE FUNCTION eql_v2."@>"(a eql_v2_encrypted, b eql_v2_encrypted)
247+
- CREATE OPERATOR @>(
248+
249+
## src/operators/compare.sql
250+
251+
- CREATE FUNCTION eql_v2.compare(a eql_v2_encrypted, b eql_v2_encrypted)
252+
253+
## src/operators/operator_class.sql
254+
255+
- CREATE OPERATOR FAMILY eql_v2.encrypted_operator_family USING btree;
256+
- CREATE OPERATOR CLASS eql_v2.encrypted_operator_class DEFAULT FOR TYPE eql_v2_encrypted USING btree FAMILY eql_v2.encrypted_operator_family AS
257+
258+
## src/operators/order_by.sql
259+
260+
- CREATE FUNCTION eql_v2.order_by(a eql_v2_encrypted)
261+
262+
## src/operators/~~.sql
263+
264+
- CREATE FUNCTION eql_v2.like(a eql_v2_encrypted, b eql_v2_encrypted)
265+
- CREATE FUNCTION eql_v2.ilike(a eql_v2_encrypted, b eql_v2_encrypted)
266+
- CREATE FUNCTION eql_v2."~~"(a eql_v2_encrypted, b eql_v2_encrypted)
267+
- CREATE OPERATOR ~~(
268+
- CREATE OPERATOR ~~*(
269+
- CREATE FUNCTION eql_v2."~~"(a eql_v2_encrypted, b jsonb)
270+
- CREATE OPERATOR ~~(
271+
- CREATE OPERATOR ~~*(
272+
- CREATE FUNCTION eql_v2."~~"(a jsonb, b eql_v2_encrypted)
273+
- CREATE OPERATOR ~~(
274+
- CREATE OPERATOR ~~*(
275+
276+
## src/ore_block_u64_8_256/casts.sql
277+
278+
- CREATE FUNCTION eql_v2.text_to_ore_block_u64_8_256_term(t text)
279+
280+
## src/ore_block_u64_8_256/compare.sql
281+
282+
- CREATE FUNCTION eql_v2.compare_ore_block_u64_8_256(a eql_v2_encrypted, b eql_v2_encrypted)
283+
284+
## src/ore_block_u64_8_256/functions.sql
285+
286+
- CREATE FUNCTION eql_v2.jsonb_array_to_ore_block_u64_8_256(val jsonb)
287+
- CREATE FUNCTION eql_v2.ore_block_u64_8_256(val jsonb)
288+
- CREATE FUNCTION eql_v2.ore_block_u64_8_256(val eql_v2_encrypted)
289+
- CREATE FUNCTION eql_v2.has_ore_block_u64_8_256(val jsonb)
290+
- CREATE FUNCTION eql_v2.has_ore_block_u64_8_256(val eql_v2_encrypted)
291+
- CREATE FUNCTION eql_v2.compare_ore_block_u64_8_256_term(a eql_v2.ore_block_u64_8_256_term, b eql_v2.ore_block_u64_8_256_term)
292+
- CREATE FUNCTION eql_v2.compare_ore_block_u64_8_256_terms(a eql_v2.ore_block_u64_8_256_term[], b eql_v2.ore_block_u64_8_256_term[])
293+
- CREATE FUNCTION eql_v2.compare_ore_block_u64_8_256_terms(a eql_v2.ore_block_u64_8_256, b eql_v2.ore_block_u64_8_256)
294+
295+
## src/ore_block_u64_8_256/operator_class.sql
296+
297+
- CREATE OPERATOR FAMILY eql_v2.ore_block_u64_8_256_operator_family USING btree;
298+
- CREATE OPERATOR CLASS eql_v2.ore_block_u64_8_256_operator_class DEFAULT FOR TYPE eql_v2.ore_block_u64_8_256 USING btree FAMILY eql_v2.ore_block_u64_8_256_operator_family AS
299+
300+
## src/ore_block_u64_8_256/operators.sql
301+
302+
- CREATE FUNCTION eql_v2.ore_block_u64_8_256_eq(a eql_v2.ore_block_u64_8_256, b eql_v2.ore_block_u64_8_256)
303+
- CREATE FUNCTION eql_v2.ore_block_u64_8_256_neq(a eql_v2.ore_block_u64_8_256, b eql_v2.ore_block_u64_8_256)
304+
- CREATE FUNCTION eql_v2.ore_block_u64_8_256_lt(a eql_v2.ore_block_u64_8_256, b eql_v2.ore_block_u64_8_256)
305+
- CREATE FUNCTION eql_v2.ore_block_u64_8_256_lte(a eql_v2.ore_block_u64_8_256, b eql_v2.ore_block_u64_8_256)
306+
- CREATE FUNCTION eql_v2.ore_block_u64_8_256_gt(a eql_v2.ore_block_u64_8_256, b eql_v2.ore_block_u64_8_256)
307+
- CREATE FUNCTION eql_v2.ore_block_u64_8_256_gte(a eql_v2.ore_block_u64_8_256, b eql_v2.ore_block_u64_8_256)
308+
- CREATE OPERATOR = (
309+
- CREATE OPERATOR <> (
310+
- CREATE OPERATOR > (
311+
- CREATE OPERATOR < (
312+
- CREATE OPERATOR <= (
313+
- CREATE OPERATOR >= (
314+
315+
## src/ore_block_u64_8_256/types.sql
316+
317+
- CREATE TYPE eql_v2.ore_block_u64_8_256_term AS (
318+
- CREATE TYPE eql_v2.ore_block_u64_8_256 AS (
319+
320+
## src/ore_cllw_u64_8/compare.sql
321+
322+
- CREATE FUNCTION eql_v2.compare_ore_cllw_u64_8(a eql_v2_encrypted, b eql_v2_encrypted)
323+
324+
## src/ore_cllw_u64_8/functions.sql
325+
326+
- CREATE FUNCTION eql_v2.ore_cllw_u64_8(val jsonb)
327+
- CREATE FUNCTION eql_v2.ore_cllw_u64_8(val eql_v2_encrypted)
328+
- CREATE FUNCTION eql_v2.has_ore_cllw_u64_8(val jsonb)
329+
- CREATE FUNCTION eql_v2.has_ore_cllw_u64_8(val eql_v2_encrypted)
330+
- CREATE FUNCTION eql_v2.compare_ore_cllw_term_bytes(a bytea, b bytea)
331+
332+
## src/ore_cllw_u64_8/types.sql
333+
334+
- CREATE TYPE eql_v2.ore_cllw_u64_8 AS (
335+
336+
## src/ore_cllw_var_8/compare.sql
337+
338+
- CREATE FUNCTION eql_v2.compare_ore_cllw_var_8(a eql_v2_encrypted, b eql_v2_encrypted)
339+
340+
## src/ore_cllw_var_8/functions.sql
341+
342+
- CREATE FUNCTION eql_v2.ore_cllw_var_8(val jsonb)
343+
- CREATE FUNCTION eql_v2.ore_cllw_var_8(val eql_v2_encrypted)
344+
- CREATE FUNCTION eql_v2.has_ore_cllw_var_8(val jsonb)
345+
- CREATE FUNCTION eql_v2.has_ore_cllw_var_8(val eql_v2_encrypted)
346+
- CREATE FUNCTION eql_v2.compare_ore_cllw_var_8_term(a eql_v2.ore_cllw_var_8, b eql_v2.ore_cllw_var_8)
347+
348+
## src/ore_cllw_var_8/types.sql
349+
350+
- CREATE TYPE eql_v2.ore_cllw_var_8 AS (
351+
352+
## src/schema.sql
353+
354+
355+
## src/ste_vec/functions.sql
356+
357+
- CREATE FUNCTION eql_v2.ste_vec(val jsonb)
358+
- CREATE FUNCTION eql_v2.ste_vec(val eql_v2_encrypted)
359+
- CREATE FUNCTION eql_v2.is_ste_vec_value(val jsonb)
360+
- CREATE FUNCTION eql_v2.is_ste_vec_value(val eql_v2_encrypted)
361+
- CREATE FUNCTION eql_v2.to_ste_vec_value(val jsonb)
362+
- CREATE FUNCTION eql_v2.to_ste_vec_value(val eql_v2_encrypted)
363+
- CREATE FUNCTION eql_v2.selector(val jsonb)
364+
- CREATE FUNCTION eql_v2.selector(val eql_v2_encrypted)
365+
- CREATE FUNCTION eql_v2.is_ste_vec_array(val jsonb)
366+
- CREATE FUNCTION eql_v2.is_ste_vec_array(val eql_v2_encrypted)
367+
- CREATE FUNCTION eql_v2.ste_vec_contains(a eql_v2_encrypted[], b eql_v2_encrypted)
368+
- CREATE FUNCTION eql_v2.ste_vec_contains(a eql_v2_encrypted, b eql_v2_encrypted)
369+
370+
## Summary
371+
372+
- Total files: 52
373+
- Total CREATE statements: 219

0 commit comments

Comments
 (0)