QueryServiceApi¶

All URIs are relative to {INTERACTIVE_ADMIN_ENDPOINT}

Although Interactive supports multiple graphs in storage level, the query service currently could only runs on a single graph. This means that at any given time, only one graph can provide query services. If you attempt to submit a query to a graph that is not currently running, we will throw an error directly.

Method	HTTP request	Description
CallProcedure	POST /v1/graph/{graph_id}/query	submit query to the graph identified by the specified graph id
CallProcedureOnCurrentGraph	POST /v1/graph/current/query	submit query to the current running graph

CallProcedure¶

Result<IrResult.CollectiveResults> callProcedure(graphId, request)

Submit procedure call queries to the specified graph. The output format for the query is define by the results.proto.

For the creation of stored procedure please refer to CypherStoredProcedure and CppStoredProcedure.

Example¶

// Import classes:
import com.alibaba.graphscope.interactive.ApiClient;
import com.alibaba.graphscope.interactive.ApiException;
import com.alibaba.graphscope.interactive.Configuration;
import com.alibaba.graphscope.interactive.models.*;
import com.alibaba.graphscope.interactive.api.QueryServiceApi;

public class Example {
  public static void main(String[] args) {
    Driver driver = Driver.connect();
    Session session = driver.session();

    //Create the graph and register procedure first, and start service on this graph.
    String graphId = "2";
    String procedureId = "testProcedure";
    QueryRequest request = new QueryRequest();
    request.setQueryName(procedureId);
    request.addArgumentsItem(
            new TypedValue()
                    .value(1)
                    .type(
                            new GSDataType(
                                    new PrimitiveType()
                                            .primitiveType(
                                                    PrimitiveType.PrimitiveTypeEnum
                                                            .SIGNED_INT32))));
    Result<IrResult.CollectiveResults> queryRes = session.callProcedure(graphId, request);
    if (!queryRes.isOk()) {
        System.out.println("Failed to call procedure: " + queryRes.getStatusMessage());
        return;
    } else {
        System.out.println("Called procedure: " + queryRes.getValue());
    }
  }
}

Parameters¶

Name	Type	Description	Notes
graphId	String
body	QueryRequest		[optional]

Return type¶

Result<IrResult.CollectiveResults>

Authorization¶

No authorization required

HTTP request headers¶

Content-Type: text/plain
Accept: text/plain

HTTP response details¶

Status code	Description	Response headers
200	Successfully runned. Empty if failed?	-
500	Server internal error	-

CallProcedureOnCurrentGraph¶

Result<IrResult.CollectiveResults> callProcedure(body)

Submit a query to the running graph.