update structure of client support for v2 transactions, and access in…

…terface for transaction results (#37) * update structure of client support for v2 transactions, and access interface for transaction results. * update go version in github action. * hide concrete column implementations, all access through column interface, plus misc cleanups and minor improvements to examples. * fix constant values in relation signatures and update tests.
RelationalAI · Oct 20, 2022 · d7f9c9f · d7f9c9f
1 parent ebe80bb
commit d7f9c9f
Show file tree

Hide file tree

Showing 54 changed files with 5,816 additions and 841 deletions.
diff --git a/.github/workflows/go-build.yaml b/.github/workflows/go-build.yaml
@@ -14,7 +14,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v2
       with:
-        go-version: 1.17
+        go-version: 1.18
 
     - name: Build
       run: go build -v ./rai

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,32 +1,40 @@
 # Changelog
 
+## v0.4.0-alpha
+
+* Complete overhaul of transaction response handling and results access API.
+
 ## v0.3.1-alpha
+
 * Fix v2 show result if empty result.
 
 ## v0.3.0-alpha
+
 * Deprecated metadata json format.
 * Removed `TransactionAsyncMetadataResponse` model.
 * Added support to metadata protobuf format.
 * `GetTransactionMetadata` returns protobuf metadata.
 * Added `v2` show result functionality.
 
 ## v0.2.1
+
 * Renamed:
-  - `Execute` to `ExecuteV1`.
-  - `ExecuteAsyncWait` to `Execute`.
+  * `Execute` to `ExecuteV1`.
+  * `ExecuteAsyncWait` to `Execute`.
 
 ## v0.2.0
+
 * Added `CancelTransaction` feature.
 
 ## v0.1.1
 
 * Added v2 predefined results formats:
-  - `GetTransactions` returns `TransactionsAsyncMultipleResponses`.
-  - `GetTransaction` returns `TransactionAsyncSingleResponse`.
-  - `GetTransactionResults` returns `[]ArrowRelation`.
-  - `GetTransactionMetadata` returns `[]TransactionAsyncMetadataResponse`.
-  - `GetTransactionProblems` returns `[](ClientProblem|IntegrityConstraintViolation)`.
-  - `ExecuteAsync` returns `TransactionAsyncResult`.
+  * `GetTransactions` returns `TransactionsAsyncMultipleResponses`.
+  * `GetTransaction` returns `TransactionAsyncSingleResponse`.
+  * `GetTransactionResults` returns `[]ArrowRelation`.
+  * `GetTransactionMetadata` returns `[]TransactionAsyncMetadataResponse`.
+  * `GetTransactionProblems` returns `[](ClientProblem|IntegrityConstraintViolation)`.
+  * `ExecuteAsync` returns `TransactionAsyncResult`.
 
 * `Problem` model is changed to `ClientProblem` and `IntegrityConstraintViolation`
 problem type is introduced.
@@ -37,4 +45,5 @@ problem type is introduced.
   is a simplification and *breaking change* to the signatures of both functions.
 
 ## v0.1.0-alpha
+
 * Initial release
diff --git a/README.md b/README.md
@@ -16,9 +16,7 @@ The RelationalAI Software Development Kit for Go enables developers to access th
 
 ### Requirements
 
-* Go 1.17+
-
-The SDK has been tested on golang version 1.17+, but likely works with earlier versions.
+* Go 1.18+
 
 ### Building the SDK
 
@@ -29,9 +27,8 @@ The SDK has been tested on golang version 1.17+, but likely works with earlier v
 
 **Run the tests**
 
-    cd ./rai
-    go test
-
+    ./run-tests
+
 Note, the test are run against the account configured in your SDK config file.
 
 ### Create a configuration file
@@ -58,11 +55,9 @@ You can copy `config.spec` from the root of this repo and modify as needed.
 
 ## Generate golang sources from protobuf specification
 
-```shell
-go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
-export PATH=$PATH:$HOME/go/bin
-protoc -I protos --go_out=. --go_opt=Mschema.proto=./rai/pb --go_opt=Mmessage.proto=./rai/pb protos/*.proto
-```
+    go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
+    export PATH=$PATH:$HOME/go/bin
+    protoc -I protos --go_out=. --go_opt=Mschema.proto=./rai/pb --go_opt=Mmessage.proto=./rai/pb protos/*.proto
 
 ## Examples
 
@@ -71,8 +66,8 @@ are located in `./examples` folder.
 
 Each example can be run using the `go` command.
 
-	cd ./examples
-	go run get_database/main.go -d sdk-test
+    cd ./examples
+    go run get_database/main.go -d sdk-test
 
 There is also a bash script in `./examples` that can be used to run
 individual examples.
@@ -93,4 +88,4 @@ to submit an issue or a PR here.
 
 The RelationalAI Software Development Kit for Go is licensed under the
 Apache License 2.0. See:
-https://github.com/RelationalAI/rai-sdk-go/blob/master/LICENSE
+https://github.com/RelationalAI/rai-sdk-go/blob/master/LICENSE
diff --git a/examples/cancel_transaction/main.go b/examples/cancel_transaction/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/clone_database/main.go b/examples/clone_database/main.go
@@ -37,7 +37,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/create_database/main.go b/examples/create_database/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/create_engine/main.go b/examples/create_engine/main.go
@@ -37,7 +37,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/create_oauth_client/main.go b/examples/create_oauth_client/main.go
@@ -37,7 +37,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/create_user/main.go b/examples/create_user/main.go
@@ -37,7 +37,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/delete_model/main.go b/examples/delete_model/main.go
@@ -38,7 +38,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/delete_oauth_client/main.go b/examples/delete_oauth_client/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/delete_user/main.go b/examples/delete_user/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/disable_user/main.go b/examples/disable_user/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/enable_user/main.go b/examples/enable_user/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/execute/main.go b/examples/execute/main.go
@@ -38,7 +38,7 @@ func getCode(opts *Options) (string, error) {
 	}
 	bytes, err := ioutil.ReadFile(opts.File)
 	if err != nil {
-		return "", nil
+		return "", err
 	}
 	return string(bytes), nil
 }
@@ -56,7 +56,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rsp.Show()
 	return nil
 }
 

diff --git a/examples/execute_async/main.go b/examples/execute_async/main.go
@@ -38,7 +38,7 @@ func getCode(opts *Options) (string, error) {
 	}
 	bytes, err := ioutil.ReadFile(opts.File)
 	if err != nil {
-		return "", nil
+		return "", err
 	}
 	return string(bytes), nil
 }
@@ -56,7 +56,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+    rsp.Show()
 	return nil
 }
 

diff --git a/examples/execute_v1/main.go b/examples/execute_v1/main.go
diff --git a/examples/find_oauth_client/main.go b/examples/find_oauth_client/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/find_user/main.go b/examples/find_user/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/get_database/main.go b/examples/get_database/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/get_engine/main.go b/examples/get_engine/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/get_model/main.go b/examples/get_model/main.go
@@ -38,7 +38,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/get_oauth_client/main.go b/examples/get_oauth_client/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/get_transaction/main.go b/examples/get_transaction/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }
 

diff --git a/examples/get_transaction_metadata/main.go b/examples/get_transaction_metadata/main.go
@@ -36,7 +36,7 @@ func run(opts *Options) error {
 	if err != nil {
 		return err
 	}
-	rai.Print(rsp, 4)
+	rai.ShowJSON(rsp, 4)
 	return nil
 }