Skip to content
FlyQL

Go Quickstart

Installation

Section titled “Installation”
Terminal window
go get github.com/iamtelescope/flyql/golang

Parse a Query

Section titled “Parse a Query”
package main


import (
  "fmt"
  flyql "github.com/iamtelescope/flyql/golang"
)


func main() {
  result, err := flyql.Parse("status=200 and active")
  if err != nil {
    panic(err)
  }
  fmt.Printf("Parsed: %+v\n", result.Root)
}

Parse returns a *ParseResult with a Root node representing the AST.

Generate SQL

Section titled “Generate SQL”

Use a generator to turn the AST into a parameterized WHERE clause. Each database dialect has its own generator with dialect-specific column types.

ClickHouse

Section titled “ClickHouse”
package main


import (
  "fmt"
  flyql "github.com/iamtelescope/flyql/golang"
  "github.com/iamtelescope/flyql/golang/generators/clickhouse"
)


func main() {
  result, err := flyql.Parse("status>=400 and host=prod*")
  if err != nil {
    panic(err)
  }


  columns := map[string]*clickhouse.Column{
    "status": clickhouse.NewColumn(clickhouse.ColumnDef{Name: "status", Type: "UInt32"}),
    "host":   clickhouse.NewColumn(clickhouse.ColumnDef{Name: "host", Type: "String"}),
  }


  sql, err := clickhouse.ToSQL(result.Root, columns)
  if err != nil {
    panic(err)
  }
  fmt.Println(sql)
}

PostgreSQL and StarRocks generators follow the same pattern — import from generators/postgresql or generators/starrocks instead.

Match In-Memory

Section titled “Match In-Memory”

Evaluate a query against a data record without generating SQL:

package main


import (
  "fmt"
  "github.com/iamtelescope/flyql/golang/matcher"
)


func main() {
  data := map[string]any{
    "status": 200,
    "active": true,
    "host":   "prod-api-01",
  }


  matches, err := matcher.Match("status=200 and active", data)
  if err != nil {
    panic(err)
  }
  fmt.Printf("Matches: %v\n", matches) // true
}

Parse Column Expressions

Section titled “Parse Column Expressions”

Parse a columns expression into structured data with segments, modifiers, and aliases. The second argument is a Capabilities struct that controls which features are enabled. Modifiers are disabled by default.

package main


import (
  "fmt"
  "github.com/iamtelescope/flyql/golang/columns"
)


func main() {
  // Parse basic columns (modifiers disabled by default)
  parsed, err := columns.Parse("message, status", columns.Capabilities{})
  if err != nil {
    panic(err)
  }
  for _, col := range parsed {
    fmt.Printf("%s (display: %q, segments: %v)\n", col.Name, col.DisplayName, col.Segments)
  }


  // Enable modifiers via capabilities
  caps := columns.Capabilities{Modifiers: true}
  withMods, err := columns.Parse("message|chars(25) as msg, status", caps)
  if err != nil {
    panic(err)
  }
  fmt.Println(withMods[0].Modifiers)


  // Or serialize directly to JSON for API responses
  jsonBytes, _ := columns.ParseToJSON("message, status|upper", caps)
  fmt.Println(string(jsonBytes))
}

What’s Next

Section titled “What’s Next”