server

Documentation

Overview

Package server contains the `pilosa server` subcommand which runs Pilosa itself. The purpose of this package is to define an easily tested Command object which handles interpreting configuration and setting up all the objects that Pilosa needs.

Index

• Constants
• func GetLogWriter(path string, defaultWriter io.Writer) (io.Writer, error)
• func NewStatsClient(name string, host string) (pilosa.StatsClient, error)
• type Command
  • func NewCommand(stdin io.Reader, stdout, stderr io.Writer) *Command
  • func (m *Command) Close() error
  • func (m *Command) Run(args ...string) (err error)
  • func (m *Command) SetupServer() error

Constants

const (
	// DefaultDataDir is the default data directory.
	DefaultDataDir = "~/.pilosa"
)

Functions

func GetLogWriter

func GetLogWriter(path string, defaultWriter io.Writer) (io.Writer, error)

GetLogWriter opens a file for logging, or a default io.Writer (such as stderr) for an empty path.

func NewStatsClient

func NewStatsClient(name string, host string) (pilosa.StatsClient, error)

NewStatsClient creates a stats client from the config

Types

type Command

type Command struct {
	Server *pilosa.Server

	// Configuration.
	Config *pilosa.Config

	// Profiling options.
	CPUProfile string
	CPUTime    time.Duration

	// Standard input/output
	*pilosa.CmdIO

	// running will be closed once Command.Run is finished.
	Started chan struct{}
	// Done will be closed when Command.Close() is called
	Done chan struct{}
}

Command represents the state of the pilosa server command.

func NewCommand

func NewCommand(stdin io.Reader, stdout, stderr io.Writer) *Command

NewCommand returns a new instance of Main.

func (*Command) Close

func (m *Command) Close() error

Close shuts down the server.

func (*Command) Run

func (m *Command) Run(args ...string) (err error)

Run executes the pilosa server.

func (*Command) SetupServer

func (m *Command) SetupServer() error

SetupServer uses the cluster configuration to set up this server.