You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by fr...@apache.org on 2018/04/25 09:57:33 UTC
calcite-avatica-go git commit: Reorganize website structure
Repository: calcite-avatica-go
Updated Branches:
refs/heads/update-site [created] 8a6616312
Reorganize website structure
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/8a661631
Tree: http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/tree/8a661631
Diff: http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/diff/8a661631
Branch: refs/heads/update-site
Commit: 8a6616312105409ae34da969d0ee8a23a45e570b
Parents: 1ed6f83
Author: Francis Chuang <fr...@apache.org>
Authored: Wed Apr 25 19:56:34 2018 +1000
Committer: Francis Chuang <fr...@apache.org>
Committed: Wed Apr 25 19:56:34 2018 +1000
----------------------------------------------------------------------
site/_docs/go_client_reference.md | 187 ++++++++++++++++++++++++++
site/_docs/go_development.md | 117 ++++++++++++++++
site/_docs/go_history.md | 60 +++++++++
site/_posts/2018-03-09-release-1.11.0.md | 31 +++++
site/go_client_reference.md | 187 --------------------------
site/go_development.md | 117 ----------------
site/go_history.md | 60 ---------
7 files changed, 395 insertions(+), 364 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/blob/8a661631/site/_docs/go_client_reference.md
----------------------------------------------------------------------
diff --git a/site/_docs/go_client_reference.md b/site/_docs/go_client_reference.md
new file mode 100644
index 0000000..e11bb3d
--- /dev/null
+++ b/site/_docs/go_client_reference.md
@@ -0,0 +1,187 @@
+---
+layout: docs
+title: Go Client Reference
+sidebar_title: Go Client Reference
+permalink: /docs/go_client_reference.html
+---
+
+<!--
+{% comment %}
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you 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.
+{% endcomment %}
+-->
+
+The Avatica Go client is an Avatica driver for Go's
+[database/sql](https://golang.org/pkg/database/sql/)package.
+
+It also works with the Phoenix Query Server from the Apache
+Phoenix project, as the Phoenix Query Server uses Avatica under the
+hood.
+
+## Getting Started
+Install using your dependency management tool (we recommend [dep](https://github.com/golang/dep)!):
+
+~~~~~~
+$ dep ensure -add github.com/apache/calcite-avatica-go
+~~~~~~
+
+## Usage
+
+The Avatica Go driver implements Go's `database/sql/driver` interface, so, import Go's
+`database/sql` package and the driver:
+
+~~~~~~go
+import "database/sql"
+import _ "github.com/apache/calcite-avatica-go"
+
+db, err := sql.Open("avatica", "http://localhost:8765")
+~~~~~~
+
+Then simply use the database connection to query some data, for example:
+
+~~~~~~go
+rows := db.Query("SELECT COUNT(*) FROM test")
+~~~~~~
+
+## DSN (Data Source Name)
+
+The DSN has the following format (optional parts are marked by square brackets):
+
+~~~~~~
+http://[username:password@]address:port[/schema][?parameter1=value&...parameterN=value]
+~~~~~~
+
+In other words, the scheme (http), address and port are mandatory, but the schema and parameters are optional.
+
+{% comment %}
+It's a shame that we have to embed HTML to get the anchors but the normal
+header tags from kramdown screw up the definition list. We lose the pretty
+on-hover images for the permalink, but oh well.
+{% endcomment %}
+
+<strong><a name="username" href="#username">username</a></strong>
+This is the JDBC username that is passed directly to the backing database. It is *NOT* used for authenticating
+against Avatica.
+
+<strong><a name="password" href="#password">password</a></strong>
+This is the JDBC password that is passed directly to the backing database. It is *NOT* used for authenticating
+against Avatica.
+
+<strong><a name="schema" href="#schema">schema</a></strong>
+The `schema` path sets the default schema to use for this connection. For example, if you set it to `myschema`,
+then executing the query `SELECT * FROM my_table` will have the equivalence of `SELECT * FROM myschema.my_table`.
+If schema is set, you can still work on tables in other schemas by supplying a schema prefix:
+`SELECT * FROM myotherschema.my_other_table`.
+
+The parameters references the options used by the Java implementation as much as possible.
+The following parameters are supported:
+
+<strong><a name="authentication" href="#authentication">authentication</a></strong>
+The authentication type to use when authenticating against Avatica. Valid values are `BASIC` for HTTP Basic authentication,
+`DIGEST` for HTTP Digest authentication, and `SPNEGO` for Kerberos with SPNEGO authentication.
+
+<strong><a name="avaticaUser" href="#avaticaUser">avaticaUser</a></strong>
+The user to use when authenticating against Avatica. This parameter is required if `authentication` is `BASIC` or `DIGEST`.
+
+<strong><a name="avaticaPassword" href="#avaticaPassword">avaticaPassword</a></strong>
+The password to use when authenticating against Avatica. This parameter is required if `authentication` is `BASIC` or `DIGEST`.
+
+<strong><a name="principal" href="#principal">principal</a></strong>
+The Kerberos principal to use when authenticating against Avatica. It should be in the form `primary/instance@realm`, where
+the instance is optional. This parameter is required if `authentication` is `SPNEGO` and you want the driver to perform the
+Kerberos login.
+
+<strong><a name="keytab" href="#keytab">keytab</a></strong>
+The path to the Kerberos keytab to use when authenticating against Avatica. This parameter is required if `authentication`
+is `SPNEGO` and you want the driver to perform the Kerberos login.
+
+<strong><a name="krb5Conf" href="#krb5Conf">krb5Conf</a></strong>
+The path to the Kerberos configuration to use when authenticating against Avatica. This parameter is required if `authentication`
+is `SPNEGO` and you want the driver to perform the Kerberos login.
+
+<strong><a name="krb5CredentialsCache" href="#krb5CredentialsCache">krb5CredentialsCache</a></strong>
+The path to the Kerberos credential cache file to use when authenticating against Avatica. This parameter is required if
+`authentication` is `SPNEGO` and you have logged into Kerberos already and want the driver to use the existing credentials.
+
+<strong><a name="location" href="#location">location</a></strong>
+The `location` will be set as the location of unserialized `time.Time` values. It must be a valid timezone.
+If you want to use the local timezone, use `Local`. By default, this is set to `UTC`.
+
+<strong><a name="maxRowsTotal" href="#maxRowsTotal">maxRowsTotal</a></strong>
+The `maxRowsTotal` parameter sets the maximum number of rows to return for a given query. By default, this is set to
+`-1`, so that there is no limit on the number of rows returned.
+
+<strong><a name="frameMaxSize" href="#frameMaxSize">frameMaxSize</a></strong>
+The `frameMaxSize` parameter sets the maximum number of rows to return in a frame. Depending on the number of rows
+returned and subject to the limits of `maxRowsTotal`, a query result set can contain rows in multiple frames. These
+additional frames are then fetched on a as-needed basis. `frameMaxSize` allows you to control the number of rows
+in each frame to suit your application's performance profile. By default this is set to `-1`, so that there is no limit
+on the number of rows in a frame.
+
+<strong><a name="transactionIsolation" href="#transactionIsolation">transactionIsolation</a></strong>
+Setting `transactionIsolation` allows you to set the isolation level for transactions using the connection. The value
+should be a positive integer analogous to the transaction levels defined by the JDBC specification. The default value
+is `0`, which means transactions are not supported. This is to deal with the fact that Calcite/Avatica works with
+many types of backends, with some backends having no transaction support. If you are using Apache Phoenix 4.7 onwards,
+we recommend setting it to `4`, which is the maximum isolation level supported.
+
+The supported values for `transactionIsolation` are:
+
+| Value | JDBC Constant | Description |
+| :-----| :----------------------------- | :------------------------------------------------------------------------------- |
+| 0 | none | Transactions are not supported |
+| 1 | `TRANSACTION_READ_UNCOMMITTED` | Dirty reads, non-repeatable reads and phantom reads may occur. |
+| 2 | `TRANSACTION_READ_COMMITTED` | Dirty reads are prevented, but non-repeatable reads and phantom reads may occur. |
+| 4 | `TRANSACTION_REPEATABLE_READ` | Dirty reads and non-repeatable reads are prevented, but phantom reads may occur. |
+| 8 | `TRANSACTION_SERIALIZABLE` | Dirty reads, non-repeatable reads, and phantom reads are all prevented. |
+
+## time.Time support
+
+The following datatypes are automatically converted to and from `time.Time`:
+`TIME`, `DATE` and `TIMESTAMP`.
+
+It is important to understand that Avatica and the underlying database ignores the timezone. If you save a `time.Time`
+to the database, the timezone is ignored and vice-versa. This is why you need to make sure the `location` parameter
+in your DSN is set to the same value as the location of the `time.Time` values you are inserting into the database.
+
+We recommend using `UTC`, which is the default value of `location`.
+
+## Apache Phoenix Error Codes
+The Go client comes with support for retrieving the error code when an error occurs. This is extremely useful when
+you want to take specific action when a particular type of error occurs.
+
+If the error returned is a ResponseError, calling the `Name()` method on the error will return the appropriate
+Apache Phoenix error code:
+
+~~~~go
+_, err := db.Exec("SELECT * FROM table_that_does_not_exist") // Query undefined table
+
+// First, assert the error type
+perr, ok := err.(avatica.ResponseError)
+
+// If it cannot be asserted
+if !ok{
+ // Error was not an Avatica ResponseError
+}
+
+// Print the Apache Phoenix error code
+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 |
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/blob/8a661631/site/_docs/go_development.md
----------------------------------------------------------------------
diff --git a/site/_docs/go_development.md b/site/_docs/go_development.md
new file mode 100644
index 0000000..d1b9fa8
--- /dev/null
+++ b/site/_docs/go_development.md
@@ -0,0 +1,117 @@
+---
+layout: docs
+title: Go Client Development
+sidebar_title: Go Client Development
+permalink: /docs/go_development.html
+---
+
+<!--
+{% comment %}
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you 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.
+{% 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.
+
+### Easy way
+1. Install [docker](https://docs.docker.com/install/) and [docker-compose](https://docs.docker.com/compose/install/).
+
+2. From the root of the repository, run `docker-compose up --build`.
+
+### Manual set up
+1. Install [Go](https://golang.org/doc/install).
+
+2. Install [dep](https://github.com/golang/dep): `go get -u github.com/golang/dep/cmd/dep`
+
+3. Install dependencies by running `dep ensure -v` from the root of the repository.
+
+4. The test suite requires access to an instance of Avatica running HSQLDB and an instance of Apache Phoenix running the
+Phoenix Query Server.
+
+You should then set the `HSQLDB_HOST` and `PHOENIX_HOST` environment variables. For example:
+~~~~~~
+HSQLDB_HOST: http://hsqldb:8765
+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.
+
+## 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).
+
+From the root of the repository, run `./make-release-artifacts.sh`.
+
+You will be asked to select the tag to build release artifacts for. The latest tag is automatically selected if no tag is selected.
+
+The release artifacts will be placed in a folder named for the release within the `dist/` folder.
+
+## Important things to note before uploading a release
+The name of the release folder must be in the following format: `apache-calcite-avatica-go-$version`. The version must
+include release candidate identifiers such as `-rc0`, if they are present.
+
+The files inside the release folder must have any release candidate identifiers such as `-rc1` removed, even if the
+release is a release candidate. `src` must also be added to the filename.
+
+For example, if we are uploading the `apache-calcite-avatica-go-3.0.0-rc1` folder, the files must be named
+`apache-calcite-acatica-go-src-3.0.0.tar.gz`. Note the inclusion of `src` in the filename.
+
+The tar.gz must be named `apache-calcite-avatica-go-src-$version.tar.gz`.
+
+There must be a GPG signature for the tar.gz named: `apache-calcite-avatica-go-src-$version.tar.gz.asc`
+
+There must be a SHA256 hash for the tar.gz named: `apache-calcite-avatica-go-src-$version.tar.gz.sha256`
+
+## Uploading release artifacts to dev for voting
+`svn` must be installed in order to upload release artifacts.
+
+1. Check out the Calcite dev release subdirectory: `svn co "https://dist.apache.org/repos/dist/dev/calcite/" calcite-dev`.
+
+2. Move the release folder under `dist/` into the `calcite-dev` folder.
+
+3. Add the new release to the svn repository: `svn add apache-calcite-avatica-go-3.0.0-rc0`. Remember to change the folder name to the
+correct release in the command.
+
+4. Commit to upload the artifacts: `svn commit -m "apache-calcite-avatica-go-3.0.0-rc0" --username yourapacheusername --force-log`
+Note the use of `--force-log` to suppress the svn warning, because the commit message is the same as the name of the directory.
+
+## Promoting a release after voting
+`svn` must be installed in order to upload release artifacts.
+
+NOTE: Only official releases that has passed a vote may be uploaded to the release directory.
+
+1. Check out the Calcite release directory: `svn co "https://dist.apache.org/repos/dist/release/calcite/" calcite-release`.
+
+2. Copy the release into the `calcite-release` folder. Remember to check the name of the release's folder to ensure that it is in
+the correct format.
+
+3. Add the release to the svn repository: `svn add apache-calcite-avatica-go-3.0.0`. Remember to change the folder name to the
+correct release in the command.
+
+4. Commit to upload the artifacts: `svn commit -m "Release apache-calcite-avatica-go-3.0.0" --username yourapacheusername`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/blob/8a661631/site/_docs/go_history.md
----------------------------------------------------------------------
diff --git a/site/_docs/go_history.md b/site/_docs/go_history.md
new file mode 100644
index 0000000..60c8e44
--- /dev/null
+++ b/site/_docs/go_history.md
@@ -0,0 +1,60 @@
+---
+layout: docs
+title: Go Client History
+permalink: "/docs/go_history.html"
+---
+
+<!--
+{% comment %}
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you 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.
+{% endcomment %}
+-->
+
+For a full list of releases, see
+<a href="https://github.com/apache/calcite-avatica-go/releases">github</a>.
+Downloads are available on the
+[downloads page]({{ site.baseurl }}/downloads/).
+
+## <a href="https://github.com/apache/calcite-avatica-go/releases/tag/3.0.0">3.0.0</a> / 2018-04-27
+{: #v3-0-0}
+
+Apache Calcite Avatica Go 3.0.0 is the first release since the Go driver has been donated
+to the Apache Software foundation.
+We recommend using the latest stable version of Go.
+
+Features and bug fixes
+
+* [<a href="https://issues.apache.org/jira/browse/CALCITE-1240">CALCITE-1240</a>]
+ Intial import of the original [Boostport/avatica](https://github.com/Boostport/avatica) code-base into the
+ [apache/calcite-avatica-go](https://github.com/apache/calcite-avatica-go) repository
+* [<a href="https://issues.apache.org/jira/browse/CALCITE-1938">CALCITE-1938</a>]
+ Releasing the first release of Calcite Avatica Go under the Apache Software Foundation
+* Remove go-cleanhttp dependency
+* Support for Avatica HSQLDB backend and move Apache Phoenix support into adapter
+* Add bash script to automate releases with checks to alert on files without the Apache license header
+* Replace gopher.png test fixture with Calcite logo
+
+Web site and documentation
+
+* [<a href="https://issues.apache.org/jira/browse/CALCITE-1937">CALCITE-1937</a>]
+ Set up Calcite Avatica Go website
+
+## Past releases
+
+Prior to release 3.0.0, the Avatica Go client was developed by Boostport.
+
+Please refer to the [Boostport/Avatica](https://github.com/Boostport/avatica) Github repository for previous releases
+of the Avatica Go client.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/blob/8a661631/site/_posts/2018-03-09-release-1.11.0.md
----------------------------------------------------------------------
diff --git a/site/_posts/2018-03-09-release-1.11.0.md b/site/_posts/2018-03-09-release-1.11.0.md
new file mode 100644
index 0000000..60f3390
--- /dev/null
+++ b/site/_posts/2018-03-09-release-1.11.0.md
@@ -0,0 +1,31 @@
+---
+layout: news_item
+date: "2018-04-27 08:30:00 +0000"
+author: francischuang
+version: 3.0.0
+categories: [release, avatica-go]
+tag: v3-0-0
+sha: 273c53f
+---
+<!--
+{% comment %}
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you 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.
+{% endcomment %}
+-->
+
+Apache Calcite Avatica 1.11.0 adds support for JDK 10 and drops
+support for JDK 7. There are more than 20
+[bug fixes and new features]({{ site.baseurl }}/docs/history.html#v1-11-0).
http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/blob/8a661631/site/go_client_reference.md
----------------------------------------------------------------------
diff --git a/site/go_client_reference.md b/site/go_client_reference.md
deleted file mode 100644
index e11bb3d..0000000
--- a/site/go_client_reference.md
+++ /dev/null
@@ -1,187 +0,0 @@
----
-layout: docs
-title: Go Client Reference
-sidebar_title: Go Client Reference
-permalink: /docs/go_client_reference.html
----
-
-<!--
-{% comment %}
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you 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.
-{% endcomment %}
--->
-
-The Avatica Go client is an Avatica driver for Go's
-[database/sql](https://golang.org/pkg/database/sql/)package.
-
-It also works with the Phoenix Query Server from the Apache
-Phoenix project, as the Phoenix Query Server uses Avatica under the
-hood.
-
-## Getting Started
-Install using your dependency management tool (we recommend [dep](https://github.com/golang/dep)!):
-
-~~~~~~
-$ dep ensure -add github.com/apache/calcite-avatica-go
-~~~~~~
-
-## Usage
-
-The Avatica Go driver implements Go's `database/sql/driver` interface, so, import Go's
-`database/sql` package and the driver:
-
-~~~~~~go
-import "database/sql"
-import _ "github.com/apache/calcite-avatica-go"
-
-db, err := sql.Open("avatica", "http://localhost:8765")
-~~~~~~
-
-Then simply use the database connection to query some data, for example:
-
-~~~~~~go
-rows := db.Query("SELECT COUNT(*) FROM test")
-~~~~~~
-
-## DSN (Data Source Name)
-
-The DSN has the following format (optional parts are marked by square brackets):
-
-~~~~~~
-http://[username:password@]address:port[/schema][?parameter1=value&...parameterN=value]
-~~~~~~
-
-In other words, the scheme (http), address and port are mandatory, but the schema and parameters are optional.
-
-{% comment %}
-It's a shame that we have to embed HTML to get the anchors but the normal
-header tags from kramdown screw up the definition list. We lose the pretty
-on-hover images for the permalink, but oh well.
-{% endcomment %}
-
-<strong><a name="username" href="#username">username</a></strong>
-This is the JDBC username that is passed directly to the backing database. It is *NOT* used for authenticating
-against Avatica.
-
-<strong><a name="password" href="#password">password</a></strong>
-This is the JDBC password that is passed directly to the backing database. It is *NOT* used for authenticating
-against Avatica.
-
-<strong><a name="schema" href="#schema">schema</a></strong>
-The `schema` path sets the default schema to use for this connection. For example, if you set it to `myschema`,
-then executing the query `SELECT * FROM my_table` will have the equivalence of `SELECT * FROM myschema.my_table`.
-If schema is set, you can still work on tables in other schemas by supplying a schema prefix:
-`SELECT * FROM myotherschema.my_other_table`.
-
-The parameters references the options used by the Java implementation as much as possible.
-The following parameters are supported:
-
-<strong><a name="authentication" href="#authentication">authentication</a></strong>
-The authentication type to use when authenticating against Avatica. Valid values are `BASIC` for HTTP Basic authentication,
-`DIGEST` for HTTP Digest authentication, and `SPNEGO` for Kerberos with SPNEGO authentication.
-
-<strong><a name="avaticaUser" href="#avaticaUser">avaticaUser</a></strong>
-The user to use when authenticating against Avatica. This parameter is required if `authentication` is `BASIC` or `DIGEST`.
-
-<strong><a name="avaticaPassword" href="#avaticaPassword">avaticaPassword</a></strong>
-The password to use when authenticating against Avatica. This parameter is required if `authentication` is `BASIC` or `DIGEST`.
-
-<strong><a name="principal" href="#principal">principal</a></strong>
-The Kerberos principal to use when authenticating against Avatica. It should be in the form `primary/instance@realm`, where
-the instance is optional. This parameter is required if `authentication` is `SPNEGO` and you want the driver to perform the
-Kerberos login.
-
-<strong><a name="keytab" href="#keytab">keytab</a></strong>
-The path to the Kerberos keytab to use when authenticating against Avatica. This parameter is required if `authentication`
-is `SPNEGO` and you want the driver to perform the Kerberos login.
-
-<strong><a name="krb5Conf" href="#krb5Conf">krb5Conf</a></strong>
-The path to the Kerberos configuration to use when authenticating against Avatica. This parameter is required if `authentication`
-is `SPNEGO` and you want the driver to perform the Kerberos login.
-
-<strong><a name="krb5CredentialsCache" href="#krb5CredentialsCache">krb5CredentialsCache</a></strong>
-The path to the Kerberos credential cache file to use when authenticating against Avatica. This parameter is required if
-`authentication` is `SPNEGO` and you have logged into Kerberos already and want the driver to use the existing credentials.
-
-<strong><a name="location" href="#location">location</a></strong>
-The `location` will be set as the location of unserialized `time.Time` values. It must be a valid timezone.
-If you want to use the local timezone, use `Local`. By default, this is set to `UTC`.
-
-<strong><a name="maxRowsTotal" href="#maxRowsTotal">maxRowsTotal</a></strong>
-The `maxRowsTotal` parameter sets the maximum number of rows to return for a given query. By default, this is set to
-`-1`, so that there is no limit on the number of rows returned.
-
-<strong><a name="frameMaxSize" href="#frameMaxSize">frameMaxSize</a></strong>
-The `frameMaxSize` parameter sets the maximum number of rows to return in a frame. Depending on the number of rows
-returned and subject to the limits of `maxRowsTotal`, a query result set can contain rows in multiple frames. These
-additional frames are then fetched on a as-needed basis. `frameMaxSize` allows you to control the number of rows
-in each frame to suit your application's performance profile. By default this is set to `-1`, so that there is no limit
-on the number of rows in a frame.
-
-<strong><a name="transactionIsolation" href="#transactionIsolation">transactionIsolation</a></strong>
-Setting `transactionIsolation` allows you to set the isolation level for transactions using the connection. The value
-should be a positive integer analogous to the transaction levels defined by the JDBC specification. The default value
-is `0`, which means transactions are not supported. This is to deal with the fact that Calcite/Avatica works with
-many types of backends, with some backends having no transaction support. If you are using Apache Phoenix 4.7 onwards,
-we recommend setting it to `4`, which is the maximum isolation level supported.
-
-The supported values for `transactionIsolation` are:
-
-| Value | JDBC Constant | Description |
-| :-----| :----------------------------- | :------------------------------------------------------------------------------- |
-| 0 | none | Transactions are not supported |
-| 1 | `TRANSACTION_READ_UNCOMMITTED` | Dirty reads, non-repeatable reads and phantom reads may occur. |
-| 2 | `TRANSACTION_READ_COMMITTED` | Dirty reads are prevented, but non-repeatable reads and phantom reads may occur. |
-| 4 | `TRANSACTION_REPEATABLE_READ` | Dirty reads and non-repeatable reads are prevented, but phantom reads may occur. |
-| 8 | `TRANSACTION_SERIALIZABLE` | Dirty reads, non-repeatable reads, and phantom reads are all prevented. |
-
-## time.Time support
-
-The following datatypes are automatically converted to and from `time.Time`:
-`TIME`, `DATE` and `TIMESTAMP`.
-
-It is important to understand that Avatica and the underlying database ignores the timezone. If you save a `time.Time`
-to the database, the timezone is ignored and vice-versa. This is why you need to make sure the `location` parameter
-in your DSN is set to the same value as the location of the `time.Time` values you are inserting into the database.
-
-We recommend using `UTC`, which is the default value of `location`.
-
-## Apache Phoenix Error Codes
-The Go client comes with support for retrieving the error code when an error occurs. This is extremely useful when
-you want to take specific action when a particular type of error occurs.
-
-If the error returned is a ResponseError, calling the `Name()` method on the error will return the appropriate
-Apache Phoenix error code:
-
-~~~~go
-_, err := db.Exec("SELECT * FROM table_that_does_not_exist") // Query undefined table
-
-// First, assert the error type
-perr, ok := err.(avatica.ResponseError)
-
-// If it cannot be asserted
-if !ok{
- // Error was not an Avatica ResponseError
-}
-
-// Print the Apache Phoenix error code
-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 |
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/blob/8a661631/site/go_development.md
----------------------------------------------------------------------
diff --git a/site/go_development.md b/site/go_development.md
deleted file mode 100644
index d1b9fa8..0000000
--- a/site/go_development.md
+++ /dev/null
@@ -1,117 +0,0 @@
----
-layout: docs
-title: Go Client Development
-sidebar_title: Go Client Development
-permalink: /docs/go_development.html
----
-
-<!--
-{% comment %}
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you 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.
-{% 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.
-
-### Easy way
-1. Install [docker](https://docs.docker.com/install/) and [docker-compose](https://docs.docker.com/compose/install/).
-
-2. From the root of the repository, run `docker-compose up --build`.
-
-### Manual set up
-1. Install [Go](https://golang.org/doc/install).
-
-2. Install [dep](https://github.com/golang/dep): `go get -u github.com/golang/dep/cmd/dep`
-
-3. Install dependencies by running `dep ensure -v` from the root of the repository.
-
-4. The test suite requires access to an instance of Avatica running HSQLDB and an instance of Apache Phoenix running the
-Phoenix Query Server.
-
-You should then set the `HSQLDB_HOST` and `PHOENIX_HOST` environment variables. For example:
-~~~~~~
-HSQLDB_HOST: http://hsqldb:8765
-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.
-
-## 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).
-
-From the root of the repository, run `./make-release-artifacts.sh`.
-
-You will be asked to select the tag to build release artifacts for. The latest tag is automatically selected if no tag is selected.
-
-The release artifacts will be placed in a folder named for the release within the `dist/` folder.
-
-## Important things to note before uploading a release
-The name of the release folder must be in the following format: `apache-calcite-avatica-go-$version`. The version must
-include release candidate identifiers such as `-rc0`, if they are present.
-
-The files inside the release folder must have any release candidate identifiers such as `-rc1` removed, even if the
-release is a release candidate. `src` must also be added to the filename.
-
-For example, if we are uploading the `apache-calcite-avatica-go-3.0.0-rc1` folder, the files must be named
-`apache-calcite-acatica-go-src-3.0.0.tar.gz`. Note the inclusion of `src` in the filename.
-
-The tar.gz must be named `apache-calcite-avatica-go-src-$version.tar.gz`.
-
-There must be a GPG signature for the tar.gz named: `apache-calcite-avatica-go-src-$version.tar.gz.asc`
-
-There must be a SHA256 hash for the tar.gz named: `apache-calcite-avatica-go-src-$version.tar.gz.sha256`
-
-## Uploading release artifacts to dev for voting
-`svn` must be installed in order to upload release artifacts.
-
-1. Check out the Calcite dev release subdirectory: `svn co "https://dist.apache.org/repos/dist/dev/calcite/" calcite-dev`.
-
-2. Move the release folder under `dist/` into the `calcite-dev` folder.
-
-3. Add the new release to the svn repository: `svn add apache-calcite-avatica-go-3.0.0-rc0`. Remember to change the folder name to the
-correct release in the command.
-
-4. Commit to upload the artifacts: `svn commit -m "apache-calcite-avatica-go-3.0.0-rc0" --username yourapacheusername --force-log`
-Note the use of `--force-log` to suppress the svn warning, because the commit message is the same as the name of the directory.
-
-## Promoting a release after voting
-`svn` must be installed in order to upload release artifacts.
-
-NOTE: Only official releases that has passed a vote may be uploaded to the release directory.
-
-1. Check out the Calcite release directory: `svn co "https://dist.apache.org/repos/dist/release/calcite/" calcite-release`.
-
-2. Copy the release into the `calcite-release` folder. Remember to check the name of the release's folder to ensure that it is in
-the correct format.
-
-3. Add the release to the svn repository: `svn add apache-calcite-avatica-go-3.0.0`. Remember to change the folder name to the
-correct release in the command.
-
-4. Commit to upload the artifacts: `svn commit -m "Release apache-calcite-avatica-go-3.0.0" --username yourapacheusername`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/calcite-avatica-go/blob/8a661631/site/go_history.md
----------------------------------------------------------------------
diff --git a/site/go_history.md b/site/go_history.md
deleted file mode 100644
index 71331ca..0000000
--- a/site/go_history.md
+++ /dev/null
@@ -1,60 +0,0 @@
----
-layout: docs
-title: Go Client History
-permalink: "/docs/go_history.html"
----
-
-<!--
-{% comment %}
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you 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.
-{% endcomment %}
--->
-
-For a full list of releases, see
-<a href="https://github.com/apache/calcite-avatica-go/releases">github</a>.
-Downloads are available on the
-[downloads page]({{ site.baseurl }}/downloads/).
-
-## <a href="https://github.com/apache/calcite-avatica-go/releases/tag/3.0.0">3.0.0</a> / 2018-04-26
-{: #v3-0-0}
-
-Apache Calcite Avatica Go 3.0.0 is the first release since the Go driver has been donated
-to the Apache Software foundation.
-We recommend using the latest stable version of Go.
-
-Features and bug fixes
-
-* [<a href="https://issues.apache.org/jira/browse/CALCITE-1240">CALCITE-1240</a>]
- Intial import of the original [Boostport/avatica](https://github.com/Boostport/avatica) code-base into the
- [apache/calcite-avatica-go](https://github.com/apache/calcite-avatica-go) repository
-* [<a href="https://issues.apache.org/jira/browse/CALCITE-1938">CALCITE-1938</a>]
- Releasing the first release of Calcite Avatica Go under the Apache Software Foundation
-* Remove go-cleanhttp dependency
-* Support for Avatica HSQLDB backend and move Apache Phoenix support into adapter
-* Add bash script to automate releases with checks to alert on files without the Apache license header
-* Replace gopher.png test fixture with Calcite logo
-
-Web site and documentation
-
-* [<a href="https://issues.apache.org/jira/browse/CALCITE-1937">CALCITE-1937</a>]
- Set up Calcite Avatica Go website
-
-## Past releases
-
-Prior to release 3.0.0, the Avatica Go client was developed by Boostport.
-
-Please refer to the [Boostport/Avatica](https://github.com/Boostport/avatica) Github repository for previous releases
-of the Avatica Go client.
\ No newline at end of file