Repository: calcite-avatica-go Updated Branches: refs/heads/master 7156d8219 -> adba1689e
Fix development documentation Project: http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/repo Commit: http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/commit/f94727ad Tree: http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/tree/f94727ad Diff: http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/diff/f94727ad Branch: refs/heads/master Commit: f94727adb083051f597cf99b1d37c3a33e41fce1 Parents: 7156d82 Author: Francis Chuang <[email protected]> Authored: Thu Apr 19 08:34:57 2018 +1000 Committer: Francis Chuang <[email protected]> Committed: Fri Apr 20 15:39:49 2018 +1000 ---------------------------------------------------------------------- site/README.md | 3 +-- site/go_client_reference.md | 21 +-------------------- site/go_development.md | 12 +++++++++++- 3 files changed, 13 insertions(+), 23 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/blob/f94727ad/site/README.md ---------------------------------------------------------------------- diff --git a/site/README.md b/site/README.md index 72f7dc9..6125a8a 100644 --- a/site/README.md +++ b/site/README.md @@ -22,8 +22,7 @@ limitations under the License. This directory contains the code for the web pages documenting the Calcite Avatica Go client. It is symlinked and built by the [Avatica web site](https://calcite.apache.org/avatica), -a sub-directory of the -[Apache Calcite web site](https://calcite.apache.org). +a sub-directory of the [Apache Calcite web site](https://calcite.apache.org). ## Pushing to site http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/blob/f94727ad/site/go_client_reference.md ---------------------------------------------------------------------- diff --git a/site/go_client_reference.md b/site/go_client_reference.md index 275a60a..e11bb3d 100644 --- a/site/go_client_reference.md +++ b/site/go_client_reference.md @@ -184,23 +184,4 @@ fmt.Println(perr.Name()) // Prints: table_undefined ## Version Compatibility | Driver Version | Phoenix Version | Calcite-Avatica Version | | :-------------- | :---------------- | :---------------------- | -| 3.x.x | >= 4.8.0 | >= 1.11.0 | - -## Development - -To file issues, please use the [Calcite JIRA](https://issues.apache.org/jira/projects/CALCITE/issues). - -To run tests, you must have an instance of the Avatica server available and set it in the `AVATICA_HOST` -environment variable. - -For example: `export AVATICA_HOST=http://localhost:8765` - -Once that is set up, you can run the tests but skip tests in the vendor directory -(to avoid running tests for the dependencies) using: - -~~~~ -go test $(go list ./... | grep -v /vendor/) -~~~~ - -To update the procotol buffer definitions, update `AVATICA_VER` in `gen-protobuf.bat` and `gen-protobuf.sh` to match -the version you want to generate protobufs for and then run the appropriate script for your platform. \ No newline at end of file +| 3.x.x | >= 4.8.0 | >= 1.11.0 | \ No newline at end of file http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/blob/f94727ad/site/go_development.md ---------------------------------------------------------------------- diff --git a/site/go_development.md b/site/go_development.md index e2faf11..cee2e99 100644 --- a/site/go_development.md +++ b/site/go_development.md @@ -24,6 +24,16 @@ limitations under the License. {% endcomment %} --> +## Issues + +To file issues, please use the [Calcite JIRA](https://issues.apache.org/jira/projects/CALCITE/issues) and select `avatica-go` +as the component. + +## Updating protobuf definitions + +To update the procotol buffer definitions, update `AVATICA_VER` in `gen-protobuf.bat` and `gen-protobuf.sh` to match +the version you want to generate protobufs for and then run the appropriate script for your platform. + ## Testing The test suite takes around 4 minutes to run if you run both the Avatica HSQLDB and Apache Phoenix tests. @@ -51,7 +61,7 @@ PHOENIX_HOST: http://phoenix:8765 5. To select the test suite, export `AVATICA_FLAVOR=HSQLDB` for Avatica HSQLDB or `AVATICA_FLAVOR=PHOENIX` for Phoenix. -6. Then run `go test-v ./...` from the root of the repository to execute the test suite. +6. Then run `go test -v ./...` from the root of the repository to execute the test suite. ## Releasing If you have not set up a GPG signing key, set one up by following these [instructions](https://www.apache.org/dev/openpgp.html#generate-key).
