go-open-soql-parser

Open source implementation of the SOQL parser for Go.

---

🧭 Examples

• Live demo
• SOQL query visualizer

🚀 Getting started

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "github.com/shellyln/go-open-soql-parser/soql/parser"
)

func main() {
    src := `
    SELECT Id FROM Contact WHERE Name like 'a%'
    `

    ret, err := parser.Parse(src)
    if err != nil {
        fmt.Println(err)
    }

    jsonStr, err := json.Marshal(ret)
    if err != nil {
        println(err)
    }

    var buf bytes.Buffer
    json.Indent(&buf, jsonStr, "", "  ")

    fmt.Println(buf.String())
}

🚧 TODO

• Unit tests
• GROUP BY ROLLUP and GROUP BY CUBE clause, GROUPING() function
• WITH clause
• USING SCOPE clause
• Formula in fieldExpression at conditionExpression (where / having)
• Polymorphic Fields
• "null Values in Lookup Relationships and Outer Joins" - If an object has a conditional expression whose right hand side is null, it is not a condition for inner join.
  • cf. "Using Relationship Queries" - If the condition is complete within the parent object (no "or" across relationships), it is inner joined.

🔗 Related projects

• GraphDT - Datatable
• go-open-soql-visualizer - Visualizer
• Open SOQL (JavaScript) - JavaScript implementation

🙋 FAQ

• What does SOQL stand for?
  • 👉 In Open SOQL, SOQL stands for SOQL is Object Query Language.
  • 👉 In original SOQL, SOQL stands for Salesforce Object Query Language.

⚖️ License

MIT
Copyright (c) 2023 Shellyl_N and Authors.