pganalyze/libpg_query 13-2.0.0

on GitHub

• Update to PostgreSQL 13 parser (13.2 release)
• Changes to JSON output format
  • WARNING: These JSON format changes are incompatible with prior releases.
  • New top-level result object that contains the Postgres version number the
    parser is based on
  • Node type names are only output when the field is a generic field (Node*),
    but not when the field always has the same type. This matches how the
    Postgres source looks like, and ensures the JSON and (new) Protobuf format
    match in their structure. You can utilize the srcdata/struct_defs.json
    file as needed to get the necessary context on field types.
  • Whitespace between control characters in JSON is no longer added
  • "<" and ">" characters are escaped to avoid browser HTML injections
  • Enum values are output with the value's name, instead of the integer value
• Introduce new Protobuf parse tree output format
  • Up until now, this library relied on JSON to pass the parse result back
    to the caller, which has a number of downsides, most importantly that
    we don't have a readily available parser for JSON thats not tied to a
    running Postgres server. That in turn makes it hard to provide
    cross-language features such as deparsing directly in this library
    (which would require reading back a parse tree that gets passed in).
  • Protobuf isn't perfect, but its straightforward enough to generate the
    schema definitions for the parse tree nodes, and output the tree using
    a bundled C protobuf library, which has a small enough SLOC count (~3k)
    to not be noticeable in the big picture.
• Add support for returning Postgres scanner result
  • This allows utilizing pg_query for use cases that need the raw token
    information, instead of a parse tree. Due to additional modifications
    to the Postgres source, this also contains information about comments
    in the query string, and their location.
• Add deparsing functionality that turns parse tree back into a SQL query
  • This is based on the deparser that was written over multiple years for
    the pg_query Ruby library, and is now accessible for all bindings through
    this new API and implementation.
• Fingerprinting: Introduce v3 version and 64-bit XXH3 hash
  • See full details in the wiki page here: https://github.com/lfittl/libpg_query/wiki/Fingerprinting#version-30-based-on-postgresql-13
• Add new pg_query_split_with_scanner/pg_query_split_with_parser functions to
  split up multi-statement strings
  • Naively one could assume that splitting a string by ";" is sufficient,
    but it becomes tricky once one takes into consideration that this
    character can also show up in identifier, constants or comments.
  • We provide both a parser-based split function and a scanner-based split
    function. Most importantly when splitting statements in a file that may
    contain syntax errors that cause a parser error, but are accepted by the
    scanner. Otherwise the parser-based split function is recommended
    due to better accuracy.
• Add experimental Protobuf C++ outfuncs, converge JSON output to match Protobuf
  mapped output
• Extract source with USE_ASSERT_CHECKING enabled
  • This ensures we have the necessary functions to compile an
    assert-enabled build if necessary. Note that this doesn't mean that
    asserts are enabled by default (they are not, you need to explicitly
    use DEBUG=1).
• Ensure codebase has a clean Valgrind run
• PL/pgSQL: Output NEW/OLD variable numbers, record dno fields Ethan Resnick
• Makefile: Allow passing in customized CFLAGS/PG_CONFIGURE_FLAGS/TEST_* Ethan Resnick

$ shasum -a 256 libpg_query-13-2.0.0.*

e5e6514b1ae0e1ab19a2441de3088988bf1b89778164f9c725c3d85c6903133e  libpg_query-13-2.0.0.tar.gz
066680c284bd82c2922562efc57bfbf848708785abd4d87798f0ceca72942888  libpg_query-13-2.0.0.zip