ctl

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 20, 2018 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildServerFlags added in v0.4.0

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

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

func SetTLSConfig added in v0.8.0

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 added in v0.8.0

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 added in v0.8.0

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

func (*ExportCommand) TLSHost added in v0.8.0

func (cmd *ExportCommand) TLSHost() string

type GenerateConfigCommand added in v0.4.0

type GenerateConfigCommand struct {
	*pilosa.CmdIO
}

GenerateConfigCommand represents a command for printing a default config.

func NewGenerateConfigCommand added in v0.4.0

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

NewGenerateConfigCommand returns a new instance of GenerateConfigCommand.

func (*GenerateConfigCommand) Run added in v0.4.0

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 added in v0.8.0

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

func (*ImportCommand) TLSHost added in v0.8.0

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL