ctl

package
v0.3.2 Latest Latest
Warning

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

Go to latest
Published: May 10, 2017 License: Apache-2.0 Imports: 19 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

This section is empty.

Types

type BackupCommand

type BackupCommand struct {
	// Destination host and port.
	Host string

	// Name of the index, frame, view to backup.
	Index string
	Frame string
	View  string

	// Output file to write to.
	Path string

	// Standard input/output
	*pilosa.CmdIO
}

BackupCommand represents a command for backing up a view.

func NewBackupCommand

func NewBackupCommand(stdin io.Reader, stdout, stderr io.Writer) *BackupCommand

NewBackupCommand returns a new instance of BackupCommand.

func (*BackupCommand) Run

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

Run executes the backup.

type BenchCommand

type BenchCommand struct {
	// Destination host and port.
	Host string

	// Name of the index & frame to execute against.
	Index string
	Frame string

	// Type of operation and number to execute.
	Op string
	N  int

	// Standard input/output
	*pilosa.CmdIO
}

BenchCommand represents a command for benchmarking index operations.

func NewBenchCommand

func NewBenchCommand(stdin io.Reader, stdout, stderr io.Writer) *BenchCommand

NewBenchCommand returns a new instance of BenchCommand.

func (*BenchCommand) Run

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

Run executes the bench command.

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(ctx context.Context) error

Run executes the check command.

type ConfigCommand

type ConfigCommand struct {
	*pilosa.CmdIO
}

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(ctx context.Context) error

Run prints out the default config.

type ExportCommand

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

	// Name of the index & frame to export from.
	Index string
	Frame string

	// Filename to export to.
	Path string

	// Standard input/output
	*pilosa.CmdIO
}

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.

type ImportCommand

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

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

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

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

	// Reusable client.
	Client *pilosa.Client `json:"-"`

	// Standard input/output
	*pilosa.CmdIO
}

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) String

func (cmd *ImportCommand) String() 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(ctx context.Context) error

Run executes the inspect command.

type RestoreCommand

type RestoreCommand struct {
	// Destination host and port.
	Host string

	// Name of the index & frame to backup.
	Index string
	Frame string
	View  string

	// Import file to read from.
	Path string

	// Standard input/output
	*pilosa.CmdIO
}

RestoreCommand represents a command for restoring a frame from a backup.

func NewRestoreCommand

func NewRestoreCommand(stdin io.Reader, stdout, stderr io.Writer) *RestoreCommand

NewRestoreCommand returns a new instance of RestoreCommand.

func (*RestoreCommand) Run

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

Run executes the restore command.

type SortCommand

type SortCommand struct {
	// Filename to sort
	Path string

	// Standard input/output
	*pilosa.CmdIO
}

SortCommand represents a command for sorting import data.

func NewSortCommand

func NewSortCommand(stdin io.Reader, stdout, stderr io.Writer) *SortCommand

NewSortCommand returns a new instance of SortCommand.

func (*SortCommand) Run

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

Run executes the sort command.

Jump to

Keyboard shortcuts

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