cockroach: Index | Files

package parser

import ""


Package Files

help.go lexer.go parse.go scan.go


var AllHelp = func(h map[string]HelpMessageBody) string {

    cmds := make(map[string][]string)
    for c, details := range h {
        if details.Category == "" {
        cmds[details.Category] = append(cmds[details.Category], c)

    // Ensure the result is deterministic.
    var categories []string
    for c, l := range cmds {
        categories = append(categories, c)

    // Compile the final help index.
    var buf bytes.Buffer
    w := tabwriter.NewWriter(&buf, 0, 0, 1, ' ', 0)
    for _, cat := range categories {
        fmt.Fprintf(w, "%s:\n", strings.Title(cat))
        for _, item := range cmds[cat] {
            fmt.Fprintf(w, "\t\t%s\t%s\n", item, h[item].ShortDescription)
    _ = w.Flush()
    return buf.String()

AllHelp contains an overview of all statements with help messages. For example, displayed in the CLI shell with \h without additional parameters.

var HelpMessages = func(h map[string]HelpMessageBody) map[string]HelpMessageBody {
    appendSeeAlso := func(newItem, prevItems string) string {

        if prevItems != "" {
            return newItem + "\n  " + prevItems
        return newItem
    reformatSeeAlso := func(seeAlso string) string {
        return strings.Replace(
            strings.Replace(seeAlso, ", ", "\n  ", -1),
            "WEBDOCS", base.DocsURLBase, -1)
    srcMsg := h["<SOURCE>"]
    srcMsg.SeeAlso = reformatSeeAlso(strings.TrimSpace(srcMsg.SeeAlso))
    selectMsg := h["<SELECTCLAUSE>"]
    selectMsg.SeeAlso = reformatSeeAlso(strings.TrimSpace(selectMsg.SeeAlso))
    for k, m := range h {
        m = h[k]
        m.ShortDescription = strings.TrimSpace(m.ShortDescription)
        m.Text = strings.TrimSpace(m.Text)
        m.SeeAlso = strings.TrimSpace(m.SeeAlso)

        if strings.Contains(m.Text, "<source>") && k != "<SOURCE>" {
            m.Text = strings.TrimSpace(m.Text) + "\n\n" + strings.TrimSpace(srcMsg.Text)
            m.SeeAlso = appendSeeAlso(srcMsg.SeeAlso, m.SeeAlso)

        if strings.Contains(m.Text, "<selectclause>") && k != "<SELECTCLAUSE>" {
            m.Text = strings.TrimSpace(m.Text) + "\n\n" + strings.TrimSpace(selectMsg.Text)
            m.SeeAlso = appendSeeAlso(selectMsg.SeeAlso, m.SeeAlso)

        if strings.Contains(m.Text, "<tablename>") {
            m.SeeAlso = appendSeeAlso("SHOW TABLES", m.SeeAlso)
        m.SeeAlso = reformatSeeAlso(m.SeeAlso)
        h[k] = m
    return h

HelpMessages is the registry of all help messages, keyed by the top-level statement that they document. The key is intended for use via the \h client-side command.

func EndsInSemicolon Uses

func EndsInSemicolon(sql string) bool

EndsInSemicolon returns true if the last lexical token is a semicolon.

func LastLexicalToken Uses

func LastLexicalToken(sql string) (lastTok int, ok bool)

LastLexicalToken returns the last lexical token. If the string has no lexical tokens, returns 0 and ok=false.

func Parse Uses

func Parse(sql string) (stmts tree.StatementList, sqlStrings []string, _ error)

Parse parses a sql statement string and returns a list of Statements.

func ParseExpr Uses

func ParseExpr(sql string) (tree.Expr, error)

ParseExpr is a short-hand for parseExprs([]string{sql})

func ParseExprs Uses

func ParseExprs(sql []string) (tree.Exprs, error)

ParseExprs is a short-hand for parseExprs(sql)

func ParseOne Uses

func ParseOne(sql string) (tree.Statement, error)

ParseOne parses a sql statement string, ensuring that it contains only a single statement, and returns that Statement. ParseOne will always interpret the INT and SERIAL types as 64-bit types, since this is used in various internal-execution paths where we might receive bits of SQL from other nodes. In general, we expect that all user-generated SQL has been run through the ParseWithInt() function.

func ParseTableName Uses

func ParseTableName(sql string) (*tree.TableName, error)

ParseTableName parses a table name.

func ParseTableNameWithIndex Uses

func ParseTableNameWithIndex(sql string) (tree.TableNameWithIndex, error)

ParseTableNameWithIndex parses a table name with index.

func ParseType Uses

func ParseType(sql string) (coltypes.CastTargetType, error)

ParseType parses a column type.

func SplitFirstStatement Uses

func SplitFirstStatement(sql string) (pos int, ok bool)

SplitFirstStatement returns the length of the prefix of the string up to and including the first semicolon that separates statements. If there is no semicolon, returns ok=false.

type HelpMessage Uses

type HelpMessage struct {
    // Command is set if the message is about a statement.
    Command string
    // Function is set if the message is about a built-in function.
    Function string

    // HelpMessageBody contains the details of the message.

HelpMessage describes a contextual help message.

func (*HelpMessage) Format Uses

func (h *HelpMessage) Format(w io.Writer)

Format prints out details about the message onto the specified output stream.

func (*HelpMessage) String Uses

func (h *HelpMessage) String() string

String implements the fmt.String interface.

type HelpMessageBody Uses

type HelpMessageBody struct {
    Category         string
    ShortDescription string
    Text             string
    SeeAlso          string

HelpMessageBody defines the body of a help text. The messages are structured to facilitate future help navigation functionality.

type Parser Uses

type Parser struct {
    // contains filtered or unexported fields

Parser wraps a scanner, parser and other utilities present in the parser package.

func (*Parser) Parse Uses

func (p *Parser) Parse(sql string) (stmts tree.StatementList, sqlStrings []string, _ error)

Parse parses the sql and returns a list of statements.

func (*Parser) ParseWithInt Uses

func (p *Parser) ParseWithInt(
    sql string, nakedIntType *coltypes.TInt,
) (stmts tree.StatementList, sqlStrings []string, _ error)

ParseWithInt parses a sql statement string and returns a list of Statements. The INT token will result in the specified TInt type.

Package parser imports 17 packages (graph) and is imported by 40 packages. Updated 2018-12-14. Refresh now. Tools for package owners.