Add query.get_queries

Author: labkey-alan

labkey/query.py

@@ -40,6 +40,8 @@
 
 ############################################################################
 """
+
+from dataclasses import dataclass, asdict
 import functools
 from typing import List, Literal, NotRequired, TextIO, TypedDict
 
@@ -60,6 +62,7 @@ class Pagination:
     ALL = "all"
     NONE = "none"
 
+
 # TODO: Provide filter generators.
 #
 # There are some inconsistencies between the different filter types with multiple values,
@@ -143,7 +146,6 @@ class Types:
         ARRAY_ISEMPTY = "arrayisempty"
         ARRAY_ISNOTEMPTY = "arrayisnotempty"
 
-
         # Table/Query-wise operators
         Q = "q"
 
@@ -704,6 +706,32 @@ def move_rows(
     )
 
 
+@dataclass
+class GetQueriesOptions:
+    include_columns: bool
+    include_system_queries: bool
+    include_title: bool
+    include_user_queries: bool
+    include_view_data_url: bool
+    query_detail_columns: bool
+
+
+def get_queries(
+    server_context: ServerContext,
+    schema_name: str,
+    container_path: str = None,
+    options: GetQueriesOptions = None,
+    timeout=_default_timeout,
+) -> dict:
+    url = server_context.build_url("query", "getQueries.api", container_path=container_path)
+    payload = {"schemaName": schema_name}
+
+    if options is not None:
+        payload = {*payload, *asdict(options)}
+
+    return server_context.make_request(url, payload, timeout=timeout)
+
+
 class QueryWrapper:
     """
     Wrapper for all of the API methods exposed in the query module. Used by the APIWrapper class.
@@ -939,3 +967,13 @@ def move_rows(
             audit_user_comment,
             timeout,
         )
+
+    @functools.wraps(get_queries)
+    def get_queries(
+        self,
+        schema_name: str,
+        container_path: str = None,
+        options: GetQueriesOptions = None,
+        timeout=_default_timeout,
+    ):
+        return get_queries(self.server_context, schema_name, container_path, options, timeout)

test/integration/test_query.py

@@ -411,3 +411,30 @@ def test_api_save_rows(api: APIWrapper, blood_sample_type_fixture, tissue_sample
     assert resp["result"][2]["rowsAffected"] == 1
     assert resp["result"][2]["rows"][0]["rowid"] == first_tissue_row_id
     assert resp["result"][2]["rows"][0]["receiveddate"] == "2025-07-07 12:34:56.000"
+
+
+expected_fields = {
+    "canEdit",
+    "canEditSharedViews",
+    "columns",
+    "hidden",
+    "inherit",
+    "isIncludedForLookups",
+    "isInherited",
+    "isMetadataOverrideable",
+    "isUserDefined",
+    "moduleName",
+    "name",
+    "snapshot",
+    "title",
+    "viewDataUrl",
+}
+
+
+def test_get_queries(api: APIWrapper):
+    resp = api.query.get_queries("core")
+
+    assert set(resp.keys()) == {"schemaName", "queries"}
+    assert resp["schemaName"] == "core"
+    assert len(resp["queries"]) > 0
+    assert set(resp["queries"][0].keys()) == set(expected_fields)