fossil

Documentation

Index

• type Client
  • func NewClient(connstr string) (Client, error)
  • func NewClientPool(connstr string, size uint) (Client, error)
• type LocalClient
  • func (client *LocalClient) Append(topic string, data []byte) error
  • func (client *LocalClient) Close() error
  • func (client *LocalClient) Open(target proto.ConnectionString, _ uint) error
  • func (client *LocalClient) Query(q string) (database.Entries, error)
  • func (client *LocalClient) Send(message proto.Message) (proto.Message, error)
• type RemoteClient
  • func (client *RemoteClient) Append(topic string, data []byte) error
  • func (client *RemoteClient) Close() error
  • func (client *RemoteClient) Open(connectionString proto.ConnectionString, size uint) error
  • func (client *RemoteClient) Query(q string) (database.Entries, error)
  • func (client *RemoteClient) Send(m proto.Message) (proto.Message, error)

Types

type Client

type Client interface {
	Open(proto.ConnectionString, uint) error
	Close() error
	Send(proto.Message) (proto.Message, error)
	Append(string, []byte) error
	Query(string) (database.Entries, error)
}

func NewClient

func NewClient(connstr string) (Client, error)

NewClient creates a new Client struct which can be used to interact with a remote fossil database. The client is thread safe, but only holds one connection at a time. For a client pool, use NewClientPool instead.

func NewClientPool

func NewClientPool(connstr string, size uint) (Client, error)

NewClientPool creates a new Client struct which holds a pool of net.Conn resources open to a remote fossil database. This is useful for sending large volumes of data to fossil.

type LocalClient

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

func (*LocalClient) Append

func (client *LocalClient) Append(topic string, data []byte) error

func (*LocalClient) Close

func (client *LocalClient) Close() error

func (*LocalClient) Open

func (client *LocalClient) Open(target proto.ConnectionString, _ uint) error

func (*LocalClient) Query

func (client *LocalClient) Query(q string) (database.Entries, error)

func (*LocalClient) Send

func (client *LocalClient) Send(message proto.Message) (proto.Message, error)

type RemoteClient

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

A RemoteClient holds the data needed to interact with a fossil database.

func (*RemoteClient) Append

func (client *RemoteClient) Append(topic string, data []byte) error

Append data to the specified topic.

func (*RemoteClient) Close

func (client *RemoteClient) Close() error

func (*RemoteClient) Open

func (client *RemoteClient) Open(connectionString proto.ConnectionString, size uint) error

func (*RemoteClient) Query

func (client *RemoteClient) Query(q string) (database.Entries, error)

Query the database for some time-series data.

func (*RemoteClient) Send

func (client *RemoteClient) Send(m proto.Message) (proto.Message, error)

Send a general message to the fossil server.