server

Documentation

Index

• type Command
  • func NewCommand(stdin io.Reader, stdout, stderr io.Writer, opts ...CommandOption) *Command
  • func (m *Command) Close() error
  • func (m *Command) GossipTransport() *gossip.Transport
  • func (m *Command) SetupServer() error
  • func (m *Command) Start() (err error)
  • func (m *Command) Wait() error
• type CommandOption
  • func OptCommandCloseTimeout(d time.Duration) CommandOption
  • func OptCommandServerOptions(opts ...pilosa.ServerOption) CommandOption
• type Config
  • func NewConfig() *Config
• type TLSConfig

Types

type Command

type Command struct {
	Server *pilosa.Server

	// Configuration.
	Config *Config

	// Standard input/output
	*pilosa.CmdIO

	// Started will be closed once Command.Start is finished.
	Started chan struct{}

	Handler pilosa.Handler
	API     *pilosa.API
	// contains filtered or unexported fields
}

Command represents the state of the pilosa server command.

func NewCommand

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

NewCommand returns a new instance of Main.

func (*Command) Close

func (m *Command) Close() error

Close shuts down the server.

func (*Command) GossipTransport

func (m *Command) GossipTransport() *gossip.Transport

GossipTransport allows a caller to return the gossip transport created when setting up the GossipMemberSet. This is useful if one needs to determine the allocated ephemeral port programmatically. (usually used in tests)

func (*Command) SetupServer

func (m *Command) SetupServer() error

SetupServer uses the cluster configuration to set up this server.

func (*Command) Start

func (m *Command) Start() (err error)

Start starts the pilosa server - it returns once the server is running.

func (*Command) Wait

func (m *Command) Wait() error

Wait waits for the server to be closed or interrupted.

type CommandOption

type CommandOption func(c *Command) error

func OptCommandCloseTimeout

func OptCommandCloseTimeout(d time.Duration) CommandOption

func OptCommandServerOptions

func OptCommandServerOptions(opts ...pilosa.ServerOption) CommandOption

type Config

type Config struct {
	// DataDir is the directory where Pilosa stores both indexed data and
	// running state such as cluster topology information.
	DataDir string `toml:"data-dir"`
	// Bind is the host:port on which Pilosa will listen.
	Bind string `toml:"bind"`

	// MaxWritesPerRequest limits the number of mutating commands that can be in
	// a single request to the server. This includes Set, Clear,
	// SetRowAttrs & SetColumnAttrs.
	MaxWritesPerRequest int `toml:"max-writes-per-request"`

	// LogPath configures where Pilosa will write logs.
	LogPath string `toml:"log-path"`

	// Verbose toggles verbose logging which can be useful for debugging.
	Verbose bool `toml:"verbose"`

	// HTTP Handler options
	Handler struct {
		// CORS Allowed Origins
		AllowedOrigins []string `toml:"allowed-origins"`
	} `toml:"handler"`

	// TLS
	TLS TLSConfig `toml:"tls"`

	Cluster struct {
		// Disabled controls whether clustering functionality is enabled.
		Disabled      bool          `toml:"disabled"`
		Coordinator   bool          `toml:"coordinator"`
		ReplicaN      int           `toml:"replicas"`
		Hosts         []string      `toml:"hosts"`
		LongQueryTime toml.Duration `toml:"long-query-time"`
	} `toml:"cluster"`

	// Gossip config is based around memberlist.Config.
	Gossip gossip.Config `toml:"gossip"`

	Translation struct {
		MapSize int `toml:"map-size"`
		// DEPRECATED: Translation config supports translation store replication.
		PrimaryURL string `toml:"primary-url"`
	} `toml:"translation"`

	AntiEntropy struct {
		Interval toml.Duration `toml:"interval"`
	} `toml:"anti-entropy"`

	Metric struct {
		// Service can be statsd, expvar, or none.
		Service string `toml:"service"`
		// Host tells the statsd client where to write.
		Host         string        `toml:"host"`
		PollInterval toml.Duration `toml:"poll-interval"`
		// Diagnostics toggles sending some limited diagnostic information to
		// Pilosa's developers.
		Diagnostics bool `toml:"diagnostics"`
	} `toml:"metric"`

	Tracing struct {
		// SamplerType is the type of sampler to use.
		SamplerType string `toml:"sampler-type"`
		// SamplerParam is the parameter passed to the tracing sampler.
		// Its meaning is dependent on the type of sampler.
		SamplerParam float64 `toml:"sampler-param"`
		// AgentHostPort is the host:port of the local agent.
		AgentHostPort string `toml:"agent-host-port"`
	} `toml:"tracing"`
}

Config represents the configuration for the command.

func NewConfig

func NewConfig() *Config

NewConfig returns an instance of Config with default options.

type TLSConfig

type TLSConfig struct {
	// CertificatePath contains the path to the certificate (.crt or .pem file)
	CertificatePath string `toml:"certificate"`
	// CertificateKeyPath contains the path to the certificate key (.key file)
	CertificateKeyPath string `toml:"key"`
	// SkipVerify disables verification for self-signed certificates
	SkipVerify bool `toml:"skip-verify"`
}

TLSConfig contains TLS configuration