Merge pull request #31 from BillFarber/feature/submitGraphql

DEVEXP-575: Submit GraphQL query with Python client

Author: BillFarber

marklogic/client.py

@@ -1,6 +1,7 @@
 import requests
 from marklogic.cloud_auth import MarkLogicCloudAuth
 from marklogic.documents import DocumentManager
+from marklogic.rows import RowManager
 from requests.auth import HTTPDigestAuth
 from urllib.parse import urljoin
 
@@ -70,3 +71,9 @@ def documents(self):
         if not hasattr(self, "_documents"):
             self._documents = DocumentManager(self)
         return self._documents
+
+    @property
+    def rows(self):
+        if not hasattr(self, "_rows"):
+            self._rows = RowManager(self)
+        return self._rows

marklogic/rows.py

@@ -0,0 +1,43 @@
+import json
+from requests import Session
+
+"""
+Defines a RowManager class to simplify usage of the "/v1/rows" & "/v1/rows/graphql" REST
+endpoints defined at https://docs.marklogic.com/REST/POST/v1/rows/graphql
+"""
+
+
+class RowManager:
+    """
+    Provides a method to simplify sending a GraphQL request to the GraphQL rows endpoint.
+    """
+    def __init__(self, session: Session):
+        self._session = session
+        
+    def graphql(self, graphql_query, return_response=False, *args, **kwargs):
+        """
+        Send a GraphQL query to MarkLogic via a POST to the endpoint defined at
+        https://docs.marklogic.com/REST/POST/v1/rows/graphql
+
+        :param graphql_query: a GraphQL query string. Note - this is the query string
+        only, not the entire query JSON object. See the following for more information:
+        https://spec.graphql.org/October2021/#sec-Overview
+        https://graphql.org/learn/queries/
+        :param return_response: boolean specifying if the entire original response
+        object should be returned (True) or if only the data should be returned (False)
+        upon a success (2xx) response. Note that if the status code of the response is
+        not 2xx, then the entire response is always returned.
+        """
+        headers = kwargs.pop("headers", {})
+        headers["Content-Type"] = "application/graphql"
+        response = self._session.post(
+            "v1/rows/graphql",
+            headers=headers,
+            data=json.dumps({"query": graphql_query}),
+            **kwargs
+        )
+        return (
+            response.json()
+            if response.status_code == 200 and not return_response
+            else response
+        )

test-app/src/main/ml-config/databases/content-database.json

@@ -0,0 +1,4 @@
+{
+  "database-name": "%%DATABASE%%",
+  "schema-database": "%%SCHEMAS_DATABASE%%"
+}

test-app/src/main/ml-config/databases/modules-database.json

@@ -0,0 +1,3 @@
+{
+    "database-name": "%%MODULES_DATABASE%%"
+}

test-app/src/main/ml-config/databases/schemas-database.json

@@ -0,0 +1,3 @@
+{
+  "database-name": "%%SCHEMAS_DATABASE%%"
+}

test-app/src/main/ml-data/collections.properties

@@ -1 +1 @@
-*=test-data
+*=test-data,search-test

test-app/src/main/ml-data/musicians/collections.properties

@@ -0,0 +1 @@
+*=test-data

test-app/src/main/ml-data/musicians/musician1.json

@@ -0,0 +1,11 @@
+{
+  "musician": {
+    "lastName": "Armstrong",
+    "firstName": "Louis",
+    "dob": "1901-08-04",
+    "instrument": [
+      "trumpet",
+      "vocal"
+    ]
+  }
+}

test-app/src/main/ml-data/musicians/musician2.json

@@ -0,0 +1,11 @@
+{
+  "musician": {
+    "lastName": "Byron",
+    "firstName": "Don",
+    "dob": "1958-11-08",
+    "instrument": [
+      "clarinet",
+      "saxophone"
+    ]
+  }
+}

test-app/src/main/ml-data/musicians/musician3.json

@@ -0,0 +1,10 @@
+{
+  "musician": {
+    "lastName": "Coltrane",
+    "firstName": "John",
+    "dob": "1926-09-23",
+    "instrument": [
+      "saxophone"
+    ]
+  }
+}