Parser Configuration

Supported by ✅ Open Source Edition   ✅ Express Edition   ✅ Professional Edition   ✅ Enterprise Edition

The SQL Parser API ships with a variety of settings that govern its behaviour. These settings include:

• parseAppendMissingTableReferences: Support Teradata style implicit joins when projected table references aren't listed explicitly in FROM clause.
• parseDateFormat: The date format that is applied automatically when parsing date formatting functions without an explicit format.
• parseDialect: The parser input dialect. This dialect is used to decide what vendor specific grammar should be applied in case of ambiguities that cannot be resolved from the context.
• parseIgnoreComments: Using this flag, the parser can ignore certain sections that would otherwise be executed by RDBMS. Everything between an parseIgnoreCommentStart and the parseIgnoreCommentStop token will be ignored.
• parseIgnoreCommentStart: The token that delimits the beginning of a section to be ignored by jOOQ. Ideally, this token is placed inside of a SQL comment.
• parseIgnoreCommentStop: The token that delimits the end of a section to be ignored by jOOQ. Ideally, this token is placed inside of a SQL comment.
• parseIgnoreCommercialOnlyFeatures: Ignore commercial only features when parsing, to avoid unnecessary exceptions.
• parseMetaDefaultExpressions: Specify whether org.jooq.Meta implementations should attempt to parse DEFAULT expressions, or leave them as raw SQL strings.
• parseNameCase: Specify the name case behaviour, depending on whether names are quoted or not.
• parseNamedParamPrefix: The prefix used for named parameters, defaulting to :, e.g. for :param style names.
• parseRetainCommentsBetweenQueries: Whether comments in between statements from Parser.parse() are retained and parsed as ignored queries. Comments inside of statements (including procedural statements) currently aren't supported by jOOQ.
• parseSearchPath: The search path to look up unqualified identifiers to be used when using parseWithMetaLookups. Most dialects support a single schema on their search path (the CURRENT_SCHEMA). PostgreSQL supports a 'search_path', which allows for listing multiple schemata to use to look up unqualified tables, procedures, etc. in.
• parseSetCommands: Whether SET commands should be parsed or ignored.
• parseTimestampFormat: The timestamp format that is applied automatically when parsing timestamp formatting functions without an explicit format.
• parseUnsupportedSyntax: The parser can parse some syntax that jOOQ does not support. By default, such syntax is ignored. Use this flag if you want to fail in such cases.
• parseUnknownFunctions: The parser only parses "known" (to jOOQ) built in functions, and fails otherwise. This flag allows for parsing any built in function using a standard func_name(arg1, arg2, ...) syntax.
• parseWithMetaLookups: Whether org.jooq.Meta should be used to look up meta information such as schemas, tables, columns, column types, etc.

An example of using the parseIgnoreComments feature:

Example configuration

In addition to the above settings, there is also a powerful parser listener SPI called the org.jooq.ParseListener.