Creating interface

.envrc

@@ -0,0 +1,8 @@
+export GOBUILDDIR=$(pwd)/.gobuild
+export GOPATH=$GOBUILDDIR:$GOPATH
+PATH_add $GOBUILDDIR/bin
+
+if [ ! -e ${GOBUILDDIR} ]; then
+    mkdir -p ${GOBUILDDIR}/src/github.com/arangodb/
+    ln -s ../../../.. ${GOBUILDDIR}/src/github.com/arangodb/go-driver
+fi

.gitignore

@@ -0,0 +1 @@
+.gobuild

.vscode/settings.json

@@ -0,0 +1,36 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "fileHeaderComment.parameter":{
+        "*":{
+            "commentprefix": "//",
+            "company": "ArangoDB GmbH, Cologne, Germany",
+            "author": "Ewout Prangsma"
+        }
+    },
+    "fileHeaderComment.template":{
+        "*":[
+            "${commentprefix} ",
+            "${commentprefix} DISCLAIMER",
+            "${commentprefix} ",
+            "${commentprefix} Copyright ${year} ArangoDB GmbH, Cologne, Germany",
+            "${commentprefix} ",
+            "${commentprefix} Licensed under the Apache License, Version 2.0 (the \"License\");",
+            "${commentprefix} you may not use this file except in compliance with the License.",
+            "${commentprefix} You may obtain a copy of the License at",
+            "${commentprefix} ",
+            "${commentprefix} http://www.apache.org/licenses/LICENSE-2.0",
+            "${commentprefix} ",
+            "${commentprefix} Unless required by applicable law or agreed to in writing, software",
+            "${commentprefix} distributed under the License is distributed on an \"AS IS\" BASIS,",
+            "${commentprefix} WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.",
+            "${commentprefix} See the License for the specific language governing permissions and",
+            "${commentprefix} limitations under the License.",
+            "${commentprefix} ",
+            "${commentprefix} Copyright holder is ArangoDB GmbH, Cologne, Germany",
+            "${commentprefix} ",
+            "${commentprefix} Author ${author}",
+            "${commentprefix} ",
+            ""
+        ]
+    }
+}

client.go

@@ -0,0 +1,52 @@
+//
+// DISCLAIMER
+//
+// Copyright 2017 ArangoDB GmbH, Cologne, Germany
+//
+// 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.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Ewout Prangsma
+//
+
+package driver
+
+import "context"
+
+// Client provides access to a single arangodb database server, or an entire cluster of arangodb servers.
+type Client interface {
+	// Database opens a connection to an existing database.
+	// If no database with given name exists, an NotFoundError is returned.
+	Database(ctx context.Context, name string) (Database, error)
+
+	// DatabaseExists returns true if a database with given name exists.
+	DatabaseExists(ctx context.Context, name string) (bool, error)
+
+	// Databases returns a list of all databases found by the client.
+	Databases(ctx context.Context) ([]Database, error)
+
+	// AccessibleDatabases returns a list of all databases that can be accessed by the authenticated user.
+	AccessibleDatabases(ctx context.Context) ([]Database, error)
+
+	// CreateDatabase creates a new database with given name and opens a connection to it.
+	// If the a database with given name already exists, a DuplicateError is returned.
+	CreateDatabase(ctx context.Context, name string) (Database, error)
+}
+
+// ClientConfig contains all settings needed to create a client.
+type ClientConfig struct {
+	// Endpoints holds 1 or more URL's used to connect to the database.
+	// In case of a connection to an ArangoDB cluster, you must provide the URL's of all coordinators.
+	Endpoints []string
+}

collection.go

@@ -0,0 +1,41 @@
+//
+// DISCLAIMER
+//
+// Copyright 2017 ArangoDB GmbH, Cologne, Germany
+//
+// 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.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Ewout Prangsma
+//
+
+package driver
+
+import "context"
+
+// Collection provides access to the documents in a single collection.
+type Collection interface {
+	// Name returns the name of the collection.
+	Name() string
+
+	// ReadDocument reads a single document with given key from the collection.
+	// The document data is stored into result, the document meta data is returned.
+	// If no document exists with given key, a NotFoundError is returned.
+	ReadDocument(ctx context.Context, key string, result interface{}) (DocumentMeta, error)
+
+	// UpdateDocument updates a single document with given key in the collection.
+	// The document data is stored into result, the document meta data is returned.
+	// If no document exists with given key, a NotFoundError is returned.
+	UpdateDocument(ctx context.Context, key string, update map[string]interface{}, resultOld, resultNew interface{}) (DocumentMeta, error)
+}

database.go

@@ -0,0 +1,46 @@
+//
+// DISCLAIMER
+//
+// Copyright 2017 ArangoDB GmbH, Cologne, Germany
+//
+// 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.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Ewout Prangsma
+//
+
+package driver
+
+import "context"
+
+// Database provides access to all collections & graphs in a single database.
+type Database interface {
+	// Collection opens a connection to an existing collection within the database.
+	// If no collection with given name exists, an NotFoundError is returned.
+	Collection(ctx context.Context, name string) (Collection, error)
+
+	// CollectionExists returns true if a collection with given name exists within the database.
+	CollectionExists(ctx context.Context, name string) (bool, error)
+
+	// Collections returns a list of all collections in the database.
+	Collections(ctx context.Context) ([]Collection, error)
+
+	// CreateCollection creates a new collection with given name and options, and opens a connection to it.
+	// If a collection with given name already exists within the database, a DuplicateError is returned.
+	CreateCollection(ctx context.Context, name string, options *CreateCollectionOptions) (Collection, error)
+}
+
+// CreateCollectionOptions contains options that customize the creating of a collection.
+type CreateCollectionOptions struct {
+}

error.go

@@ -0,0 +1,52 @@
+//
+// DISCLAIMER
+//
+// Copyright 2017 ArangoDB GmbH, Cologne, Germany
+//
+// 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.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Ewout Prangsma
+//
+
+package driver
+
+// ArangoError is a Go error with arangodb specific error information.
+type ArangoError struct {
+	HasError     bool   `json:"error"`
+	Code         int    `json:"code"`
+	ErrorNum     int    `json:"errorNum"`
+	ErrorMessage string `json:"errorMessage"`
+}
+
+// Error returns the error message of an ArangoError.
+func (ae ArangoError) Error() string {
+	return ae.ErrorMessage
+}
+
+// IsArangoErrorWithCode returns true when the given error is an ArangoError and its Code field is equal to the given code.
+func IsArangoErrorWithCode(err error, code int) bool {
+	ae, ok := err.(ArangoError)
+	return ok && ae.Code == code
+}
+
+// IsInvalidRequest return true if the given error is an ArangoError with code 400, indicating an invalid request.
+func IsInvalidRequest(err error) bool {
+	return IsArangoErrorWithCode(err, 400)
+}
+
+// IsNotFound return true if the given error is an ArangoError with code 404, indicating a object not found.
+func IsNotFound(err error) bool {
+	return IsArangoErrorWithCode(err, 404)
+}

meta.go

@@ -0,0 +1,30 @@
+//
+// DISCLAIMER
+//
+// Copyright 2017 ArangoDB GmbH, Cologne, Germany
+//
+// 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.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Ewout Prangsma
+//
+
+package driver
+
+// DocumentMeta contains all meta data used to identifier a document.
+type DocumentMeta struct {
+	Key string `json:"_key,omitempty"`
+	ID  string `json:"_id,omitempty"`
+	Rev string `json:"_rev,omitempty"`
+}