ctl

Documentation

Overview

package ctl contains all pilosa subcommands other than 'server'. These are generally administration, testing, and debugging tools.

Index

• func BuildServerFlags(cmd *cobra.Command, srv *server.Command)
• func SetTLSConfig(flags *pflag.FlagSet, certificatePath *string, certificateKeyPath *string, ...)
• type CheckCommand
  • func NewCheckCommand(stdin io.Reader, stdout, stderr io.Writer) *CheckCommand
  • func (cmd *CheckCommand) Run(_ context.Context) error
• type CommandWithTLSSupport
• type ConfigCommand
  • func NewConfigCommand(stdin io.Reader, stdout, stderr io.Writer) *ConfigCommand
  • func (cmd *ConfigCommand) Run(_ context.Context) error
• type ExportCommand
  • func NewExportCommand(stdin io.Reader, stdout, stderr io.Writer) *ExportCommand
  • func (cmd *ExportCommand) Run(ctx context.Context) error
  • func (cmd *ExportCommand) TLSConfiguration() server.TLSConfig
  • func (cmd *ExportCommand) TLSHost() string
• type GenerateConfigCommand
  • func NewGenerateConfigCommand(stdin io.Reader, stdout, stderr io.Writer) *GenerateConfigCommand
  • func (cmd *GenerateConfigCommand) Run(_ context.Context) error
• type ImportCommand
  • func NewImportCommand(stdin io.Reader, stdout, stderr io.Writer) *ImportCommand
  • func (cmd *ImportCommand) Run(ctx context.Context) error
  • func (cmd *ImportCommand) TLSConfiguration() server.TLSConfig
  • func (cmd *ImportCommand) TLSHost() string
• type InspectCommand
  • func NewInspectCommand(stdin io.Reader, stdout, stderr io.Writer) *InspectCommand
  • func (cmd *InspectCommand) Run(_ context.Context) error

Functions

func BuildServerFlags

func BuildServerFlags(cmd *cobra.Command, srv *server.Command)

BuildServerFlags attaches a set of flags to the command for a server instance.

func SetTLSConfig

func SetTLSConfig(flags *pflag.FlagSet, certificatePath *string, certificateKeyPath *string, skipVerify *bool)

SetTLSConfig creates common TLS flags

Types

type CheckCommand

type CheckCommand struct {
	// Data file paths.
	Paths []string

	// Standard input/output
	*pilosa.CmdIO
}

CheckCommand represents a command for performing consistency checks on data files.

func NewCheckCommand

func NewCheckCommand(stdin io.Reader, stdout, stderr io.Writer) *CheckCommand

NewCheckCommand returns a new instance of CheckCommand.

func (*CheckCommand) Run

func (cmd *CheckCommand) Run(_ context.Context) error

Run executes the check command.

type CommandWithTLSSupport

type CommandWithTLSSupport interface {
	TLSHost() string
	TLSConfiguration() server.TLSConfig
}

CommandWithTLSSupport is the interface for commands which has TLS settings

type ConfigCommand

type ConfigCommand struct {
	*pilosa.CmdIO
	Config *server.Config
}

ConfigCommand represents a command for printing a default config.

func NewConfigCommand

func NewConfigCommand(stdin io.Reader, stdout, stderr io.Writer) *ConfigCommand

NewConfigCommand returns a new instance of ConfigCommand.

func (*ConfigCommand) Run

func (cmd *ConfigCommand) Run(_ context.Context) error

Run prints out the default config.

type ExportCommand

type ExportCommand struct {
	// Remote host and port.
	Host string

	// Name of the index & field to export from.
	Index string
	Field string

	// Filename to export to.
	Path string

	// Standard input/output
	*pilosa.CmdIO

	TLS server.TLSConfig
}

ExportCommand represents a command for bulk exporting data from a server.

func NewExportCommand

func NewExportCommand(stdin io.Reader, stdout, stderr io.Writer) *ExportCommand

NewExportCommand returns a new instance of ExportCommand.

func (*ExportCommand) Run

func (cmd *ExportCommand) Run(ctx context.Context) error

Run executes the export.

func (*ExportCommand) TLSConfiguration

func (cmd *ExportCommand) TLSConfiguration() server.TLSConfig

func (*ExportCommand) TLSHost

func (cmd *ExportCommand) TLSHost() string

type GenerateConfigCommand

type GenerateConfigCommand struct {
	*pilosa.CmdIO
}

GenerateConfigCommand represents a command for printing a default config.

func NewGenerateConfigCommand

func NewGenerateConfigCommand(stdin io.Reader, stdout, stderr io.Writer) *GenerateConfigCommand

NewGenerateConfigCommand returns a new instance of GenerateConfigCommand.

func (*GenerateConfigCommand) Run

func (cmd *GenerateConfigCommand) Run(_ context.Context) error

Run prints out the default config.

type ImportCommand

type ImportCommand struct {
	// Destination host and port.
	Host string `json:"host"`

	// Name of the index & field to import into.
	Index string `json:"index"`
	Field string `json:"field"`

	// Options for the index to be created if it doesn't exist
	IndexOptions pilosa.IndexOptions

	// Options for the field to be created if it doesn't exist
	FieldOptions pilosa.FieldOptions

	// CreateSchema ensures the schema exists before import
	CreateSchema bool

	// Clear clears the import data as opposed to setting it.
	Clear bool

	// Filenames to import from.
	Paths []string `json:"paths"`

	// Size of buffer used to chunk import.
	BufferSize int `json:"bufferSize"`

	// Enables sorting of data file before import.
	Sort bool `json:"sort"`

	// Standard input/output
	*pilosa.CmdIO

	TLS server.TLSConfig
	// contains filtered or unexported fields
}

ImportCommand represents a command for bulk importing data.

func NewImportCommand

func NewImportCommand(stdin io.Reader, stdout, stderr io.Writer) *ImportCommand

NewImportCommand returns a new instance of ImportCommand.

func (*ImportCommand) Run

func (cmd *ImportCommand) Run(ctx context.Context) error

Run executes the main program execution.

func (*ImportCommand) TLSConfiguration

func (cmd *ImportCommand) TLSConfiguration() server.TLSConfig

func (*ImportCommand) TLSHost

func (cmd *ImportCommand) TLSHost() string

type InspectCommand

type InspectCommand struct {
	// Path to data file
	Path string

	// Standard input/output
	*pilosa.CmdIO
}

InspectCommand represents a command for inspecting fragment data files.

func NewInspectCommand

func NewInspectCommand(stdin io.Reader, stdout, stderr io.Writer) *InspectCommand

NewInspectCommand returns a new instance of InspectCommand.

func (*InspectCommand) Run

func (cmd *InspectCommand) Run(_ context.Context) error

Run executes the inspect command.