command

Documentation

Index

• Constants
• type Server
  • func (c *Server) Execute(args []string) error
• type Version
  • func (c *Version) Execute(args []string) error

Constants

const (
	ServerDescription = "Starts a gitbase server instance"
	ServerHelp        = ServerDescription + "\n\n" +
		"The squashing tables and pushing down join conditions is still a\n" +
		"work in progress and unstable,disable by default can be enabled\n" +
		"using a not empty value at GITBASE_UNSTABLE_SQUASH_ENABLE env variable.\n\n" +
		"By default when gitbase encounters and error in a repository it\n" +
		"stops the query. With GITBASE_SKIP_GIT_ERRORS variable it won't\n" +
		"complain and just skip those rows or repositories."
)

const (
	VersionDescription = "Show the version information"
	VersionHelp        = VersionDescription
)

Types

type Server

type Server struct {
	Verbose  bool     `short:"v" description:"Activates the verbose mode"`
	Git      []string `short:"g" long:"git" description:"Path where the git repositories are located, multiple directories can be defined"`
	Siva     []string `long:"siva" description:"Path where the siva repositories are located, multiple directories can be defined"`
	Host     string   `short:"h" long:"host" default:"localhost" description:"Host where the server is going to listen"`
	Port     int      `short:"p" long:"port" default:"3306" description:"Port where the server is going to listen"`
	User     string   `short:"u" long:"user" default:"root" description:"User name used for connection"`
	Password string   `short:"P" long:"password" default:"" description:"Password used for connection"`

	// UnstableSquash quashing tables and pushing down join conditions is still
	// a work in progress and unstable. To enable it, the GITBASE_UNSTABLE_SQUASH_ENABLE
	// must not be empty.
	UnstableSquash bool
	// IgnoreGitErrors by default when gitbase encounters and error in a
	// repository it stops the query. With this parameter it won't complain and
	// just skip those rows or repositories.
	SkipGitErrors bool
	// contains filtered or unexported fields
}

Server represents the `server` command of gitbase cli tool.

func (*Server) Execute

func (c *Server) Execute(args []string) error

Execute starts a new gitbase server based on provided configuration, it honors the go-flags.Commander interface.

type Version

type Version struct {
	// Name of the cli binary
	Name string
}

Version represents the `version` command of gitbase cli tool.

func (*Version) Execute

func (c *Version) Execute(args []string) error

Execute prints the build information provided by the compilation tools, it honors the go-flags.Commander interface.