Polyglot SQL API Documentation - v0.2.0
    Preparing search index...

    Function plan

    • Build an execution plan from a SQL query.

      Parameters

      • sql: string

        SQL string to plan

      • dialect: string = 'generic'

        Dialect for parsing (default: 'generic')

      Returns PlanResult

      const result = plan("SELECT x, SUM(y) FROM t GROUP BY x");
      // result.plan.root.kind === "aggregate"
      // result.plan.leaves[0].kind === "scan"