Merge pull request #6 from RelationalAI/hnr-async-protocol

Adding support to async protocol

Author: NRHelmi

CHANGELOG.md

@@ -0,0 +1,14 @@
+
+## main
+* Added support to the asynchronous protocol including:
+    - `executeAsync`: runs an asynchronous request.
+    - `executeAsyncWait`: runs an asynchronous request and wait of its completion.
+    - `getTransaction`: gets information about transaction.
+    - `getTransactions`: gets the list of transactions.
+    - `getTransactionResults`: gets transaction execution results.
+    - `getTransactionMetadata`: gets transaction metadata.
+    - `getTransactionProblems`: gets transaction execution problems.
+* Added `ExecuteAsyncTest` test class
+
+## v0.0.1
+* initial release

README.md

@@ -86,7 +86,7 @@ In order to use the `rai-sdk-java`, you need add this dependency to your project
     <dependency>
         <groupId>com.relationalai</groupId>
         <artifactId>rai-sdk</artifactId>
-        <version>0.0.1</version>
+        <version>0.0.2</version>
     </dependency>
 
 You need also to point maven to the SDK GitHub packages repository in the project's POM:

pom.xml

@@ -21,7 +21,7 @@
     <description>The RelationalAI Software Development Kit (SDK) for Java</description>
     <groupId>com.relationalai</groupId>
     <artifactId>rai-sdk-pom</artifactId>
-    <version>0.0.1</version>
+    <version>0.0.2</version>
     <packaging>pom</packaging>
     <url></url>
 

rai-sdk-examples/pom.xml

@@ -20,7 +20,7 @@
     <parent>
         <groupId>com.relationalai</groupId>
         <artifactId>rai-sdk-pom</artifactId>
-        <version>0.0.1</version>
+        <version>0.0.2</version>
     </parent>
 
     <name>RelationalAI SDK for Java Examples</name>

rai-sdk-examples/src/main/java/com/relationalai/examples/Execute.java

@@ -41,7 +41,6 @@ String getCommand() throws IOException {
         return null;
     }
 
