refactor: rename add_index to add_search_term

Author: tobyhede

README.md

@@ -191,10 +191,10 @@ In order to perform searchable operations on encrypted data, you must configure
 
 ### Adding an index
 
-Add an index to an encrypted column using the `eql_v2.add_index` function:
+Add an index to an encrypted column using the `eql_v2.add_search_term` function:
 
 ```sql
-SELECT eql_v2.add_index(
+SELECT eql_v2.add_search_term(
   'table_name',       -- Name of the table
   'column_name',      -- Name of the column
   'index_name',       -- Index kind ('unique', 'match', 'ore', 'ste_vec')
@@ -208,7 +208,7 @@ You can read more about the index configuration options [here](docs/reference/IN
 **Example (Unique index):**
 
 ```sql
-SELECT eql_v2.add_index(
+SELECT eql_v2.add_search_term(
   'users',
   'encrypted_email',
   'unique',
@@ -236,7 +236,7 @@ Enable equality search on encrypted data using the `eql_v2.unique` function.
 **Index configuration example:**
 
 ```sql
-SELECT eql_v2.add_index(
+SELECT eql_v2.add_search_term(
   'users',
   'encrypted_email',
   'unique',
@@ -266,7 +266,7 @@ Enables basic full-text search on encrypted data using the `eql_v2.match` functi
 **Index configuration example:**
 
 ```sql
-SELECT eql_v2.add_index(
+SELECT eql_v2.add_search_term(
   'users',
   'encrypted_email',
   'match',

src/config/config_test.sql

@@ -25,23 +25,23 @@ DO $$
   BEGIN
 
     -- Add indexes
-    PERFORM eql_v2.add_index('users', 'name', 'match');
+    PERFORM eql_v2.add_search_term('users', 'name', 'match');
     ASSERT (SELECT _index_exists('users', 'name', 'match'));
 
     -- Add index with cast
-    PERFORM eql_v2.add_index('users', 'name', 'unique', 'int');
+    PERFORM eql_v2.add_search_term('users', 'name', 'unique', 'int');
     ASSERT (SELECT _index_exists('users', 'name', 'unique'));
 
     ASSERT (SELECT EXISTS (SELECT id FROM eql_v2_configuration c
             WHERE c.state = 'pending' AND
             c.data #> array['tables', 'users', 'name'] ? 'cast_as'));
 
     -- Match index removed
-    PERFORM eql_v2.remove_index('users', 'name', 'match');
+    PERFORM eql_v2.remove_search_term('users', 'name', 'match');
     ASSERT NOT (SELECT _index_exists('users', 'name', 'match'));
 
     -- All indexes removed, delete the emtpty pending config
-    PERFORM eql_v2.remove_index('users', 'name', 'unique');
+    PERFORM eql_v2.remove_search_term('users', 'name', 'unique');
     ASSERT (SELECT NOT EXISTS (SELECT FROM eql_v2_configuration c WHERE c.state = 'pending'));
 
   END;
@@ -60,15 +60,15 @@ DO $$
   BEGIN
 
     -- Add indexes
-    PERFORM eql_v2.add_index('users', 'name', 'match');
+    PERFORM eql_v2.add_search_term('users', 'name', 'match');
     ASSERT (SELECT _index_exists('users', 'name', 'match'));
 
     ASSERT (SELECT EXISTS (SELECT id FROM eql_v2_configuration c
             WHERE c.state = 'pending' AND
             c.data #> array['tables', 'users', 'name', 'indexes'] ? 'match'));
 
     -- Add index with cast
-    PERFORM eql_v2.add_index('blah', 'vtha', 'unique', 'int');
+    PERFORM eql_v2.add_search_term('blah', 'vtha', 'unique', 'int');
     ASSERT (SELECT _index_exists('blah', 'vtha', 'unique'));
 
     ASSERT (SELECT EXISTS (SELECT id FROM eql_v2_configuration c
@@ -82,11 +82,11 @@ DO $$
 
 
     -- Match index removed
-    PERFORM eql_v2.remove_index('users', 'name', 'match');
+    PERFORM eql_v2.remove_search_term('users', 'name', 'match');
     ASSERT NOT (SELECT _index_exists('users', 'name', 'match'));
 
     -- Match index removed
-    PERFORM eql_v2.remove_index('blah', 'vtha', 'unique');
+    PERFORM eql_v2.remove_search_term('blah', 'vtha', 'unique');
     ASSERT NOT (SELECT _index_exists('users', 'vtha', 'unique'));
 
     -- All indexes removed, delete the emtpty pending config
@@ -107,11 +107,11 @@ $$ LANGUAGE plpgsql;
 
 DO $$
   BEGIN
-    PERFORM eql_v2.add_index('users', 'name', 'match');
+    PERFORM eql_v2.add_search_term('users', 'name', 'match');
     ASSERT (SELECT _index_exists('users', 'name', 'match'));
 
     -- Pending configuration contains the path `user/name.match.option`
-    PERFORM eql_v2.modify_index('users', 'name', 'match', 'int', '{"option": "value"}'::jsonb);
+    PERFORM eql_v2.modify_search_term('users', 'name', 'match', 'int', '{"option": "value"}'::jsonb);
     ASSERT (SELECT _index_exists('users', 'name', 'match'));
 
     ASSERT (SELECT EXISTS (SELECT id FROM eql_v2_configuration c
@@ -123,7 +123,7 @@ DO $$
             c.data #> array['tables', 'users', 'name'] ? 'cast_as'));
 
     -- All indexes removed, delete the emtpty pending config
-    PERFORM eql_v2.remove_index('users', 'name', 'match');
+    PERFORM eql_v2.remove_search_term('users', 'name', 'match');
     ASSERT (SELECT NOT EXISTS (SELECT FROM eql_v2_configuration c WHERE c.state = 'pending'));
   END;
 $$ LANGUAGE plpgsql;
@@ -162,7 +162,7 @@ DO $$
   BEGIN
     ASSERT (SELECT _index_exists('users', 'blah', 'match', 'active'));
 
-    PERFORM eql_v2.add_index('users', 'name', 'match');
+    PERFORM eql_v2.add_search_term('users', 'name', 'match');
 
     -- index added to name
     ASSERT (SELECT _index_exists('users', 'name', 'match' ));

src/config/functions.sql

@@ -1,104 +1,16 @@
 -- REQUIRE: src/config/types.sql
+-- REQUIRE: src/config/functions_private.sql
 --
--- Configuration functions
+-- Customer-facing configuration functions
+-- Depends on private functions for implemenation
 --
 --
 
-
-CREATE FUNCTION eql_v2.config_default(config jsonb)
-  RETURNS jsonb
-  IMMUTABLE PARALLEL SAFE
-AS $$
-  BEGIN
-    IF config IS NULL THEN
-      SELECT jsonb_build_object('v', 1, 'tables', jsonb_build_object()) INTO config;
-    END IF;
-    RETURN config;
-  END;
-$$ LANGUAGE plpgsql;
-
-
-
-CREATE FUNCTION eql_v2.config_add_table(table_name text, config jsonb)
-  RETURNS jsonb
-  IMMUTABLE PARALLEL SAFE
-AS $$
-  DECLARE
-    tbl jsonb;
-  BEGIN
-    IF NOT config #> array['tables'] ? table_name THEN
-      SELECT jsonb_insert(config, array['tables', table_name], jsonb_build_object()) INTO config;
-    END IF;
-    RETURN config;
-  END;
-$$ LANGUAGE plpgsql;
-
-
--- Add the column if it doesn't exist
-
-CREATE FUNCTION eql_v2.config_add_column(table_name text, column_name text, config jsonb)
-  RETURNS jsonb
-  IMMUTABLE PARALLEL SAFE
-AS $$
-  DECLARE
-    col jsonb;
-  BEGIN
-    IF NOT config #> array['tables', table_name] ? column_name THEN
-      SELECT jsonb_build_object('indexes', jsonb_build_object()) into col;
-      SELECT jsonb_set(config, array['tables', table_name, column_name], col) INTO config;
-    END IF;
-    RETURN config;
-  END;
-$$ LANGUAGE plpgsql;
-
-
--- Set the cast
-
-CREATE FUNCTION eql_v2.config_add_cast(table_name text, column_name text, cast_as text, config jsonb)
-  RETURNS jsonb
-  IMMUTABLE PARALLEL SAFE
-AS $$
-  BEGIN
-    SELECT jsonb_set(config, array['tables', table_name, column_name, 'cast_as'], to_jsonb(cast_as)) INTO config;
-    RETURN config;
-  END;
-$$ LANGUAGE plpgsql;
-
-
--- Add the column if it doesn't exist
-
-CREATE FUNCTION eql_v2.config_add_index(table_name text, column_name text, index_name text, opts jsonb, config jsonb)
-  RETURNS jsonb
-  IMMUTABLE PARALLEL SAFE
-AS $$
-  BEGIN
-    SELECT jsonb_insert(config, array['tables', table_name, column_name, 'indexes', index_name], opts) INTO config;
-    RETURN config;
-  END;
-$$ LANGUAGE plpgsql;
-
-
---
--- Default options for match index
---
-
-CREATE FUNCTION eql_v2.config_match_default()
-  RETURNS jsonb
-LANGUAGE sql STRICT PARALLEL SAFE
-BEGIN ATOMIC
-  SELECT jsonb_build_object(
-            'k', 6,
-            'm', 2048,
-            'include_original', true,
-            'tokenizer', json_build_object('kind', 'ngram', 'token_length', 3),
-            'token_filters', json_build_array(json_build_object('kind', 'downcase')));
-END;
-
 --
 -- Adds an index term to the configuration
 --
 
-CREATE FUNCTION eql_v2.add_index(table_name text, column_name text, index_name text, cast_as text DEFAULT 'text', opts jsonb DEFAULT '{}')
+CREATE FUNCTION eql_v2.add_search_term(table_name text, column_name text, index_name text, cast_as text DEFAULT 'text', opts jsonb DEFAULT '{}')
   RETURNS jsonb
 
 AS $$
@@ -149,7 +61,7 @@ $$ LANGUAGE plpgsql;
 
 
 
-CREATE FUNCTION eql_v2.remove_index(table_name text, column_name text, index_name text)
+CREATE FUNCTION eql_v2.remove_search_term(table_name text, column_name text, index_name text)
   RETURNS jsonb
 AS $$
   DECLARE
@@ -209,12 +121,12 @@ $$ LANGUAGE plpgsql;
 
 
 
-CREATE FUNCTION eql_v2.modify_index(table_name text, column_name text, index_name text, cast_as text DEFAULT 'text', opts jsonb DEFAULT '{}')
+CREATE FUNCTION eql_v2.modify_search_term(table_name text, column_name text, index_name text, cast_as text DEFAULT 'text', opts jsonb DEFAULT '{}')
   RETURNS jsonb
 AS $$
   BEGIN
-    PERFORM eql_v2.remove_index(table_name, column_name, index_name);
-    RETURN eql_v2.add_index(table_name, column_name, index_name, cast_as, opts);
+    PERFORM eql_v2.remove_search_term(table_name, column_name, index_name);
+    RETURN eql_v2.add_search_term(table_name, column_name, index_name, cast_as, opts);
   END;
 $$ LANGUAGE plpgsql;
 

src/config/functions_private.sql

@@ -0,0 +1,95 @@
+-- REQUIRE: src/config/types.sql
+--
+-- Private configuration functions
+-- Internal implemention details that customers should not need to worry about.
+--
+--
+
+CREATE FUNCTION eql_v2.config_default(config jsonb)
+  RETURNS jsonb
+  IMMUTABLE PARALLEL SAFE
+AS $$
+  BEGIN
+    IF config IS NULL THEN
+      SELECT jsonb_build_object('v', 1, 'tables', jsonb_build_object()) INTO config;
+    END IF;
+    RETURN config;
+  END;
+$$ LANGUAGE plpgsql;
+
+
+
+CREATE FUNCTION eql_v2.config_add_table(table_name text, config jsonb)
+  RETURNS jsonb
+  IMMUTABLE PARALLEL SAFE
+AS $$
+  DECLARE
+    tbl jsonb;
+  BEGIN
+    IF NOT config #> array['tables'] ? table_name THEN
+      SELECT jsonb_insert(config, array['tables', table_name], jsonb_build_object()) INTO config;
+    END IF;
+    RETURN config;
+  END;
+$$ LANGUAGE plpgsql;
+
+
+-- Add the column if it doesn't exist
+
+CREATE FUNCTION eql_v2.config_add_column(table_name text, column_name text, config jsonb)
+  RETURNS jsonb
+  IMMUTABLE PARALLEL SAFE
+AS $$
+  DECLARE
+    col jsonb;
+  BEGIN
+    IF NOT config #> array['tables', table_name] ? column_name THEN
+      SELECT jsonb_build_object('indexes', jsonb_build_object()) into col;
+      SELECT jsonb_set(config, array['tables', table_name, column_name], col) INTO config;
+    END IF;
+    RETURN config;
+  END;
+$$ LANGUAGE plpgsql;
+
+
+-- Set the cast
+
+CREATE FUNCTION eql_v2.config_add_cast(table_name text, column_name text, cast_as text, config jsonb)
+  RETURNS jsonb
+  IMMUTABLE PARALLEL SAFE
+AS $$
+  BEGIN
+    SELECT jsonb_set(config, array['tables', table_name, column_name, 'cast_as'], to_jsonb(cast_as)) INTO config;
+    RETURN config;
+  END;
+$$ LANGUAGE plpgsql;
+
+
+-- Add the column if it doesn't exist
+
+CREATE FUNCTION eql_v2.config_add_index(table_name text, column_name text, index_name text, opts jsonb, config jsonb)
+  RETURNS jsonb
+  IMMUTABLE PARALLEL SAFE
+AS $$
+  BEGIN
+    SELECT jsonb_insert(config, array['tables', table_name, column_name, 'indexes', index_name], opts) INTO config;
+    RETURN config;
+  END;
+$$ LANGUAGE plpgsql;
+
+
+--
+-- Default options for match index
+--
+
+CREATE FUNCTION eql_v2.config_match_default()
+  RETURNS jsonb
+LANGUAGE sql STRICT PARALLEL SAFE
+BEGIN ATOMIC
+  SELECT jsonb_build_object(
+            'k', 6,
+            'm', 2048,
+            'include_original', true,
+            'tokenizer', json_build_object('kind', 'ngram', 'token_length', 3),
+            'token_filters', json_build_array(json_build_object('kind', 'downcase')));
+END;

src/encryptindex/functions_test.sql

@@ -154,7 +154,7 @@ CREATE TABLE users
 -- An encrypting config should exist
 DO $$
   BEGIN
-    PERFORM eql_v2.add_index('users', 'name', 'match');
+    PERFORM eql_v2.add_search_term('users', 'name', 'match');
     PERFORM eql_v2.encrypt();
 
     ASSERT (SELECT EXISTS (SELECT FROM eql_v2_configuration c WHERE c.state = 'active'));
@@ -204,7 +204,7 @@ CREATE TABLE users
 -- An encrypting config should exist
 DO $$
   BEGIN
-    PERFORM eql_v2.add_index('users', 'name', 'match');
+    PERFORM eql_v2.add_search_term('users', 'name', 'match');
     PERFORM eql_v2.encrypt();
 
     ASSERT (SELECT EXISTS (SELECT FROM eql_v2_configuration c WHERE c.state = 'active'));
@@ -254,7 +254,7 @@ CREATE TABLE users
 -- An encrypting config should exist
 DO $$
   BEGIN
-    PERFORM eql_v2.add_index('users', 'name', 'match');
+    PERFORM eql_v2.add_search_term('users', 'name', 'match');
 
     PERFORM eql_v2.encrypt(); -- need to encrypt first
     PERFORM eql_v2.activate();