component

Documentation

Index

• Constants
• func NewClientRedis(db int) *redis.Client
• func NewLogger() *log.Entry
• func NewMYSQL(host string) (*sql.DB, error)
• func NewPSQL(host string) (*sql.DB, error)
• type Arango
  • func NewArango(db string, endpoints []string, user, password string, options ...OptionArango) *Arango
  • func (a *Arango) CreateCollections(ctx context.Context, collections []Collection) error
  • func (a *Arango) CreateCursorWithIdAndTime(id string, createdAt time.Time) string
  • func (a *Arango) CreateGraph(ctx context.Context, graph *Graph) error
  • func (a *Arango) DB() driver.Database
  • func (a *Arango) EnhanceBindVarsWithIdTimeCursor(bindVars map[string]interface{}, pagination Pagination) (map[string]interface{}, error)
  • func (a *Arango) GetIDTimeCursor(cursor string) (string, time.Time, error)
  • func (a *Arango) InitDB(ctx context.Context) error
• type Collection
• type DriverName
• type Edge
• type FullTextIndex
  • func (g FullTextIndex) Fields() []string
  • func (g FullTextIndex) Name() string
• type GRPCServer
  • func NewGRPCServer() *GRPCServer
  • func (s *GRPCServer) ListenAddress() string
  • func (s *GRPCServer) Server() *grpc.Server
• type GeoIndex
  • func (g GeoIndex) Fields() []string
  • func (g GeoIndex) Name() string
• type Graph
• type HashIndex
  • func (g HashIndex) Fields() []string
  • func (g HashIndex) Name() string
• type Index
• type IndexType
• type OptionArango
• type OptionServer
  • func OptionErrorLogWriter(log io.Writer) OptionServer
• type Pagination
• type Server
  • func NewServer(handler http.Handler, options ...OptionServer) *Server
  • func (s *Server) ListenAndServe() error
  • func (s *Server) Shutdown(ctx context.Context) error
• type TTLIndex
  • func (g TTLIndex) Fields() []string
  • func (g TTLIndex) Name() string

Constants

const (
	ErrDuplicate                    = 1207
	ErrGraphDuplicate               = 1925
	ErrCollectionAlreadyInGraph     = 1938
	ErrCollectionAlreadyInEdgeGraph = 1929
	ErrEdgeAlreadyInGraph           = 1920
)

For more info in regard of this error codes go to https://www.arangodb.com/docs/stable/appendix-error-codes.html

Functions

func NewClientRedis

func NewClientRedis(db int) *redis.Client

func NewLogger

func NewLogger() *log.Entry

func NewMYSQL

func NewMYSQL(host string) (*sql.DB, error)

func NewPSQL

func NewPSQL(host string) (*sql.DB, error)

Types

type Arango

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

func NewArango

func NewArango(db string, endpoints []string, user, password string, options ...OptionArango) *Arango

func (*Arango) CreateCollections

func (a *Arango) CreateCollections(ctx context.Context, collections []Collection) error

func (*Arango) CreateCursorWithIdAndTime

func (a *Arango) CreateCursorWithIdAndTime(id string, createdAt time.Time) string

CreateCursorWithIdAndTime gets a cursor using the Id and createdAt

func (*Arango) CreateGraph

func (a *Arango) CreateGraph(ctx context.Context, graph *Graph) error

func (*Arango) DB

func (a *Arango) DB() driver.Database

func (*Arango) EnhanceBindVarsWithIdTimeCursor

func (a *Arango) EnhanceBindVarsWithIdTimeCursor(bindVars map[string]interface{}, pagination Pagination) (map[string]interface{}, error)

EnhanceBinVarsWithIdTimeCursor adds an extra set of bindVars used for pagination and adds a limit to the pagination

func (*Arango) GetIDTimeCursor

func (a *Arango) GetIDTimeCursor(cursor string) (string, time.Time, error)

func (*Arango) InitDB

func (a *Arango) InitDB(ctx context.Context) error

type Collection

type Collection struct {
	Name    string
	Indexes []Index
}

type DriverName

type DriverName string

const (
	Postgres DriverName = "postgres"
	Mysql    DriverName = "mysql"
)

type Edge

type Edge struct {
	Name    string
	Indexes []Index
	// From: contains the names of one or more vertex collections that can contain source vertices.
	// To: contains the names of one or more edge collections that can contain target vertices
	From []string
	To   []string
}

type FullTextIndex

type FullTextIndex struct {
	MinLength int
	IxName    string
	IxFields  []string
}

func (FullTextIndex) Fields

func (g FullTextIndex) Fields() []string

func (FullTextIndex) Name

func (g FullTextIndex) Name() string

type GRPCServer

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

func NewGRPCServer

func NewGRPCServer() *GRPCServer

func (*GRPCServer) ListenAddress

func (s *GRPCServer) ListenAddress() string

func (*GRPCServer) Server

func (s *GRPCServer) Server() *grpc.Server

type GeoIndex

type GeoIndex struct {
	IxName   string
	IxFields []string
	GeoJson  bool
}

func (GeoIndex) Fields

func (g GeoIndex) Fields() []string

func (GeoIndex) Name

func (g GeoIndex) Name() string

type Graph

type Graph struct {
	Name     string
	Edges    []Edge
	Vertexes []Collection
}

type HashIndex

type HashIndex struct {
	IxName   string
	IxFields []string
	Unique   bool
	Sparse   bool
}

func (HashIndex) Fields

func (g HashIndex) Fields() []string

func (HashIndex) Name

func (g HashIndex) Name() string

type Index

type Index interface {
	Name() string
	Fields() []string
}

type IndexType

type IndexType int

type OptionArango

type OptionArango func(*Arango)

type OptionServer

type OptionServer func(*Server)

func OptionErrorLogWriter

func OptionErrorLogWriter(log io.Writer) OptionServer

type Pagination

type Pagination struct {
	Limit int
	After string
}

type Server

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

func NewServer

func NewServer(handler http.Handler, options ...OptionServer) *Server

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

type TTLIndex

type TTLIndex struct {
	IxName      string
	IxField     string
	ExpireAfter int
}

func (TTLIndex) Fields

func (g TTLIndex) Fields() []string

func (TTLIndex) Name

func (g TTLIndex) Name() string