Merge pull request #345 from erizocosmico/feature/squash-default

cmd/gitbase: make squash rule active by default

Author: ajnavarro

cmd/gitbase/command/server.go

@@ -22,30 +22,23 @@ import (
 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, disabled by default. It can be enabled\n" +
-		"using a not empty value at GITBASE_UNSTABLE_SQUASH_ENABLE env variable.\n\n" +
-		"By default when gitbase encounters an error in a repository it\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."
 )
 
 // Server represents the `server` command of gitbase cli tool.
 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. Accepts globs."`
-	Siva      []string `long:"siva" description:"Path where the siva repositories are located, multiple directories can be defined. Accepts globs."`
-	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"`
-	PilosaURL string   `long:"pilosa" default:"http://localhost:10101" description:"URL to your pilosa server" env:"PILOSA_ENDPOINT"`
-	IndexDir  string   `short:"i" long:"index" default:"/var/lib/gitbase/index" description:"Directory where the gitbase indexes information will be persisted." env:"GITBASE_INDEX_DIR"`
-
-	// 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
+	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. Accepts globs."`
+	Siva          []string `long:"siva" description:"Path where the siva repositories are located, multiple directories can be defined. Accepts globs."`
+	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"`
+	PilosaURL     string   `long:"pilosa" default:"http://localhost:10101" description:"URL to your pilosa server" env:"PILOSA_ENDPOINT"`
+	IndexDir      string   `short:"i" long:"index" default:"/var/lib/gitbase/index" description:"Directory where the gitbase indexes information will be persisted." env:"GITBASE_INDEX_DIR"`
+	DisableSquash bool     `long:"no-squash" description:"Disables the table squashing."`
 	// 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.
@@ -114,14 +107,16 @@ func (c *Server) buildDatabase() error {
 		return err
 	}
 
-	if c.UnstableSquash {
-		logrus.Warn("unstable squash tables rule is enabled")
+	if !c.DisableSquash {
+		logrus.Info("squash tables rule is enabled")
 		a := analyzer.NewBuilder(c.engine.Catalog).
 			AddPostAnalyzeRule(rule.SquashJoinsRule, rule.SquashJoins).
 			Build()
 
 		a.CurrentDatabase = c.engine.Analyzer.CurrentDatabase
 		c.engine.Analyzer = a
+	} else {
+		logrus.Warn("squash tables rule is disabled")
 	}
 
 	return c.engine.Init()

cmd/gitbase/main.go

@@ -6,6 +6,7 @@ import (
 	"github.com/src-d/gitbase/cmd/gitbase/command"
 
 	"github.com/jessevdk/go-flags"
+	"github.com/sirupsen/logrus"
 )
 
 const (
@@ -15,18 +16,23 @@ const (
 func main() {
 	parser := flags.NewNamedParser(name, flags.Default)
 
-	parser.AddCommand("server", command.ServerDescription, command.ServerHelp,
+	_, err := parser.AddCommand("server", command.ServerDescription, command.ServerHelp,
 		&command.Server{
-			UnstableSquash: os.Getenv("GITBASE_UNSTABLE_SQUASH_ENABLE") != "",
-			SkipGitErrors:  os.Getenv("GITBASE_SKIP_GIT_ERRORS") != "",
+			SkipGitErrors: os.Getenv("GITBASE_SKIP_GIT_ERRORS") != "",
 		})
+	if err != nil {
+		logrus.Fatal(err)
+	}
 
-	parser.AddCommand("version", command.VersionDescription, command.VersionHelp,
+	_, err = parser.AddCommand("version", command.VersionDescription, command.VersionHelp,
 		&command.Version{
 			Name: name,
 		})
+	if err != nil {
+		logrus.Fatal(err)
+	}
 
-	_, err := parser.Parse()
+	_, err = parser.Parse()
 	if err != nil {
 		if e, ok := err.(*flags.Error); ok && e.Type == flags.ErrCommandRequired {
 			parser.WriteHelp(os.Stdout)

docs/using-gitbase/configuration.md

@@ -8,7 +8,6 @@
 | `PILOSA_ENDPOINT`                | pilosa endpoint, default "http://localhost:10101"   |
 | `GITBASE_BLOBS_MAX_SIZE`         | maximum blob size to return in MiB, default 5 MiB   |
 | `GITBASE_BLOBS_ALLOW_BINARY`     | enable retrieval of binary blobs, default `false`   |
-| `GITBASE_UNSTABLE_SQUASH_ENABLE` | enable join squash rule to improve query performance **experimental**. This optimization collects inner joins between tables with a set of supported conditions and converts them into a single node that retrieves the data in chained steps (getting first the commits and then the blobs of every commit instead of joining all commits and all blobs, for example).|
 | `GITBASE_SKIP_GIT_ERRORS`        | do not stop queries on git errors, default disabled |
 
 ## Command line arguments
@@ -34,10 +33,6 @@ Usage:
 
 Starts a gitbase server instance
 
-The squashing tables and pushing down join conditions is still a
-work in progress and unstable, disable by default. It can be enabled
-using a not empty value at GITBASE_UNSTABLE_SQUASH_ENABLE env variable.
-
 By default when gitbase encounters an error in a repository it
 stops the query. With GITBASE_SKIP_GIT_ERRORS variable it won't
 complain and just skip those rows or repositories.
@@ -55,4 +50,5 @@ Help Options:
       -P, --password= Password used for connection
           --pilosa=   URL to your pilosa server (default: http://localhost:10101)
       -i, --index=    Directory where the gitbase indexes information will be persisted. (default: /var/lib/gitbase/index)
+          --no-squash Disables the table squashing.
 ```