Merge pull request #394 from DarthMax/add_arrow_debug_proc_endpoint

Add arrow debug endpoint

Author: FlorentinD

doc/sphinx/source/misc.rst

@@ -37,6 +37,10 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 
     Returns details about the status of the system
 
+.. py:function:: gds.debug.arrow() -> Series[Any]
+
+    Returns details about the status of the GDS Arrow Flight server
+
 .. py:function:: gds.util.asNode(node_id: int) -> Any
 
     Return a node object for the given node id or null if none exists.

graphdatascience/system/system_endpoints.py

@@ -15,6 +15,12 @@ def sysInfo(self) -> "Series[Any]":
 
         return self._query_runner.run_query(query).squeeze()  # type: ignore
 
+    def arrow(self) -> "Series[Any]":
+        self._namespace += ".arrow"
+        query = f"CALL {self._namespace}()"
+
+        return self._query_runner.run_query(query).squeeze()  # type: ignore
+
 
 class DirectSystemEndpoints(CallerBase):
     @client_only_endpoint("gds")

graphdatascience/tests/integration/test_system_ops.py

@@ -30,6 +30,12 @@ def test_sysInfo(gds: GraphDataScience) -> None:
     assert "gdsVersion" in (list(result["key"]))
 
 
+def test_debug_arrow(gds: GraphDataScience) -> None:
+    result = gds.debug.arrow()
+
+    assert "listenAddress" in (result.keys())
+
+
 @pytest.mark.enterprise
 def test_is_licensed(gds: GraphDataScience) -> None:
     assert gds.is_licensed()