agoradb

README

• Client generation

Client generation

Compiler: protoc or flatc

FlatBuffers

Take a look at Google's guide: Building the compiler

Protocol Buffers

Here are some OS-specific options for installing the binary. These instructions also install basic .proto files like wrappers.proto, any.proto and descriptor.proto. (Those files aren’t needed by proto-lens itself, but they may be useful for other language bindings/plugins.)

####### Mac OS X If you have Homebrew (which you can get from https://brew.sh), just run:

# depends on protobuf (protoc)
brew install protoc-gen-go

If you see any error messages, run brew doctor, follow any recommended fixes, and try again. If it still fails, try instead:

brew upgrade protobuf Alternately, run the following commands:

curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.7.1/protoc-3.7.1-osx-x86_64.zip
sudo unzip -o protoc-3.7.1-osx-x86_64.zip -d /usr/local bin/protoc
sudo unzip -o protoc-3.7.1-osx-x86_64.zip -d /usr/local 'include/*'
rm -f protoc-3.7.1-osx-x86_64.zip

####### Linux Run the following commands:

curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.7.1/protoc-3.7.1-linux-x86_64.zip
sudo unzip -o protoc-3.7.1-linux-x86_64.zip -d /usr/local bin/protoc
sudo unzip -o protoc-3.7.1-linux-x86_64.zip -d /usr/local 'include/*'
rm -f protoc-3.7.1-linux-x86_64.zip

Alternately, manually download and install protoc from here.

Documentation

Index

• type Auth
• type Client
  • func New(config Config) (*Client, error)
  • func (c *Client) Config() Config
• type Config

Types

type Auth

type Auth struct {

	// User to be used for authentication
	User string

	// The database Password for the named user
	Password string

	// The client certificate to be used for authentication
	//
	// If the CertificatePath is set, user and password entries will be ignored.
	CertificatePath string

	// Optionally you can set the RootCA cert, it overrides the system certificates
	RootCA string
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

The connection

func New

func New(config Config) (*Client, error)

func (*Client) Config

func (c *Client) Config() Config

Returns a copy of the internal configuration

type Config

type Config struct {
	// The agoradb node endpoint to connect to
	//
	// The format is host:port
	Uri string

	// The authentication to be used
	Auth Auth
}