Module parsesql

The parsesql module implements a high performance SQL file parser. It parses PostgreSQL syntax and the SQL ANSI standard.

Imports

hashes, strutils, lexbase, streams

Types

SqlLexer = object of BaseLexer
  filename: string

the parser object.

SqlNodeKind = enum
  nkNone, nkIdent, nkQuotedIdent, nkStringLit, nkBitStringLit, nkHexStringLit,
  nkIntegerLit, nkNumericLit, nkPrimaryKey, nkForeignKey, nkNotNull, nkNull,
  nkStmtList, nkDot, nkDotDot, nkPrefix, nkInfix, nkCall, nkPrGroup, nkColumnReference,
  nkReferences, nkDefault, nkCheck, nkConstraint, nkUnique, nkIdentity, nkColumnDef, ## name, datatype, constraints
  nkInsert, nkUpdate, nkDelete, nkSelect, nkSelectDistinct, nkSelectColumns,
  nkSelectPair, nkAsgn, nkFrom, nkFromItemPair, nkGroup, nkLimit, nkHaving, nkOrder,
  nkJoin, nkDesc, nkUnion, nkIntersect, nkExcept, nkColumnList, nkValueList, nkWhere,
  nkCreateTable, nkCreateTableIfNotExists, nkCreateType, nkCreateTypeIfNotExists,
  nkCreateIndex, nkCreateIndexIfNotExists, nkEnumDef

kind of SQL abstract syntax tree

SqlParseError = object of ValueError

Invalid SQL encountered

SqlNode = ref SqlNodeObj

an SQL abstract syntax tree node

SqlNodeObj = object
  case kind*: SqlNodeKind       ## kind of syntax tree
  of LiteralNodes:
      strVal*: string          ## AST leaf: the identifier, numeric literal
                    ## string literal, etc.
    
  else:
      sons*: seq[SqlNode]      ## the node's children

an SQL abstract syntax tree node

SqlParser = object of SqlLexer
  tok: Token

SQL parser object

Procs

proc newNode(k: SqlNodeKind): SqlNode {...}{.raises: [], tags: [].}

proc newNode(k: SqlNodeKind; s: string): SqlNode {...}{.raises: [], tags: [].}

proc newNode(k: SqlNodeKind; sons: seq[SqlNode]): SqlNode {...}{.raises: [], tags: [].}

proc len(n: SqlNode): int {...}{.raises: [], tags: [].}

proc `[]`(n: SqlNode; i: int): SqlNode {...}{.raises: [], tags: [].}

proc add(father, n: SqlNode) {...}{.raises: [], tags: [].}

proc renderSQL(n: SqlNode; upperCase = false): string {...}{.raises: [Exception],
    tags: [RootEffect].}

Converts an SQL abstract syntax tree to its string representation.

proc `$`(n: SqlNode): string {...}{.raises: [Exception], tags: [RootEffect].}

an alias for renderSQL.

proc parseSQL(input: Stream; filename: string): SqlNode {...}{.
    raises: [Exception, Exception, ValueError, SqlParseError],
    tags: [ReadIOEffect, RootEffect].}

parses the SQL from input into an AST and returns the AST. filename is only used for error messages. Syntax errors raise an SqlParseError exception.

proc parseSQL(input: string; filename = ""): SqlNode {...}{.
    raises: [Exception, ValueError, SqlParseError], tags: [ReadIOEffect, RootEffect].}

parses the SQL from input into an AST and returns the AST. filename is only used for error messages. Syntax errors raise an SqlParseError exception.