Add config section for reader performance query option

ral-facilities · Sep 18, 2024 · 720dbf4 · 720dbf4
1 parent 43f50e4
commit 720dbf4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/datagateway_api/config.yaml.example b/datagateway_api/config.yaml.example
@@ -8,6 +8,11 @@ datagateway_api:
   db_url: "mysql+pymysql://icatdbuser:icatdbuserpw@localhost:3306/icatdb"
   icat_url: "https://localhost:8181"
   icat_check_cert: false
+  use_reader_for_performance:
+    enabled: false
+    reader_mechanism: simple
+    reader_username: reader
+    reader_password: readerpw
 search_api:
   extension: "/search-api"
   icat_url: "https://localhost:8181"

diff --git a/datagateway_api/src/common/config.py b/datagateway_api/src/common/config.py
@@ -38,6 +38,13 @@ def validate_extension(extension):
     return extension
 
 
+class UseReaderForPerformance(BaseModel):
+    enabled: StrictBool
+    reader_mechanism: StrictStr
+    reader_username: StrictStr
+    reader_password: StrictStr
+
+
 class DataGatewayAPI(BaseModel):
     """
     Configuration model class that implements pydantic's BaseModel class to allow for
@@ -54,6 +61,7 @@ class DataGatewayAPI(BaseModel):
     extension: StrictStr
     icat_check_cert: Optional[StrictBool]
     icat_url: Optional[StrictStr]
+    use_reader_for_performance: Optional[UseReaderForPerformance]
 
     _validate_extension = validator("extension", allow_reuse=True)(validate_extension)