This is an automated email from the ASF dual-hosted git repository.
francischuang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/calcite-avatica-go.git
The following commit(s) were added to refs/heads/master by this push:
new a7b6c34 Clean up documentation and remove references to dep
a7b6c34 is described below
commit a7b6c34727d904863957c0562a74fcaceb09469c
Author: Francis Chuang <[email protected]>
AuthorDate: Mon Jun 22 19:33:52 2020 +1000
Clean up documentation and remove references to dep
---
README.md | 8 +-------
site/_docs/go_client_reference.md | 17 ++++++-----------
2 files changed, 7 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index f5de60d..86c307f 100644
--- a/README.md
+++ b/README.md
@@ -27,13 +27,7 @@ Apache Calcite's Avatica Go is a Go
[database/sql](https://golang.org/pkg/databa
Avatica is a sub-project of [Apache Calcite](https://calcite.apache.org).
## Quick Start
-If you are using Go 1.10 and below, install using
[dep](https://github.com/golang/dep):
-
-```
-$ dep ensure -add github.com/apache/calcite-avatica-go
-```
-
-If you are using Go 1.11 and above, install using Go modules:
+Install using Go modules:
```
$ go get github.com/apache/calcite-avatica-go
diff --git a/site/_docs/go_client_reference.md
b/site/_docs/go_client_reference.md
index 84cbcd2..c8792a6 100644
--- a/site/_docs/go_client_reference.md
+++ b/site/_docs/go_client_reference.md
@@ -35,13 +35,7 @@ hood.
{:toc}
## Getting Started
-If you are using Go 1.10 and below, install using
[dep](https://github.com/golang/dep):
-
-{% highlight shell %}
-$ dep ensure -add github.com/apache/calcite-avatica-go
-{% endhighlight %}
-
-If you are using Go 1.11 and above, install using Go modules:
+Install using Go modules:
{% highlight shell %}
$ go get github.com/apache/calcite-avatica-go
@@ -164,10 +158,11 @@ The supported values for `transactionIsolation` are:
<strong><a name="batching" href="#batching">batching</a></strong>
-When you want to write large amounts of data more quickly, instead of
consuming time on network communications.
+When you want to write large amounts of data, you can enable batching rather
than making a call to the server for each execution.
By using
[ExecuteBatchRequest](https://calcite.apache.org/avatica/docs/protobuf_reference.html#executebatchrequest),
-you can pack and send multiple pieces of data to reduce the confirmation of
messages. When you set `batching=true`,
-Statement will only be executed when `Close()` is called, and the statement is
goroutine-safe.
+the driver will batch up `Exec()`s and send them to the sever when a statement
is closed using `Close()`. The statement object
+is thread-safe and can be used by multiple go-routines, but the changes will
only be sent to the server after the
+statement has been closed.
```go
// when using phoenix
@@ -187,7 +182,7 @@ for i := 1; i <= 6; i++ {
}
wg.Wait()
-// When batching=true, Statement will only be executed when Close() is called
+// When batching=true, the statement will only be executed when Close() is
called
err = stmt.Close()
```
