Docs

DataBiosphere · Dec 10, 2024 · fa6f428 · fa6f428
1 parent 9fce665
commit fa6f428
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/generated/UNDERLAY_CONFIG.md b/docs/generated/UNDERLAY_CONFIG.md
@@ -590,6 +590,13 @@ The typical use case for this is to optimize cohort breakdown queries on the pri
 
 You can currently specify a maximum of four attributes, because we implement this using BigQuery clustering which has this [limitation](https://cloud.google.com/bigquery/docs/clustered-tables#limitations).
 
+### SZEntity.optimizeSearchByAttributes
+**optional** List [ String ]
+
+List of attributes to optimize for search queries.
+
+The typical use case for this is to optimize attribute based search on large entity tables that cannot be optimised for search on multiple attribute fields. For example, to optimize search on the variant table using attributes values for gene, rs_number and genomic_location. 
+
 ### SZEntity.sourceQueryTableName
 **optional** String
 

diff --git a/ui/src/tanagra-underlay/underlayConfig.ts b/ui/src/tanagra-underlay/underlayConfig.ts
@@ -102,6 +102,7 @@ export type SZEntity = {
   idAttribute: string;
   name: string;
   optimizeGroupByAttributes?: string[];
+  optimizeSearchByAttributes?: string[];
   sourceQueryTableName?: string;
   temporalQuery?: SZTemporalQuery;
   textSearch?: SZTextSearch;