ds-caselaw-marklogic-api-client 27.2.0__tar.gz → 27.3.0__tar.gz

{ds_caselaw_marklogic_api_client-27.2.0 → ds_caselaw_marklogic_api_client-27.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 27.2.0
+Version: 27.3.0
 Summary: An API client for interacting with the underlying data in Find Caselaw.
 Home-page: https://github.com/nationalarchives/ds-caselaw-custom-api-client
 Keywords: national archives,caselaw

{ds_caselaw_marklogic_api_client-27.2.0 → ds_caselaw_marklogic_api_client-27.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ds-caselaw-marklogic-api-client"
-version = "27.2.0"
+version = "27.3.0"
 description = "An API client for interacting with the underlying data in Find Caselaw."
 authors = ["The National Archives"]
 homepage = "https://github.com/nationalarchives/ds-caselaw-custom-api-client"
@@ -42,7 +42,7 @@ moto = {version = "^5.0.1", extras = ["all"]}
 optional = true
 
 [tool.poetry.group.docs.dependencies]
-pdoc = "^14.0.0"
+pdoc = "^15.0.0"
 
 
 [tool.commitizen]

{ds_caselaw_marklogic_api_client-27.2.0 → ds_caselaw_marklogic_api_client-27.3.0}/src/caselawclient/Client.py

@@ -217,10 +217,10 @@ class MarklogicApiClient:
     def get_document_by_uri(
         self,
         uri: DocumentURIString,
-        query: Optional[str] = None,
+        search_query: Optional[str] = None,
     ) -> Document:
         document_type_class = self.get_document_type_from_uri(uri)
-        return document_type_class(uri, self)
+        return document_type_class(uri, self, search_query=search_query)
 
     def get_document_type_from_uri(self, uri: DocumentURIString) -> Type[Document]:
         vars: query_dicts.DocumentCollectionsDict = {
@@ -1080,6 +1080,7 @@ class MarklogicApiClient:
         self,
         target_enrichment_version: tuple[int, int],
         target_parser_version: tuple[int, int],
+        maximum_records: int = 1000,
     ) -> list[list[Any]]:
         """Retrieve documents which are not yet enriched with a given version."""
         vars: query_dicts.GetPendingEnrichmentForVersionDict = {
@@ -1087,6 +1088,7 @@ class MarklogicApiClient:
             "target_enrichment_minor_version": target_enrichment_version[1],
             "target_parser_major_version": target_parser_version[0],
             "target_parser_minor_version": target_parser_version[1],
+            "maximum_records": maximum_records,
         }
         results: list[list[Any]] = json.loads(
             get_single_string_from_marklogic_response(
@@ -1115,11 +1117,13 @@ class MarklogicApiClient:
     def get_pending_parse_for_version(
         self,
         target_version: tuple[int, int],
+        maximum_records: int = 1000,
     ) -> list[list[Any]]:
         """Retrieve documents which are not yet parsed with a given version."""
         vars: query_dicts.GetPendingParseForVersionDict = {
             "target_major_version": target_version[0],
             "target_minor_version": target_version[1],
+            "maximum_records": maximum_records,
         }
         results: list[list[Any]] = json.loads(
             get_single_string_from_marklogic_response(

{ds_caselaw_marklogic_api_client-27.2.0 → ds_caselaw_marklogic_api_client-27.3.0}/src/caselawclient/xquery/get_pending_enrichment_for_version.xqy

@@ -1,9 +1,11 @@
 xquery version "1.0-ml";
 
+declare namespace xdmp="http://marklogic.com/xdmp"; 
 declare variable $target_enrichment_major_version as xs:int external;
 declare variable $target_enrichment_minor_version as xs:int external;
 declare variable $target_parser_major_version as xs:int external;
 declare variable $target_parser_minor_version as xs:int external;
+declare variable $maximum_records as xs:int? external := 1000;
 
 xdmp:to-json(xdmp:sql(
   "SELECT process_data.uri, enrich_version_string, minutes_since_enrichment_request
@@ -23,13 +25,16 @@ xdmp:to-json(xdmp:sql(
     (parser_major_version = @target_parser_major_version AND parser_minor_version = @target_parser_minor_version)
   )
   AND (minutes_since_enrichment_request > 43200 OR minutes_since_enrichment_request IS NULL)
-  ORDER BY enrich_major_version ASC NULLS FIRST, enrich_minor_version ASC",
+  ORDER BY enrich_major_version ASC NULLS FIRST, enrich_minor_version ASC
+  LIMIT @maximum_records",
   "array",
   map:new((
     map:entry("target_enrichment_major_version", $target_enrichment_major_version),
     map:entry("target_enrichment_minor_version", $target_enrichment_minor_version),
     map:entry("target_parser_major_version", $target_parser_major_version),
-    map:entry("target_parser_minor_version", $target_parser_minor_version)
+    map:entry("target_parser_minor_version", $target_parser_minor_version),
+    map:entry("maximum_records", $maximum_records)
+    
   ))
 ))
 

{ds_caselaw_marklogic_api_client-27.2.0 → ds_caselaw_marklogic_api_client-27.3.0}/src/caselawclient/xquery/get_pending_parse_for_version.xqy

@@ -2,6 +2,7 @@ xquery version "1.0-ml";
 
 declare variable $target_major_version as xs:int external;
 declare variable $target_minor_version as xs:int external;
+declare variable $maximum_records as xs:int? external := 1000;
 
 xdmp:to-json(xdmp:sql(
   "SELECT process_data.uri, parser_version_string, minutes_since_parse_request
@@ -18,11 +19,13 @@ xdmp:to-json(xdmp:sql(
     (parser_major_version <= @target_major_version AND parser_minor_version < @target_minor_version)
   )
   AND (minutes_since_parse_request > 43200 OR minutes_since_parse_request IS NULL)
-  ORDER BY parser_major_version ASC NULLS FIRST, parser_minor_version ASC",
+  ORDER BY parser_major_version ASC NULLS FIRST, parser_minor_version ASC
+  LIMIT @maximum_records",
   "array",
   map:new((
     map:entry("target_major_version", $target_major_version),
-    map:entry("target_minor_version", $target_minor_version)
+    map:entry("target_minor_version", $target_minor_version),
+    map:entry("maximum_records", $maximum_records)
+    
   ))
-))
-
+))

{ds_caselaw_marklogic_api_client-27.2.0 → ds_caselaw_marklogic_api_client-27.3.0}/src/caselawclient/xquery_type_dicts.py

@@ -88,6 +88,7 @@ class GetLastModifiedDict(MarkLogicAPIDict):
 
 # get_pending_enrichment_for_version.xqy
 class GetPendingEnrichmentForVersionDict(MarkLogicAPIDict):
+    maximum_records: Optional[int]
     target_enrichment_major_version: int
     target_enrichment_minor_version: int
     target_parser_major_version: int
@@ -96,6 +97,7 @@ class GetPendingEnrichmentForVersionDict(MarkLogicAPIDict):
 
 # get_pending_parse_for_version.xqy
 class GetPendingParseForVersionDict(MarkLogicAPIDict):
+    maximum_records: Optional[int]
     target_major_version: int
     target_minor_version: int