-    // todo: schema
     public void parseArgs(String[] args) {
         var c = Command.create("Execute")
                 .addArgument("database")

rai-sdk-examples/src/main/java/com/relationalai/examples/ExecuteAsync.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2022 RelationalAI, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"): you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.relationalai.examples;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import com.relationalai.Client;
+import com.relationalai.Config;
+import com.relationalai.HttpError;
+import com.relationalai.Json;
+
+public class ExecuteAsync implements Runnable {
+    boolean readonly;
+    String database, engine, command, filename, profile;
+
+    // Returns the name of the file, without extension.
+    static String readFile(String fname) throws IOException {
+        return Files.readAllBytes(Path.of(fname)).toString();
+    }
+
+    String getCommand() throws IOException {
+        if (command != null)
+            return command; // prefer command line
+        if (filename != null)
+            return readFile(filename);
+        return null;
+    }
+
+    public void parseArgs(String[] args) {
+        var c = Command.create("ExecuteAsync")
+                .addArgument("database")
+                .addArgument("engine")
+                .addOption("c", "rel source string")
+                .addOption("f", "rel source file")
+                .addFlag("readonly", "readonly query (default: false)")
+                .parseArgs(args);
+        this.database = c.getValue("database");
+        this.engine = c.getValue("engine");
+        this.command = c.getValue("c");
+        this.filename = c.getValue("f");
+        this.readonly = c.getValue("readonly", Boolean.class);
+        this.profile = c.getValue("profile");
+    }
+
+    public void run(String[] args) throws HttpError, InterruptedException, IOException {
+        parseArgs(args);
+        var cfg = Config.loadConfig("~/.rai/config", profile);
+        var client = new Client(cfg);
+        String source = getCommand();
+        if (source == null)
+            return; // nothing to execute
+        var rsp = client.executeAsync(database, engine, source, readonly);
+        Json.print(rsp);
+    }
+}

rai-sdk-examples/src/main/java/com/relationalai/examples/GetTransaction.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2022 RelationalAI, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"): you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.relationalai.examples;
+
+import com.relationalai.Client;
+import com.relationalai.Config;
+import com.relationalai.HttpError;
+import com.relationalai.Json;
+
+import java.io.IOException;
+
+public class GetTransaction implements Runnable {
+    String id, profile;
+
+    public void parseArgs(String[] args) {
+        var c = Command.create("GetTransaction")
+                .addArgument("id")
+                .addOption("profile", "config profile (default: default)")
+                .parseArgs(args);
+        this.id = c.getValue("id");
+        this.profile = c.getValue("profile");
+    }
+
+    public void run(String[] args) throws HttpError, InterruptedException, IOException {
+        parseArgs(args);
+        var cfg = Config.loadConfig("~/.rai/config", profile);
+        var client = new Client(cfg);
+
+        var rsp = client.getTransaction(id);
+        Json.print(rsp);
+    }
+}

rai-sdk-examples/src/main/java/com/relationalai/examples/GetTransactionMetadata.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2022 RelationalAI, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"): you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.relationalai.examples;
+
+import com.relationalai.Client;
+import com.relationalai.Config;
+import com.relationalai.HttpError;
+import com.relationalai.Json;
+
+import java.io.IOException;
+
+public class GetTransactionMetadata implements Runnable {
+    String id, profile;
+
+    public void parseArgs(String[] args) {
+        var c = Command.create("GetTransactionMetadata")
+                .addArgument("id")
+                .addOption("profile", "config profile (default: default)")
+                .parseArgs(args);
+        this.id = c.getValue("id");
+        this.profile = c.getValue("profile");
+    }
+
+    public void run(String[] args) throws HttpError, InterruptedException, IOException {
+        parseArgs(args);
+        var cfg = Config.loadConfig("~/.rai/config", profile);
+        var client = new Client(cfg);
+
+        var rsp = client.getTransactionMetadata(id);
+        Json.print(rsp);
+    }
+}

rai-sdk-examples/src/main/java/com/relationalai/examples/GetTransactionProblems.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2022 RelationalAI, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"): you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.relationalai.examples;
+
+import com.relationalai.Client;
+import com.relationalai.Config;
+import com.relationalai.HttpError;
+import com.relationalai.Json;
+
+import java.io.IOException;
+
+public class GetTransactionProblems implements Runnable {
+    String id, profile;
+
+    public void parseArgs(String[] args) {
+        var c = Command.create("GetTransactionProblems")
+                .addArgument("id")
+                .addOption("profile", "config profile (default: default)")
+                .parseArgs(args);
+        this.id = c.getValue("id");
+        this.profile = c.getValue("profile");
+    }
+
+    public void run(String[] args) throws HttpError, InterruptedException, IOException {
+        parseArgs(args);
+        var cfg = Config.loadConfig("~/.rai/config", profile);
+        var client = new Client(cfg);
+
+        var rsp = client.getTransactionProblems(id);
+        Json.print(rsp);
+    }
+}

rai-sdk-examples/src/main/java/com/relationalai/examples/GetTransactionResults.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2022 RelationalAI, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"): you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.relationalai.examples;
+
+import com.relationalai.Client;
+import com.relationalai.Config;
+import com.relationalai.HttpError;
+import com.relationalai.Json;
+
+import java.io.IOException;
+
+public class GetTransactionResults implements Runnable {
+    String id, profile;
+
+    public void parseArgs(String[] args) {
+        var c = Command.create("GetTransactionResults")
+                .addArgument("id")
+                .addOption("profile", "config profile (default: default)")
+                .parseArgs(args);
+        this.id = c.getValue("id");
+        this.profile = c.getValue("profile");
+    }
+
+    public void run(String[] args) throws HttpError, InterruptedException, IOException {
+        parseArgs(args);
+        var cfg = Config.loadConfig("~/.rai/config", profile);
+        var client = new Client(cfg);
+
+        var rsp = client.getTransactionResults(id);
+        Json.print(rsp);
+    }
+}