Merge pull request #3708 from mathesar-foundation/records_search_rank

Add `records.search` RPC function
mathesar-foundation · Aug 2, 2024 · 7f67921 · 7f67921
2 parents 0c81a08 + 1718a5f
commit 7f67921
Show file tree

Hide file tree

Showing 7 changed files with 402 additions and 29 deletions.
diff --git a/db/records/operations/select.py b/db/records/operations/select.py
@@ -19,7 +19,6 @@ def list_records_from_table(
         order=None,
         filter=None,
         group=None,
-        search=None,
 ):
     """
     Get records from a table.
@@ -37,7 +36,6 @@ def list_records_from_table(
         order: An array of ordering definition objects.
         filter: An array of filter definition objects.
         group: An array of group definition objects.
-        search: An array of search definition objects.
     """
     result = db_conn.exec_msar_func(
         conn,
@@ -48,7 +46,32 @@ def list_records_from_table(
         json.dumps(order) if order is not None else None,
         json.dumps(filter) if filter is not None else None,
         json.dumps(group) if group is not None else None,
-        json.dumps(search) if search is not None else None,
+    ).fetchone()[0]
+    return result
+
+
+def search_records_from_table(
+        conn,
+        table_oid,
+        search=[],
+        limit=10,
+):
+    """
+    Get records from a table, according to a search specification
+
+    Only data from which the user is granted `SELECT` is returned.
+
+    Args:
+        tab_id: The OID of the table whose records we'll get.
+        search: A list of dictionaries defining a search.
+        limit: The maximum number of rows we'll return.
+
+    The search definition objects should have the form
+    {"attnum": <int>, "literal": <text>}
+    """
+    search = search or []
+    result = db_conn.exec_msar_func(
+        conn, 'search_records_from_table', table_oid, json.dumps(search), limit
     ).fetchone()[0]
     return result
 

diff --git a/db/sql/00_msar.sql b/db/sql/00_msar.sql
@@ -3399,18 +3399,13 @@ $$ LANGUAGE SQL RETURNS NULL ON NULL INPUT;
 
 
 CREATE OR REPLACE FUNCTION
-msar.build_order_by_expr(tab_id oid, order_ jsonb) RETURNS text AS $$/*
-Build an ORDER BY expression for the given table and order JSON.
-
-The ORDER BY expression will refer to columns by their attnum. This is designed to work together
-with `msar.build_selectable_column_expr`. It will only use the columns to which the user has access.
-Finally, this function will append either a primary key, or all columns to the produced ORDER BY so
-the resulting ordering is totally defined (i.e., deterministic).
-
+msar.build_total_order_expr(tab_id oid, order_ jsonb) RETURNS text AS $$/*
+Build a deterministic order expression for the given table and order JSON.
 Args:
   tab_id: The OID of the table whose columns we'll order by.
+  order_: A JSONB array defining any desired ordering of columns.
 */
-SELECT 'ORDER BY ' || string_agg(format('%I %s', attnum, msar.sanitize_direction(direction)), ', ')
+SELECT string_agg(format('%I %s', attnum, msar.sanitize_direction(direction)), ', ')
 FROM jsonb_to_recordset(
     COALESCE(
       COALESCE(order_, '[]'::jsonb) || msar.get_pkey_order(tab_id),
@@ -3422,6 +3417,23 @@ WHERE has_column_privilege(tab_id, attnum, 'SELECT');
 $$ LANGUAGE SQL;
 
 
+CREATE OR REPLACE FUNCTION
+msar.build_order_by_expr(tab_id oid, order_ jsonb) RETURNS text AS $$/*
+Build an ORDER BY expression for the given table and order JSON.
+
+The ORDER BY expression will refer to columns by their attnum. This is designed to work together
+with `msar.build_selectable_column_expr`. It will only use the columns to which the user has access.
+Finally, this function will append either a primary key, or all columns to the produced ORDER BY so
+the resulting ordering is totally defined (i.e., deterministic).
+
+Args:
+  tab_id: The OID of the table whose columns we'll order by.
+  order_: A JSONB array defining any desired ordering of columns.
+*/
+SELECT 'ORDER BY ' || msar.build_total_order_expr(tab_id, order_)
+$$ LANGUAGE SQL;
+
+
 CREATE OR REPLACE FUNCTION
 msar.build_selectable_column_expr(tab_id oid) RETURNS text AS $$/*
 Build an SQL select-target expression of only columns to which the user has access.
@@ -3451,8 +3463,7 @@ msar.list_records_from_table(
   offset_ integer,
   order_ jsonb,
   filter_ jsonb,
-  group_ jsonb,
-  search_ jsonb
+  group_ jsonb
 ) RETURNS jsonb AS $$/*
 Get records from a table. Only columns to which the user has access are returned.
 
@@ -3463,7 +3474,6 @@ Args:
   order_: An array of ordering definition objects.
   filter_: An array of filter definition objects.
   group_: An array of group definition objects.
-  search_: An array of search definition objects.
 
 The order definition objects should have the form
   {"attnum": <int>, "direction": <text>}
@@ -3479,8 +3489,8 @@ BEGIN
       SELECT %1$s FROM %2$I.%3$I %7$s %6$s LIMIT %4$L OFFSET %5$L
     )
     SELECT jsonb_build_object(
-      'results', jsonb_agg(row_to_json(results_cte.*)),
-      'count', max(count_cte.count),
+      'results', coalesce(jsonb_agg(row_to_json(results_cte.*)), jsonb_build_array()),
+      'count', coalesce(max(count_cte.count), 0),
       'query', $iq$SELECT %1$s FROM %2$I.%3$I %7$s %6$s LIMIT %4$L OFFSET %5$L$iq$
     )
     FROM results_cte, count_cte
@@ -3496,3 +3506,82 @@ BEGIN
   RETURN records;
 END;
 $$ LANGUAGE plpgsql;
+
+
+CREATE OR REPLACE FUNCTION
+msar.get_score_expr(tab_id oid, parameters_ jsonb) RETURNS text AS $$
+SELECT string_agg(
+  CASE WHEN pgt.typcategory = 'S' THEN
+    format(
+      $s$(CASE
+        WHEN %1$I ILIKE %2$L THEN 4
+        WHEN %1$I ILIKE %2$L || '%%' THEN 3
+        WHEN %1$I ILIKE '%%' || %2$L || '%%' THEN 2
+        ELSE 0
+      END)$s$,
+      pga.attname,
+      x.literal
+    )
+  ELSE
+    format('(CASE WHEN %1$I = %2$L THEN 4 ELSE 0 END)', pga.attname, x.literal)
+  END,
+  ' + '
+)
+FROM jsonb_to_recordset(parameters_) AS x(attnum smallint, literal text)
+  INNER JOIN pg_catalog.pg_attribute AS pga ON x.attnum = pga.attnum
+  INNER JOIN pg_catalog.pg_type AS pgt ON pga.atttypid = pgt.oid
+WHERE
+  pga.attrelid = tab_id
+  AND NOT pga.attisdropped
+  AND has_column_privilege(tab_id, x.attnum, 'SELECT')
+$$ LANGUAGE SQL STABLE RETURNS NULL ON NULL INPUT;
+
+
+CREATE OR REPLACE FUNCTION
+msar.search_records_from_table(
+  tab_id oid,
+  search_ jsonb,
+  limit_ integer
+) RETURNS jsonb AS $$/*
+Get records from a table, filtering and sorting according to a search specification.
+
+Only columns to which the user has access are returned.
+
+Args:
+  tab_id: The OID of the table whose records we'll get
+  search_: An array of search definition objects.
+  limit_: The maximum number of rows we'll return.
+
+The search definition objects should have the form
+  {"attnum": <int>, "literal": <any>}
+*/
+DECLARE
+  records jsonb;
+BEGIN
+  EXECUTE format(
+    $q$
+    WITH count_cte AS (
+      SELECT count(1) AS count FROM %2$I.%3$I %4$s
+    ), results_cte AS (
+      SELECT %1$s FROM %2$I.%3$I %4$s ORDER BY %6$s LIMIT %5$L
+    )
+    SELECT jsonb_build_object(
+      'results', coalesce(jsonb_agg(row_to_json(results_cte.*)), jsonb_build_array()),
+      'count', coalesce(max(count_cte.count), 0),
+      'query', $iq$SELECT %1$s FROM %2$I.%3$I %4$s ORDER BY %6$s LIMIT %5$L$iq$
+    )
+    FROM results_cte, count_cte
+    $q$,
+    msar.build_selectable_column_expr(tab_id),
+    msar.get_relation_schema_name(tab_id),
+    msar.get_relation_name(tab_id),
+    'WHERE ' || msar.get_score_expr(tab_id, search_) || ' > 0',
+    limit_,
+    concat(
+      msar.get_score_expr(tab_id, search_) || ' DESC, ',
+      msar.build_total_order_expr(tab_id, null)
+    )
+  ) INTO records;
+  RETURN records;
+END;
+$$ LANGUAGE plpgsql;