command

Documentation

Index

• Constants
• func NewDatabaseEngine(userAuth auth.Auth, version string, parallelism int, squash bool) *sqle.Engine
• 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" +
		"By default when gitbase encounters an 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."
	TracerServiceName = "gitbase"
)

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

Functions

func NewDatabaseEngine

func NewDatabaseEngine(
	userAuth auth.Auth,
	version string,
	parallelism int,
	squash bool,
) *sqle.Engine

Types

type Server

type Server struct {
	Name          string         `long:"db" default:"gitbase" description:"Database name"`
	Version       string         // Version of the application.
	Directories   []string       `` /* 159-byte string literal not displayed */
	Depth         int            `long:"depth" default:"1000" description:"load repositories looking at less than <depth> nested subdirectories."`
	Host          string         `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"`
	UserFile      string         `short:"U" long:"user-file" env:"GITBASE_USER_FILE" default:"" description:"JSON file with credentials list"`
	ConnTimeout   int            `short:"t" long:"timeout" env:"GITBASE_CONNECTION_TIMEOUT" description:"Timeout in seconds used for connections"`
	IndexDir      string         `` /* 160-byte string literal not displayed */
	CacheSize     cache.FileSize `long:"cache" default:"512" description:"Object cache size in megabytes" env:"GITBASE_CACHESIZE_MB"`
	Parallelism   uint           `` /* 155-byte string literal not displayed */
	DisableSquash bool           `long:"no-squash" description:"Disables the table squashing."`
	TraceEnabled  bool           `long:"trace" env:"GITBASE_TRACE" description:"Enables jaeger tracing"`
	ReadOnly      bool           `` /* 173-byte string literal not displayed */
	SkipGitErrors bool           // SkipGitErrors disables failing when Git errors are found.
	DisableGit    bool           `long:"no-git" description:"disable the load of git standard repositories."`
	DisableSiva   bool           `long:"no-siva" description:"disable the load of siva files."`
	Verbose       bool           `short:"v" description:"Activates the verbose mode"`
	LogLevel      string         `` /* 159-byte string literal not displayed */
	// 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 of the cli binary
	Version string
	// Build of the cli binary
	Build 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.