agoradb

package module
v0.0.0-...-52d38b8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 31, 2020 License: BSD-3-Clause Imports: 0 Imported by: 0

README

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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
}

Directories

Path Synopsis
cli
cmd
examples
proxy
Package proxy provides a reverse proxy handler for gRPC.
Package proxy provides a reverse proxy handler for gRPC.
internal
schema
This package is organizes the schema related use cases
This package is organizes the schema related use cases
Node is a single node in the database cluster, which acts as the interface between the clients and the storage layer
Node is a single node in the database cluster, which acts as the interface between the clients and the storage layer

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL