- All Implemented Interfaces:
Serializable,Cloneable,XMLAppendable
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Booleanprotected Booleanprotected BackslashEscapingprotected Integerprotected Booleanprotected Booleanprotected Booleanprotected Integerprotected Booleanprotected Booleanprotected Booleanprotected Stringprotected NestedCollectionEmulationprotected Booleanprotected ExecuteWithoutWhereprotected InvocationOrderprotected InvocationOrderprotected Booleanprotected ExecuteWithoutWhereprotected Booleanprotected Booleanprotected FetchIntermediateResultprotected Integerprotected Integerprotected Booleanprotected Booleanprotected Booleanprotected Integerprotected Integerprotected Booleanprotected Booleanprotected Booleanprotected SQLDialectprotected Localeprotected InterpreterNameLookupCaseSensitivityprotected List<InterpreterSearchSchema>protected Localeprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Integerprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected InvocationOrderprotected InvocationOrderprotected Booleanprotected List<MigrationSchema>protected Stringprotected ParamCastModeprotected ParamTypeprotected Transformationprotected Stringprotected SQLDialectprotected Booleanprotected Stringprotected Stringprotected Booleanprotected Localeprotected Booleanprotected ParseNameCaseprotected Stringprotected Booleanprotected List<ParseSearchSchema>protected Booleanprotected Stringprotected ParseUnknownFunctionsprotected ParseUnsupportedSyntaxprotected ParseWithMetaLookupsprotected QueryPoolableprotected Integerprotected WriteIfReadonlyprotected WriteIfReadonlyprotected WriteIfReadonlyprotected WriteIfReadonlyprotected InvocationOrderprotected InvocationOrderprotected Booleanprotected Booleanprotected Booleanprotected RenderDefaultNullabilityprotected Booleanprotected RenderFormattingprotected Booleanprotected RenderImplicitJoinTypeprotected RenderImplicitWindowRangeprotected RenderKeywordCaseprotected RenderKeywordStyleprotected Localeprotected RenderMappingprotected RenderNameCaseprotected Stringprotected RenderNameStyleprotected RenderOptionalKeywordprotected RenderOptionalKeywordprotected RenderOptionalKeywordprotected RenderOptionalKeywordprotected RenderOptionalKeywordprotected Booleanprotected Booleanprotected Booleanprotected RenderQuotedNamesprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected StatementTypeprotected ThrowExceptionsprotected InvocationOrderprotected InvocationOrderprotected Booleanprotected Transformationprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Transformationprotected Transformationprotected Booleanprotected TransformUnneededArithmeticExpressionsprotected Booleanprotected Booleanprotected Booleanprotected UpdateUnchangedRecordsprotected InvocationOrderprotected InvocationOrder -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidappendTo(XMLBuilder builder) clone()booleanWhether string literals should be escaped with backslash.A property specifying a batch size that should be applied to all automatically createdBatchedConnectioninstances.The default implementation of the ParsingConnection cache's LRU cache size.[#5826] The delimiter character to be used to delimit statements in batches.[#3884] HowMULTISETsupport should be emulated.[#6771] Specifies whether DELETE statements are allowed to be executed lacking a WHERE clause.The order of invocation for [action]end() methods registeredExecuteListeners.The order of invocation for [action]start() methods registeredExecuteListeners.[#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause.Whether to fetch data into intermediateResultinstances.Whether server output should be fetched after each query execution.The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified.The maximum number of allowed bind variables before inlining all values where0uses the dialect defaults:SQLDialect.ACCESS: 768SQLDialect.ASE: 2000SQLDialect.INGRES: 1024SQLDialect.ORACLE: 32767SQLDialect.POSTGRES: 32767SQLDialect.SQLITE: 999SQLDialect.SQLSERVER: 2100[#7095] The base to use to calculate the powers of when applying in list padding.[#7337] The dialect that should be used to interpret SQL DDL statements.The Locale to be used with any interpreter locale dependent logic, defaulting togetLocale().[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements.The Locale to be used with any locale dependent logic if there is not a more specific locale available.The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified.The order of invocation for [action]end() methods registeredMigrationListeners.The order of invocation for [action]start() methods registeredMigrationListeners.The character(s) to be used as a separator in paths encoded in aNameWhether rendered bind values should be cast to their respective type.Specify how bind variables are to be rendered.Transform the parsed SQL to append missing table references to the query'sFROMorUSINGclause, if applicable.The date format to use when parsing functions whose behaviour depends on some session date format, such as NLS_DATE_FORMAT in Oracle[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.[#8325] The ignore comment start token[#8325] The ignore comment stop tokenThe Locale to be used with any parser locale dependent logic, defaulting togetLocale().[#7337] The default name case for parsed identifiers.The prefix to use for named parameters in parsed SQL.The timestamp format to use when parsing functions whose behaviour depends on some session date format, such as NLS_TIMESTAMP_FORMAT in Oracle[#7344] Whether the parser should accept unknown functions.[#5917] Whether the parser should accept unsupported (but known) syntax.[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider.The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified.The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified.[#9864] The behaviour when trying to insert into readonly columns usingTableRecord.insert().[#9864] The behaviour when trying to update a readonly column usingUpdatableRecord.update().The order of invocation for [action]end() methods registeredRecordListeners.The order of invocation for [action]start() methods registeredRecordListeners.Whether theNullability.DEFAULTnullablity should be rendered in generated DDL, and how it should be rendered.All sorts of formatting flags / settings.The join type to be generated by implicit joins.Whether to render an explicit windowRANGEclause when an implicit clause is applied.Whether the case ofKeywordreferences should be modified in any way.Deprecated.The Locale to be used with any render locale dependent logic (as e.g.Configure render mapping for runtime schema / table rewriting in generated SQL.Whether the case ofNamereferences should be modified in any way.The prefix to use for named parameters in generated SQL.Deprecated.- 3.12.0 - [#5909] - UseRenderQuotedNamesandRenderNameCaseinstead.Whether to render the optionalASkeyword in table aliases, if it is optional in the output dialect.Whether to render the optionalASkeyword in table aliases, if it is optional in the output dialect.Whether to render optional parentheses to make associativity explicit, e.g.Whether to render the optionalINNERkeyword inINNER JOIN, if it is optional in the output dialect.Whether to render the optionalOUTERkeyword inOUTER JOIN, if it is optional in the output dialect.Whether rendered schema, table, column names, etc should be quoted.The type of statement that is to be executed.A strategy defining how exceptions from the database / JDBC driver should be propagatedThe order of invocation for [action]end() methods registeredTransactionListeners.The order of invocation for [action]start() methods registeredTransactionListeners.Transform a subquery from an IN condition with LIMIT to an equivalent derived table.Transform theQUALIFYclause to an equivalent derived table to filter on window functions.TransformROWNUMexpressions to correspondingLIMITclauses orROW_NUMBER()expressions.Transform arithmetic expressions on literals and bind variables.WhetherUpdatableRecord.update()calls should be executed if the record is unchanged.The order of invocation for [action]end() methods registeredVisitListeners.The order of invocation for [action]start() methods registeredVisitListeners.inthashCode()[#7963] Apply workaround for ORA-04043 when inserting into Oracle tables with qualified, quoted identifiers, and fetching generated keysWhether fetched records should be attached to the fetching configuration.Whether thejava.time(JSR 310) typeOffsetDateTimeshould be bound natively to JDBC.Whether thejava.time(JSR 310) typeOffsetTimeshould be bound natively to JDBC.Whether parsing connection translations should be cached in the configuration.Whether JDBCPreparedStatementinstances should be cached in loader API.Whether record mappers should be cached in the configuration.[#5570] Whether exception stack traces should be enhanced with additional debug information.[#6462] Use only the primary key to emulate MySQL's INSERT ..When set to true, this will add jOOQ's default logging ExecuteListeners.Whether store() and delete() methods should be executed with optimistic locking.Whether store() and delete() methods should be executed with optimistic locking also on "unversioned" tables, i.e.Fetch trigger values after SQL ServerOUTPUTclause.Whether warnings should be fetched after each query execution.Historically, zero-scale decimal types are generated as their most appropriate, corresponding integer type (e.g.[#5600] Whether IN lists in IN predicates should be padded to powers of inListPadBase (default 2).WhetherTableRecord.insert()calls should be executed if the record is unchanged.Using this flag, the interpreter will be able to delay the addition of foreign key declarations until the end of the interpretation run.Whether constructor parameter names obtained via reflection in Java 8+ should be considered by the DefaultRecordMapper.Whether constructor parameter names obtained via reflection in Kotlin should be considered by the DefaultRecordMapper.Whether constructor parameter names obtained from theConstructorPropertiesannotation should be considered by the DefaultRecordMapper.Whether JPA annotations should be considered by the DefaultRecordMapper.Whether constructor parameter names obtained from theRecordcomponent names should be considered by the DefaultRecordMapper.TheMetaimplementation that is backed byDatabaseMetaDatadoes not produce system generated indexes on constraints, by default.TheMetaimplementation that is backed byDatabaseMetaDatadoes not produce system generated sequences, by default.Whether migrations are allowed to be executed in inverse order.Whether to automatically existing schemas that are not yet managed by jOOQ Migrations.Whether a migration automatically runs a validation first.VariousmigrateTo()methods (e.g.Whether migrations revert any untracked changes in the schemas that are being migrated.[#8325] Whether the parser should ignore content between ignore comment tokens.[#13109] Whether the parser of the jOOQ Open Source Edition should ignore commercial only features, rather than failing.[#8469] Whether to parse default expressions retrieved fromDatabaseMetaData.[#12538] Whether the parser should retain comments and whitespace between queries when parsing multiple queries throughParser.parse(String).[#9780] Whether commands of the typeSET key = valueshould be parsed rather than ignored.Whether reflection information should be cached in the configuration.Whether any catalog name should be rendered at all.Whether stored function calls should be wrapped in scalar subqueries.Whether rendered SQL should be pretty-printed.Whether the jOOQGROUP_CONCATfunction should be overflow-protected by setting the@@group_concat_max_lensession variable in MySQL style database systems.Whether an additionalORDER BY rnclause should be rendered on emulated paginated queries.Whether the jOOQRETURNINGclause should map to SQL Server'sOUTPUTclause.Whether queries combined with set operators (e.g.Whether stored function calls should be wrapped in scalar subqueries.Whether any schema name should be rendered at all.Whether calls to store(), insert() and update() should return all columns, not just identity columns.Whether calls to store(), insert() and update() should return the identity column.Whether calls to store(), insert(), update(), and delete() that are called on an UpdatableRecord that is created from a POJO (e.g.Transform ANSI join to table lists if possible.TransformQOM.CompareConditionand a few other types of condition to inline their bind values, in case they matchTransform various syntax patterns to better versions, if possible.Transformx != c1 AND x != c2tox NOT IN (c1, c2).Transform1 / y * xtox / y, and other transformations.Transform~(bitnand(x, y))tobitand(x, y)and~(bitand(x, y)tobitnand(x, y).Transform~(bitnor(x, y))tobitor(x, y)and~(bitor(x, y)tobitnor(x, y).Transform~(~(x))tox.Transform~(bitxnor(x, y))tobitxor(x, y)and~(bitxor(x, y)tobitxnor(x, y).Transform empty scalar subqueries like(SELECT 1 WHERE FALSE)toNULL.Transform(EXP(x) - EXP(-x)) / 2toSINH(x), and other transformations.Transform all repetitions of idempotent functions, such asUPPER(UPPER(s))toUPPER(s).TransformLN(x + SQRT(SQUARE(x) + 1))toASINH(x), and other transformations.TransformLN(value) / LN(base)toLOG(base, value), and other transformations.Activate debug logging of thetransformPatternsfeature.Transformx >= a AND x <= atox = a.Transformx BETWEEN a AND b OR x BETWEEN b AND atox BETWEEN SYMMETRIC a AND b.Transformx IN (a, b, c) AND x IN (b, c, d)tox IN (b, c).Transformx = a OR x > atox >= a.Transformx >= a AND x <= btox BETWEEN a AND b.Transform-(-(x))toxTransform(a + b) + (c + d)to((a + b) + c) + d.Transform1 = atoa = 1.Transformx IN (a)tox = aandx NOT IN (a)tox != a.TransformNOT (a != b)toa = b, and similar comparisons.TransformNOT(NOT(x))tox.TransformNOT (a IS NOT DISTINCT FROM b)toa IS DISTINCT FROM b.Transformx = c1 OR x = c2tox IN (c1, c2).Transform predicates comparing scalar subqueries with a count(SELECT COUNT(*) …) > 0to equivalentEXISTS (SELECT 1 …).Transform predicates comparing scalar subqueries with a count(SELECT COUNT(expr) …) > 0to equivalentEXISTS (SELECT 1 … WHERE expr IS NOT NULL).TransformSIN(x) / COS(x)toTAN(x), and other transformations.TransformLTRIM(RTRIM(x))orRTRIM(LTRIM(x))toTRIM(x).Transform trivial case abbreviations likeNVL(NULL, a)toa.Transform trivial predicates like1 = 1toTRUE.Transform table lists to ANSI join if possible.Whether primary key values are deemed to be "updatable" in jOOQ.Whether store(), insert(), and update() methods should update the record timestamp prior to the operation, for use withexecuteWithOptimisticLocking.Whether store(), insert(), and update() methods should update the record version prior to the operation, for use withexecuteWithOptimisticLocking.voidsetApplyWorkaroundFor7962(Boolean value) Sets the value of the applyWorkaroundFor7962 property.voidsetAttachRecords(Boolean value) Sets the value of the attachRecords property.voidWhether string literals should be escaped with backslash.voidsetBatchSize(Integer value) A property specifying a batch size that should be applied to all automatically createdBatchedConnectioninstances.voidsetBindOffsetDateTimeType(Boolean value) Sets the value of the bindOffsetDateTimeType property.voidsetBindOffsetTimeType(Boolean value) Sets the value of the bindOffsetTimeType property.voidsetCacheParsingConnection(Boolean value) Sets the value of the cacheParsingConnection property.voidThe default implementation of the ParsingConnection cache's LRU cache size.voidSets the value of the cachePreparedStatementInLoader property.voidsetCacheRecordMappers(Boolean value) Sets the value of the cacheRecordMappers property.voidsetDebugInfoOnStackTrace(Boolean value) Sets the value of the debugInfoOnStackTrace property.voidsetDelimiter(String value) [#5826] The delimiter character to be used to delimit statements in batches.void[#3884] HowMULTISETsupport should be emulated.voidSets the value of the emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly property.void[#6771] Specifies whether DELETE statements are allowed to be executed lacking a WHERE clause.voidThe order of invocation for [action]end() methods registeredExecuteListeners.voidThe order of invocation for [action]start() methods registeredExecuteListeners.voidsetExecuteLogging(Boolean value) Sets the value of the executeLogging property.void[#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause.voidSets the value of the executeWithOptimisticLocking property.voidSets the value of the executeWithOptimisticLockingExcludeUnversioned property.voidWhether to fetch data into intermediateResultinstances.voidsetFetchServerOutputSize(Integer value) Whether server output should be fetched after each query execution.voidsetFetchSize(Integer value) The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified.voidSets the value of the fetchTriggerValuesAfterSQLServerOutput property.voidsetFetchWarnings(Boolean value) Sets the value of the fetchWarnings property.voidSets the value of the forceIntegerTypesOnZeroScaleDecimals property.voidsetInlineThreshold(Integer value) The maximum number of allowed bind variables before inlining all values where0uses the dialect defaults:SQLDialect.ACCESS: 768SQLDialect.ASE: 2000SQLDialect.INGRES: 1024SQLDialect.ORACLE: 32767SQLDialect.POSTGRES: 32767SQLDialect.SQLITE: 999SQLDialect.SQLSERVER: 2100voidsetInListPadBase(Integer value) [#7095] The base to use to calculate the powers of when applying in list padding.voidsetInListPadding(Boolean value) Sets the value of the inListPadding property.voidsetInsertUnchangedRecords(Boolean value) Sets the value of the insertUnchangedRecords property.voidSets the value of the interpreterDelayForeignKeyDeclarations property.voidsetInterpreterDialect(SQLDialect value) [#7337] The dialect that should be used to interpret SQL DDL statements.voidsetInterpreterLocale(Locale value) The Locale to be used with any interpreter locale dependent logic, defaulting togetLocale().void[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements.voidsetInterpreterSearchPath(List<InterpreterSearchSchema> interpreterSearchPath) voidThe Locale to be used with any locale dependent logic if there is not a more specific locale available.voidSets the value of the mapConstructorParameterNames property.voidSets the value of the mapConstructorParameterNamesInKotlin property.voidSets the value of the mapConstructorPropertiesParameterNames property.voidsetMapJPAAnnotations(Boolean value) Sets the value of the mapJPAAnnotations property.voidSets the value of the mapRecordComponentParameterNames property.voidsetMaxRows(Integer value) The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified.voidSets the value of the metaIncludeSystemIndexes property.voidSets the value of the metaIncludeSystemSequences property.voidsetMigrationAllowsUndo(Boolean value) Sets the value of the migrationAllowsUndo property.voidsetMigrationAutoBaseline(Boolean value) Sets the value of the migrationAutoBaseline property.voidSets the value of the migrationAutoValidation property.voidSets the value of the migrationIgnoreDefaultTimestampPrecisionDiffs property.voidThe order of invocation for [action]end() methods registeredMigrationListeners.voidThe order of invocation for [action]start() methods registeredMigrationListeners.voidSets the value of the migrationRevertUntracked property.voidsetMigrationSchemata(List<MigrationSchema> migrationSchemata) voidsetNamePathSeparator(String value) The character(s) to be used as a separator in paths encoded in aNamevoidsetParamCastMode(ParamCastMode value) Whether rendered bind values should be cast to their respective type.voidsetParamType(ParamType value) Specify how bind variables are to be rendered.voidTransform the parsed SQL to append missing table references to the query'sFROMorUSINGclause, if applicable.voidsetParseDateFormat(String value) The date format to use when parsing functions whose behaviour depends on some session date format, such as NLS_DATE_FORMAT in OraclevoidsetParseDialect(SQLDialect value) [#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.voidsetParseIgnoreComments(Boolean value) Sets the value of the parseIgnoreComments property.voidsetParseIgnoreCommentStart(String value) [#8325] The ignore comment start tokenvoidsetParseIgnoreCommentStop(String value) [#8325] The ignore comment stop tokenvoidSets the value of the parseIgnoreCommercialOnlyFeatures property.voidsetParseLocale(Locale value) The Locale to be used with any parser locale dependent logic, defaulting togetLocale().voidSets the value of the parseMetaDefaultExpressions property.voidsetParseNameCase(ParseNameCase value) [#7337] The default name case for parsed identifiers.voidsetParseNamedParamPrefix(String value) The prefix to use for named parameters in parsed SQL.voidSets the value of the parseRetainCommentsBetweenQueries property.voidsetParseSearchPath(List<ParseSearchSchema> parseSearchPath) voidsetParseSetCommands(Boolean value) Sets the value of the parseSetCommands property.voidsetParseTimestampFormat(String value) The timestamp format to use when parsing functions whose behaviour depends on some session date format, such as NLS_TIMESTAMP_FORMAT in Oraclevoid[#7344] Whether the parser should accept unknown functions.void[#5917] Whether the parser should accept unsupported (but known) syntax.void[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider.voidsetQueryPoolable(QueryPoolable value) The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified.voidsetQueryTimeout(Integer value) The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified.voidsetReadonlyInsert(WriteIfReadonly value) void[#9864] The behaviour when trying to insert into readonly columns usingTableRecord.insert().void[#9864] The behaviour when trying to update a readonly column usingUpdatableRecord.update().voidsetReadonlyUpdate(WriteIfReadonly value) voidThe order of invocation for [action]end() methods registeredRecordListeners.voidThe order of invocation for [action]start() methods registeredRecordListeners.voidsetReflectionCaching(Boolean value) Sets the value of the reflectionCaching property.voidsetRenderCatalog(Boolean value) Sets the value of the renderCatalog property.voidSets the value of the renderCoalesceToEmptyStringInConcat property.voidWhether theNullability.DEFAULTnullablity should be rendered in generated DDL, and how it should be rendered.voidsetRenderFormatted(Boolean value) Sets the value of the renderFormatted property.voidAll sorts of formatting flags / settings.voidSets the value of the renderGroupConcatMaxLenSessionVariable property.voidThe join type to be generated by implicit joins.voidWhether to render an explicit windowRANGEclause when an implicit clause is applied.voidWhether the case ofKeywordreferences should be modified in any way.voidDeprecated.- 3.12.0 - [#5909] - UseRenderKeywordCaseinstead.voidsetRenderLocale(Locale value) The Locale to be used with any render locale dependent logic (as e.g.voidsetRenderMapping(RenderMapping value) Configure render mapping for runtime schema / table rewriting in generated SQL.voidsetRenderNameCase(RenderNameCase value) Whether the case ofNamereferences should be modified in any way.voidsetRenderNamedParamPrefix(String value) The prefix to use for named parameters in generated SQL.voidDeprecated.- 3.12.0 - [#5909] - UseRenderQuotedNamesandRenderNameCaseinstead.voidWhether to render the optionalASkeyword in table aliases, if it is optional in the output dialect.voidWhether to render the optionalASkeyword in table aliases, if it is optional in the output dialect.voidWhether to render optional parentheses to make associativity explicit, e.g.voidWhether to render the optionalINNERkeyword inINNER JOIN, if it is optional in the output dialect.voidWhether to render the optionalOUTERkeyword inOUTER JOIN, if it is optional in the output dialect.voidSets the value of the renderOrderByRownumberForEmulatedPagination property.voidSets the value of the renderOutputForSQLServerReturningClause property.voidSets the value of the renderParenthesisAroundSetOperationQueries property.voidWhether rendered schema, table, column names, etc should be quoted.voidSets the value of the renderScalarSubqueriesForStoredFunctions property.voidsetRenderSchema(Boolean value) Sets the value of the renderSchema property.voidSets the value of the returnAllOnUpdatableRecord property.voidSets the value of the returnIdentityOnUpdatableRecord property.voidsetReturnRecordToPojo(Boolean value) Sets the value of the returnRecordToPojo property.voidsetStatementType(StatementType value) The type of statement that is to be executed.voidA strategy defining how exceptions from the database / JDBC driver should be propagatedvoidThe order of invocation for [action]end() methods registeredTransactionListeners.voidThe order of invocation for [action]start() methods registeredTransactionListeners.voidSets the value of the transformAnsiJoinToTableLists property.voidTransform a subquery from an IN condition with LIMIT to an equivalent derived table.voidSets the value of the transformInlineBindValuesForFieldComparisons property.voidsetTransformPatterns(Boolean value) Sets the value of the transformPatterns property.voidSets the value of the transformPatternsAndNeToNotIn property.voidSets the value of the transformPatternsArithmeticExpressions property.voidSets the value of the transformPatternsBitNotBitNand property.voidSets the value of the transformPatternsBitNotBitNor property.voidSets the value of the transformPatternsBitNotBitNot property.voidSets the value of the transformPatternsBitNotBitXNor property.voidSets the value of the transformPatternsEmptyScalarSubquery property.voidSets the value of the transformPatternsHyperbolicFunctions property.voidSets the value of the transformPatternsIdempotentFunctionRepetition property.voidSets the value of the transformPatternsInverseHyperbolicFunctions property.voidSets the value of the transformPatternsLogarithmicFunctions property.voidSets the value of the transformPatternsLogging property.voidSets the value of the transformPatternsMergeAndComparison property.voidSets the value of the transformPatternsMergeBetweenSymmetricPredicates property.voidSets the value of the transformPatternsMergeInLists property.voidSets the value of the transformPatternsMergeOrComparison property.voidSets the value of the transformPatternsMergeRangePredicates property.voidSets the value of the transformPatternsNegNeg property.voidSets the value of the transformPatternsNormaliseAssociativeOps property.voidSets the value of the transformPatternsNormaliseFieldCompareValue property.voidSets the value of the transformPatternsNormaliseInListSingleElementToComparison property.voidSets the value of the transformPatternsNotComparison property.voidSets the value of the transformPatternsNotNot property.voidSets the value of the transformPatternsNotNotDistinct property.voidSets the value of the transformPatternsOrEqToIn property.voidSets the value of the transformPatternsScalarSubqueryCountAsteriskGtZero property.voidSets the value of the transformPatternsScalarSubqueryCountExpressionGtZero property.voidSets the value of the transformPatternsTrigonometricFunctions property.voidsetTransformPatternsTrim(Boolean value) Sets the value of the transformPatternsTrim property.voidSets the value of the transformPatternsTrivialCaseAbbreviation property.voidSets the value of the transformPatternsTrivialPredicates property.voidTransform theQUALIFYclause to an equivalent derived table to filter on window functions.voidsetTransformRownum(Transformation value) TransformROWNUMexpressions to correspondingLIMITclauses orROW_NUMBER()expressions.voidSets the value of the transformTableListsToAnsiJoin property.voidTransform arithmetic expressions on literals and bind variables.voidsetUpdatablePrimaryKeys(Boolean value) Sets the value of the updatablePrimaryKeys property.voidsetUpdateRecordTimestamp(Boolean value) Sets the value of the updateRecordTimestamp property.voidsetUpdateRecordVersion(Boolean value) Sets the value of the updateRecordVersion property.voidWhetherUpdatableRecord.update()calls should be executed if the record is unchanged.voidThe order of invocation for [action]end() methods registeredVisitListeners.voidThe order of invocation for [action]start() methods registeredVisitListeners.toString()withAttachRecords(Boolean value) Whether string literals should be escaped with backslash.withBatchSize(Integer value) A property specifying a batch size that should be applied to all automatically createdBatchedConnectioninstances.withBindOffsetTimeType(Boolean value) The default implementation of the ParsingConnection cache's LRU cache size.withCacheRecordMappers(Boolean value) withDebugInfoOnStackTrace(Boolean value) withDelimiter(String value) [#5826] The delimiter character to be used to delimit statements in batches.[#3884] HowMULTISETsupport should be emulated.[#6771] Specifies whether DELETE statements are allowed to be executed lacking a WHERE clause.The order of invocation for [action]end() methods registeredExecuteListeners.The order of invocation for [action]start() methods registeredExecuteListeners.withExecuteLogging(Boolean value) [#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause.Whether to fetch data into intermediateResultinstances.withFetchServerOutputSize(Integer value) Whether server output should be fetched after each query execution.withFetchSize(Integer value) The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified.withFetchWarnings(Boolean value) withInlineThreshold(Integer value) The maximum number of allowed bind variables before inlining all values where0uses the dialect defaults:SQLDialect.ACCESS: 768SQLDialect.ASE: 2000SQLDialect.INGRES: 1024SQLDialect.ORACLE: 32767SQLDialect.POSTGRES: 32767SQLDialect.SQLITE: 999SQLDialect.SQLSERVER: 2100withInListPadBase(Integer value) [#7095] The base to use to calculate the powers of when applying in list padding.withInListPadding(Boolean value) withInterpreterDialect(SQLDialect value) [#7337] The dialect that should be used to interpret SQL DDL statements.withInterpreterLocale(Locale value) The Locale to be used with any interpreter locale dependent logic, defaulting togetLocale().[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements.withInterpreterSearchPath(List<InterpreterSearchSchema> interpreterSearchPath) withInterpreterSearchPath(InterpreterSearchSchema... values) withLocale(Locale value) The Locale to be used with any locale dependent logic if there is not a more specific locale available.withMapJPAAnnotations(Boolean value) withMaxRows(Integer value) The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified.withMigrationAllowsUndo(Boolean value) withMigrationAutoBaseline(Boolean value) The order of invocation for [action]end() methods registeredMigrationListeners.The order of invocation for [action]start() methods registeredMigrationListeners.withMigrationSchemata(List<MigrationSchema> migrationSchemata) withMigrationSchemata(MigrationSchema... values) withNamePathSeparator(String value) The character(s) to be used as a separator in paths encoded in aNamewithParamCastMode(ParamCastMode value) Whether rendered bind values should be cast to their respective type.withParamType(ParamType value) Specify how bind variables are to be rendered.Transform the parsed SQL to append missing table references to the query'sFROMorUSINGclause, if applicable.withParseDateFormat(String value) The date format to use when parsing functions whose behaviour depends on some session date format, such as NLS_DATE_FORMAT in OraclewithParseDialect(SQLDialect value) [#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.withParseIgnoreComments(Boolean value) [#8325] The ignore comment start tokenwithParseIgnoreCommentStop(String value) [#8325] The ignore comment stop tokenwithParseLocale(Locale value) The Locale to be used with any parser locale dependent logic, defaulting togetLocale().withParseNameCase(ParseNameCase value) [#7337] The default name case for parsed identifiers.withParseNamedParamPrefix(String value) The prefix to use for named parameters in parsed SQL.withParseSearchPath(List<ParseSearchSchema> parseSearchPath) withParseSearchPath(ParseSearchSchema... values) withParseSetCommands(Boolean value) withParseTimestampFormat(String value) The timestamp format to use when parsing functions whose behaviour depends on some session date format, such as NLS_TIMESTAMP_FORMAT in Oracle[#7344] Whether the parser should accept unknown functions.[#5917] Whether the parser should accept unsupported (but known) syntax.[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider.withQueryPoolable(QueryPoolable value) The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified.withQueryTimeout(Integer value) The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified.[#9864] The behaviour when trying to insert into readonly columns usingTableRecord.insert().[#9864] The behaviour when trying to update a readonly column usingUpdatableRecord.update().The order of invocation for [action]end() methods registeredRecordListeners.The order of invocation for [action]start() methods registeredRecordListeners.withReflectionCaching(Boolean value) withRenderCatalog(Boolean value) Whether theNullability.DEFAULTnullablity should be rendered in generated DDL, and how it should be rendered.withRenderFormatted(Boolean value) All sorts of formatting flags / settings.The join type to be generated by implicit joins.Whether to render an explicit windowRANGEclause when an implicit clause is applied.Whether the case ofKeywordreferences should be modified in any way.Deprecated.- 3.12.0 - [#5909] - UseRenderKeywordCaseinstead.withRenderLocale(Locale value) The Locale to be used with any render locale dependent logic (as e.g.withRenderMapping(RenderMapping value) Configure render mapping for runtime schema / table rewriting in generated SQL.withRenderNameCase(RenderNameCase value) Whether the case ofNamereferences should be modified in any way.withRenderNamedParamPrefix(String value) The prefix to use for named parameters in generated SQL.Deprecated.- 3.12.0 - [#5909] - UseRenderQuotedNamesandRenderNameCaseinstead.Whether to render the optionalASkeyword in table aliases, if it is optional in the output dialect.Whether to render the optionalASkeyword in table aliases, if it is optional in the output dialect.Whether to render optional parentheses to make associativity explicit, e.g.Whether to render the optionalINNERkeyword inINNER JOIN, if it is optional in the output dialect.Whether to render the optionalOUTERkeyword inOUTER JOIN, if it is optional in the output dialect.Whether rendered schema, table, column names, etc should be quoted.withRenderSchema(Boolean value) withReturnRecordToPojo(Boolean value) withStatementType(StatementType value) The type of statement that is to be executed.A strategy defining how exceptions from the database / JDBC driver should be propagatedThe order of invocation for [action]end() methods registeredTransactionListeners.The order of invocation for [action]start() methods registeredTransactionListeners.Transform a subquery from an IN condition with LIMIT to an equivalent derived table.withTransformPatterns(Boolean value) withTransformPatternsTrim(Boolean value) Transform theQUALIFYclause to an equivalent derived table to filter on window functions.TransformROWNUMexpressions to correspondingLIMITclauses orROW_NUMBER()expressions.Transform arithmetic expressions on literals and bind variables.withUpdatablePrimaryKeys(Boolean value) withUpdateRecordTimestamp(Boolean value) withUpdateRecordVersion(Boolean value) WhetherUpdatableRecord.update()calls should be executed if the record is unchanged.The order of invocation for [action]end() methods registeredVisitListeners.The order of invocation for [action]start() methods registeredVisitListeners.
-
Field Details
-
forceIntegerTypesOnZeroScaleDecimals
-
renderCatalog
-
renderSchema
-
renderMapping
-
renderQuotedNames
-
renderNameCase
-
renderNameStyle
-
renderNamedParamPrefix
-
renderKeywordCase
-
renderKeywordStyle
-
renderLocale
-
renderFormatted
-
renderFormatting
-
renderOptionalAssociativityParentheses
-
renderOptionalAsKeywordForTableAliases
-
renderOptionalAsKeywordForFieldAliases
-
renderOptionalInnerKeyword
-
renderOptionalOuterKeyword
-
renderImplicitWindowRange
-
renderScalarSubqueriesForStoredFunctions
-
renderImplicitJoinType
-
renderDefaultNullability
-
renderCoalesceToEmptyStringInConcat
-
renderOrderByRownumberForEmulatedPagination
-
renderOutputForSQLServerReturningClause
-
renderGroupConcatMaxLenSessionVariable
-
renderParenthesisAroundSetOperationQueries
-
namePathSeparator
-
bindOffsetDateTimeType
-
bindOffsetTimeType
-
fetchTriggerValuesAfterSQLServerOutput
-
fetchIntermediateResult
-
transformPatterns
-
transformPatternsLogging
-
transformPatternsTrim
-
transformPatternsNotNot
-
transformPatternsNotComparison
-
transformPatternsNotNotDistinct
-
transformPatternsNormaliseAssociativeOps
-
transformPatternsNormaliseInListSingleElementToComparison
-
transformPatternsNormaliseFieldCompareValue
-
transformPatternsOrEqToIn
-
transformPatternsAndNeToNotIn
-
transformPatternsMergeOrComparison
-
transformPatternsMergeAndComparison
-
transformPatternsMergeInLists
-
transformPatternsMergeRangePredicates
-
transformPatternsMergeBetweenSymmetricPredicates
-
transformPatternsTrivialCaseAbbreviation
-
transformPatternsTrivialPredicates
-
transformPatternsScalarSubqueryCountAsteriskGtZero
-
transformPatternsScalarSubqueryCountExpressionGtZero
-
transformPatternsEmptyScalarSubquery
-
transformPatternsNegNeg
-
transformPatternsBitNotBitNot
-
transformPatternsBitNotBitNand
-
transformPatternsBitNotBitNor
-
transformPatternsBitNotBitXNor
-
transformPatternsIdempotentFunctionRepetition
-
transformPatternsArithmeticExpressions
-
transformPatternsTrigonometricFunctions
-
transformPatternsLogarithmicFunctions
-
transformPatternsHyperbolicFunctions
-
transformPatternsInverseHyperbolicFunctions
-
transformInlineBindValuesForFieldComparisons
-
transformAnsiJoinToTableLists
-
transformInConditionSubqueryWithLimitToDerivedTable
-
transformQualify
-
transformTableListsToAnsiJoin
-
transformRownum
-
transformUnneededArithmeticExpressions
-
backslashEscaping
-
paramType
-
paramCastMode
-
statementType
-
inlineThreshold
-
transactionListenerStartInvocationOrder
-
transactionListenerEndInvocationOrder
-
migrationListenerStartInvocationOrder
-
migrationListenerEndInvocationOrder
-
visitListenerStartInvocationOrder
-
visitListenerEndInvocationOrder
-
recordListenerStartInvocationOrder
-
recordListenerEndInvocationOrder
-
executeListenerStartInvocationOrder
-
executeListenerEndInvocationOrder
-
executeLogging
-
updateRecordVersion
-
updateRecordTimestamp
-
executeWithOptimisticLocking
-
executeWithOptimisticLockingExcludeUnversioned
-
attachRecords
-
insertUnchangedRecords
-
updateUnchangedRecords
-
updatablePrimaryKeys
-
reflectionCaching
-
cacheRecordMappers
-
cacheParsingConnection
-
cacheParsingConnectionLRUCacheSize
-
cachePreparedStatementInLoader
-
throwExceptions
-
fetchWarnings
-
fetchServerOutputSize
-
returnIdentityOnUpdatableRecord
-
returnAllOnUpdatableRecord
-
returnRecordToPojo
-
mapJPAAnnotations
-
mapRecordComponentParameterNames
-
mapConstructorPropertiesParameterNames
-
mapConstructorParameterNames
-
mapConstructorParameterNamesInKotlin
-
queryPoolable
-
queryTimeout
-
maxRows
-
fetchSize
-
batchSize
-
debugInfoOnStackTrace
-
inListPadding
-
inListPadBase
-
delimiter
-
emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly
-
emulateMultiset
-
executeUpdateWithoutWhere
-
executeDeleteWithoutWhere
-
interpreterDialect
-
interpreterNameLookupCaseSensitivity
-
interpreterLocale
-
interpreterDelayForeignKeyDeclarations
-
metaIncludeSystemIndexes
-
metaIncludeSystemSequences
-
migrationAllowsUndo
-
migrationRevertUntracked
-
migrationAutoBaseline
-
migrationAutoValidation
-
migrationIgnoreDefaultTimestampPrecisionDiffs
-
locale
-
parseDialect
-
parseLocale
-
parseDateFormat
-
parseTimestampFormat
-
parseNamedParamPrefix
-
parseNameCase
-
parseWithMetaLookups
-
parseAppendMissingTableReferences
-
parseSetCommands
-
parseUnsupportedSyntax
-
parseUnknownFunctions
-
parseIgnoreCommercialOnlyFeatures
-
parseIgnoreComments
-
parseIgnoreCommentStart
-
parseIgnoreCommentStop
-
parseRetainCommentsBetweenQueries
-
parseMetaDefaultExpressions
-
readonlyTableRecordInsert
-
readonlyUpdatableRecordUpdate
-
readonlyInsert
-
readonlyUpdate
-
applyWorkaroundFor7962
-
interpreterSearchPath
-
migrationSchemata
-
parseSearchPath
-
-
Constructor Details
-
Settings
public Settings()
-
-
Method Details
-
isForceIntegerTypesOnZeroScaleDecimals
Historically, zero-scale decimal types are generated as their most appropriate, corresponding integer type (e.g. NUMBER(2, 0) and less: Byte). The same behaviour is replicated in theMetaAPI. This flag allows for turning off this feature.- Returns:
- possible object is
Boolean
-
setForceIntegerTypesOnZeroScaleDecimals
Sets the value of the forceIntegerTypesOnZeroScaleDecimals property.- Parameters:
value- allowed object isBoolean
-
isRenderCatalog
Whether any catalog name should be rendered at all.Use this for single-catalog environments, or when all objects are made available using synonyms
- Returns:
- possible object is
Boolean
-
setRenderCatalog
Sets the value of the renderCatalog property.- Parameters:
value- allowed object isBoolean
-
isRenderSchema
Whether any schema name should be rendered at all.Setting this to false also implicitly sets "renderCatalog" to false.
Use this for single-schema environments, or when all objects are made available using synonyms
- Returns:
- possible object is
Boolean
-
setRenderSchema
Sets the value of the renderSchema property.- Parameters:
value- allowed object isBoolean
-
getRenderMapping
Configure render mapping for runtime schema / table rewriting in generated SQL. -
setRenderMapping
Configure render mapping for runtime schema / table rewriting in generated SQL. -
getRenderQuotedNames
Whether rendered schema, table, column names, etc should be quoted.This only affects names created through
DSL.name(String)methods (including those that are implicitly created through this method), notDSL.quotedName(String)orDSL.unquotedName(String), whose behaviour cannot be overridden.This setting does not affect any plain SQL usage.
-
setRenderQuotedNames
Whether rendered schema, table, column names, etc should be quoted.This only affects names created through
DSL.name(String)methods (including those that are implicitly created through this method), notDSL.quotedName(String)orDSL.unquotedName(String), whose behaviour cannot be overridden.This setting does not affect any plain SQL usage.
-
getRenderNameCase
Whether the case ofNamereferences should be modified in any way.Names are modified irrespective of the
getRenderQuotedNames()setting.This setting does not affect any plain SQL usage.
-
setRenderNameCase
Whether the case ofNamereferences should be modified in any way.Names are modified irrespective of the
getRenderQuotedNames()setting.This setting does not affect any plain SQL usage.
-
getRenderNameStyle
Deprecated.- 3.12.0 - [#5909] - UseRenderQuotedNamesandRenderNameCaseinstead.Whether rendered schema, table, column names, etc should be quoted in rendered SQL, or transformed in any other way.This is set to "QUOTED" by default for backwards-compatibility.
-
setRenderNameStyle
Deprecated.- 3.12.0 - [#5909] - UseRenderQuotedNamesandRenderNameCaseinstead.Whether rendered schema, table, column names, etc should be quoted in rendered SQL, or transformed in any other way.This is set to "QUOTED" by default for backwards-compatibility.
-
getRenderNamedParamPrefix
The prefix to use for named parameters in generated SQL.Named parameter syntax defaults to
:name(such as supported by Oracle, JPA, Spring), but vendor specific parameters may look differently. This flag can be used to determine the prefix to be used by named parameters, such as@for SQL Server's@nameor$for PostgreSQL's$name, when generating SQL."Named indexed" parameters can be obtained in the same way by specifingy
ParamType#NAMEDand not providing a name to parameters, resulting in:1or@1or$1, etc. -
setRenderNamedParamPrefix
The prefix to use for named parameters in generated SQL.Named parameter syntax defaults to
:name(such as supported by Oracle, JPA, Spring), but vendor specific parameters may look differently. This flag can be used to determine the prefix to be used by named parameters, such as@for SQL Server's@nameor$for PostgreSQL's$name, when generating SQL."Named indexed" parameters can be obtained in the same way by specifingy
ParamType#NAMEDand not providing a name to parameters, resulting in:1or@1or$1, etc. -
getRenderKeywordCase
Whether the case ofKeywordreferences should be modified in any way. -
setRenderKeywordCase
Whether the case ofKeywordreferences should be modified in any way. -
getRenderKeywordStyle
Deprecated.- 3.12.0 - [#5909] - UseRenderKeywordCaseinstead.Whether the case ofKeywordreferences should be modified in any way. -
setRenderKeywordStyle
Deprecated.- 3.12.0 - [#5909] - UseRenderKeywordCaseinstead.Whether the case ofKeywordreferences should be modified in any way. -
getRenderLocale
The Locale to be used with any render locale dependent logic (as e.g. transforming names to lower / uppper case), defaulting togetLocale(). -
setRenderLocale
The Locale to be used with any render locale dependent logic (as e.g. transforming names to lower / uppper case), defaulting togetLocale(). -
isRenderFormatted
Whether rendered SQL should be pretty-printed.- Returns:
- possible object is
Boolean
-
setRenderFormatted
Sets the value of the renderFormatted property.- Parameters:
value- allowed object isBoolean
-
getRenderFormatting
All sorts of formatting flags / settings. -
setRenderFormatting
All sorts of formatting flags / settings. -
getRenderOptionalAssociativityParentheses
Whether to render optional parentheses to make associativity explicit, e.g.((a + b) + c)instead of (a + b + c). -
setRenderOptionalAssociativityParentheses
Whether to render optional parentheses to make associativity explicit, e.g.((a + b) + c)instead of (a + b + c). -
getRenderOptionalAsKeywordForTableAliases
Whether to render the optionalASkeyword in table aliases, if it is optional in the output dialect. This is ignored if the keyword is not supported (e.g. in Oracle) -
setRenderOptionalAsKeywordForTableAliases
Whether to render the optionalASkeyword in table aliases, if it is optional in the output dialect. This is ignored if the keyword is not supported (e.g. in Oracle) -
getRenderOptionalAsKeywordForFieldAliases
Whether to render the optionalASkeyword in table aliases, if it is optional in the output dialect. -
setRenderOptionalAsKeywordForFieldAliases
Whether to render the optionalASkeyword in table aliases, if it is optional in the output dialect. -
getRenderOptionalInnerKeyword
Whether to render the optionalINNERkeyword inINNER JOIN, if it is optional in the output dialect. -
setRenderOptionalInnerKeyword
Whether to render the optionalINNERkeyword inINNER JOIN, if it is optional in the output dialect. -
getRenderOptionalOuterKeyword
Whether to render the optionalOUTERkeyword inOUTER JOIN, if it is optional in the output dialect. -
setRenderOptionalOuterKeyword
Whether to render the optionalOUTERkeyword inOUTER JOIN, if it is optional in the output dialect. -
getRenderImplicitWindowRange
Whether to render an explicit windowRANGEclause when an implicit clause is applied. -
setRenderImplicitWindowRange
Whether to render an explicit windowRANGEclause when an implicit clause is applied. -
isRenderScalarSubqueriesForStoredFunctions
Whether stored function calls should be wrapped in scalar subqueries.Oracle 11g (and potentially, other databases too) implements scalar subquery caching. With this flag set to true, users can automatically profit from this feature in all SQL statements.
- Returns:
- possible object is
Boolean
-
setRenderScalarSubqueriesForStoredFunctions
Sets the value of the renderScalarSubqueriesForStoredFunctions property.- Parameters:
value- allowed object isBoolean
-
getRenderImplicitJoinType
The join type to be generated by implicit joins. -
setRenderImplicitJoinType
The join type to be generated by implicit joins. -
getRenderDefaultNullability
Whether theNullability.DEFAULTnullablity should be rendered in generated DDL, and how it should be rendered. -
setRenderDefaultNullability
Whether theNullability.DEFAULTnullablity should be rendered in generated DDL, and how it should be rendered. -
isRenderCoalesceToEmptyStringInConcat
Whether stored function calls should be wrapped in scalar subqueries.Oracle 11g (and potentially, other databases too) implements scalar subquery caching. With this flag set to true, users can automatically profit from this feature in all SQL statements.
This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setRenderCoalesceToEmptyStringInConcat
Sets the value of the renderCoalesceToEmptyStringInConcat property.- Parameters:
value- allowed object isBoolean
-
isRenderOrderByRownumberForEmulatedPagination
Whether an additionalORDER BY rnclause should be rendered on emulated paginated queries.Older databases did not support OFFSET .. FETCH pagination, so jOOQ emulates it using derived tables and
ROWNUM(Oracle 11g and older) orROW_NUMBER()(e.g. DB2, SQL Server, etc.) filtering. While these subqueries are ordered, the ordering is not guaranteed to be stable in the outer most queries. It may be stable (and e.g. in Oracle, it mostly is, if queries are not parallel, or joined to other queries, etc.), so the excessORDER BYclause may add some additional performance overhead. This setting forces jOOQ to not generate the additionalORDER BYclause.For details, see https://github.com/jOOQ/jOOQ/issues/7609.
- Returns:
- possible object is
Boolean
-
setRenderOrderByRownumberForEmulatedPagination
Sets the value of the renderOrderByRownumberForEmulatedPagination property.- Parameters:
value- allowed object isBoolean
-
isRenderOutputForSQLServerReturningClause
Whether the jOOQRETURNINGclause should map to SQL Server'sOUTPUTclause.SQL Server supports an
OUTPUTclause in most DML statements, whose behaviour is almost identical toRETURNINGin Firebird, Oracle, PostgreSQL. Users who want to prevent jOOQ from rendering thisOUTPUTclause can deactivate this flag to revert to jOOQ callingjava.sql.Statement#getGeneratedKeys()instead, which is only supported for single row inserts.This
OUTPUTclause does not support fetching trigger generated values. In order to fetch trigger generated values,fetchTriggerValuesAfterSQLServerOutputneeds to be enabled as well.For details, see https://github.com/jOOQ/jOOQ/issues/4498.
- Returns:
- possible object is
Boolean
-
setRenderOutputForSQLServerReturningClause
Sets the value of the renderOutputForSQLServerReturningClause property.- Parameters:
value- allowed object isBoolean
-
isRenderGroupConcatMaxLenSessionVariable
Whether the jOOQGROUP_CONCATfunction should be overflow-protected by setting the@@group_concat_max_lensession variable in MySQL style database systems.MySQL truncates
GROUP_CONCATresults after a certain length, which may be way too small for jOOQ's usage, especially when using theMULTISETemulation. By default, jOOQ sets a session variable to the highest possible value prior to executing a query containingGROUP_CONCAT. This flag can be used to opt out of this.For details, see https://github.com/jOOQ/jOOQ/issues/12092.
- Returns:
- possible object is
Boolean
-
setRenderGroupConcatMaxLenSessionVariable
Sets the value of the renderGroupConcatMaxLenSessionVariable property.- Parameters:
value- allowed object isBoolean
-
isRenderParenthesisAroundSetOperationQueries
Whether queries combined with set operators (e.g. UNION and UNION ALL) should always be surrounded by a parenthesis pair.By default (i.e. when this setting is set to
falsejOOQ will only render parenthesis pairs around queries combined with set operators when required. This is for example the case when set operators are nested, when non-associative operators like EXCEPT are used, or when the queries are rendered as derived tables.When this setting is set to
truethe queries combined with set operators will always be surrounded by a parenthesis pair.For details, see https://github.com/jOOQ/jOOQ/issues/3676 and https://github.com/jOOQ/jOOQ/issues/9751.
- Returns:
- possible object is
Boolean
-
setRenderParenthesisAroundSetOperationQueries
Sets the value of the renderParenthesisAroundSetOperationQueries property.- Parameters:
value- allowed object isBoolean
-
getNamePathSeparator
The character(s) to be used as a separator in paths encoded in aNameA few hierarchical mapping features work with paths encoded in names (specifically field aliases), such as the reflective mapping of nested values when aliasing fields as:
SELECT a.first_name AS "book.author.firstName" a.last_name AS "book.author.lastName" FROM ...Not all dialects support "." in identifiers. This setting allows for specifying an alternative String to use as separator, e.g. "__".
-
setNamePathSeparator
The character(s) to be used as a separator in paths encoded in aNameA few hierarchical mapping features work with paths encoded in names (specifically field aliases), such as the reflective mapping of nested values when aliasing fields as:
SELECT a.first_name AS "book.author.firstName" a.last_name AS "book.author.lastName" FROM ...Not all dialects support "." in identifiers. This setting allows for specifying an alternative String to use as separator, e.g. "__".
-
isBindOffsetDateTimeType
Whether thejava.time(JSR 310) typeOffsetDateTimeshould be bound natively to JDBC.Historically, jOOQ encoded the
java.timetypes as strings to offer better compatibility with older JDBC drivers. By now, most drivers should support thejava.timetypes. Using them may produce better performance both on the server and on the client side.This flag allows for reverting to pre-jOOQ 3.14 behaviour, where the default is to bind these types natively.
For details, see https://github.com/jOOQ/jOOQ/issues/9902.
- Returns:
- possible object is
Boolean
-
setBindOffsetDateTimeType
Sets the value of the bindOffsetDateTimeType property.- Parameters:
value- allowed object isBoolean
-
isBindOffsetTimeType
Whether thejava.time(JSR 310) typeOffsetTimeshould be bound natively to JDBC.Historically, jOOQ encoded the
java.timetypes as strings to offer better compatibility with older JDBC drivers. By now, most drivers should support thejava.timetypes. Using them may produce better performance both on the server and on the client side.This flag allows for reverting to pre-jOOQ 3.14 behaviour, where the default is to bind these types natively.
For details, see https://github.com/jOOQ/jOOQ/issues/9902.
- Returns:
- possible object is
Boolean
-
setBindOffsetTimeType
Sets the value of the bindOffsetTimeType property.- Parameters:
value- allowed object isBoolean
-
isFetchTriggerValuesAfterSQLServerOutput
Fetch trigger values after SQL ServerOUTPUTclause.SQL Server
OUTPUTstatements do not support fetching trigger generated values. This is a limitation of therenderOutputForSQLServerReturningClause. An additionalMERGEstatement can run a second query if (and only if) the primary key has been included in theOUTPUTclause.For details, see https://github.com/jOOQ/jOOQ/issues/4498.
- Returns:
- possible object is
Boolean
-
setFetchTriggerValuesAfterSQLServerOutput
Sets the value of the fetchTriggerValuesAfterSQLServerOutput property.- Parameters:
value- allowed object isBoolean
-
getFetchIntermediateResult
Whether to fetch data into intermediateResultinstances.By default, a
ResultQueryproduces no intermediateResultinstances if they are not explicitly requested by the caller, e.g. by callingResultQuery.fetch(), or in the presence ofExecuteListenerinstances, which may require access toExecuteContext.result(). This default behaviour helps avoid unnecessary allocations of possibly large data structures.Using this flag, fetching of intermediate results can be turned off even when execute listeners are present, or turned on even if they're absent.
-
setFetchIntermediateResult
Whether to fetch data into intermediateResultinstances.By default, a
ResultQueryproduces no intermediateResultinstances if they are not explicitly requested by the caller, e.g. by callingResultQuery.fetch(), or in the presence ofExecuteListenerinstances, which may require access toExecuteContext.result(). This default behaviour helps avoid unnecessary allocations of possibly large data structures.Using this flag, fetching of intermediate results can be turned off even when execute listeners are present, or turned on even if they're absent.
-
isTransformPatterns
Transform various syntax patterns to better versions, if possible.This flag enables the pattern transformation feature, which consists of several sub-flags that are all prefixed with "transformPatterns", e.g.
transformPatternsTrim. While the sub-flags default to being enabled, and can be disabled on an individual basis, the global feature itself is disabled by default.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatterns
Sets the value of the transformPatterns property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsLogging
Activate debug logging of thetransformPatternsfeature.- Returns:
- possible object is
Boolean
-
setTransformPatternsLogging
Sets the value of the transformPatternsLogging property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsTrim
TransformLTRIM(RTRIM(x))orRTRIM(LTRIM(x))toTRIM(x).Historically, a few dialects did not implement
TRIM(x)orTRIM(BOTH FROM x), so users worked around this by wrappingLTRIM()andRTRIM()with each other. Maintaining this is usually undesirable, so this transformation helps remove the unwanted wrapping.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsTrim
Sets the value of the transformPatternsTrim property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsNotNot
TransformNOT(NOT(x))tox.This transformation removes a redundant logic negation.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsNotNot
Sets the value of the transformPatternsNotNot property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsNotComparison
TransformNOT (a != b)toa = b, and similar comparisons.This transformation removes a redundant logical negation from the
DISTINCTpredicate.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsNotComparison
Sets the value of the transformPatternsNotComparison property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsNotNotDistinct
TransformNOT (a IS NOT DISTINCT FROM b)toa IS DISTINCT FROM b.This transformation removes a redundant logical negation from the
DISTINCTpredicate.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsNotNotDistinct
Sets the value of the transformPatternsNotNotDistinct property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsNormaliseAssociativeOps
Transform(a + b) + (c + d)to((a + b) + c) + d.This transformation turns trees into lists, which greatly simplifies other tree traversal transformations. Some of those other transformations currently rely on this flag to be active.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsNormaliseAssociativeOps
Sets the value of the transformPatternsNormaliseAssociativeOps property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsNormaliseInListSingleElementToComparison
Transformx IN (a)tox = aandx NOT IN (a)tox != a.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsNormaliseInListSingleElementToComparison
Sets the value of the transformPatternsNormaliseInListSingleElementToComparison property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsNormaliseFieldCompareValue
Transform1 = atoa = 1.This transformation inverses
TableField[op]org.jooq.impl.QOM.Valcomparisons, if they're not in that order.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsNormaliseFieldCompareValue
Sets the value of the transformPatternsNormaliseFieldCompareValue property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsOrEqToIn
Transformx = c1 OR x = c2tox IN (c1, c2).This transformation simplifies verbose
ORpredicates into simplerINpredicates.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsOrEqToIn
Sets the value of the transformPatternsOrEqToIn property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsAndNeToNotIn
Transformx != c1 AND x != c2tox NOT IN (c1, c2).This transformation simplifies verbose
ANDpredicates into simplerNOT INpredicates.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsAndNeToNotIn
Sets the value of the transformPatternsAndNeToNotIn property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsMergeOrComparison
Transformx = a OR x > atox >= a.This transformation merges multiple
ORconnected comparisons to a single comparison using a simpler operator.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsMergeOrComparison
Sets the value of the transformPatternsMergeOrComparison property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsMergeAndComparison
Transformx >= a AND x <= atox = a.This transformation merges multiple
ANDconnected comparisons to a single comparison using a simpler operator.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsMergeAndComparison
Sets the value of the transformPatternsMergeAndComparison property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsMergeInLists
Transformx IN (a, b, c) AND x IN (b, c, d)tox IN (b, c).This transformation merges multiple
ORconnected comparisons to a single comparison using a simpler operator.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsMergeInLists
Sets the value of the transformPatternsMergeInLists property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsMergeRangePredicates
Transformx >= a AND x <= btox BETWEEN a AND b.This transformation merges multiple
ANDconnected range predicates to a single comparison usingBETWEEN.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsMergeRangePredicates
Sets the value of the transformPatternsMergeRangePredicates property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsMergeBetweenSymmetricPredicates
Transformx BETWEEN a AND b OR x BETWEEN b AND atox BETWEEN SYMMETRIC a AND b.This transformation merges multiple
ORconnectedBETWEENpredicates to a single comparison usingBETWEEN SYMMETRIC.To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsMergeBetweenSymmetricPredicates
Sets the value of the transformPatternsMergeBetweenSymmetricPredicates property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsTrivialCaseAbbreviation
Transform trivial case abbreviations likeNVL(NULL, a)toa.This transformation removes any trivial case abbreviations, such as
NVL(),COALESCE(),NULLIF(), etc.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsTrivialCaseAbbreviation
Sets the value of the transformPatternsTrivialCaseAbbreviation property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsTrivialPredicates
Transform trivial predicates like1 = 1toTRUE.This transformation removes any trivial predicates.
This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsTrivialPredicates
Sets the value of the transformPatternsTrivialPredicates property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsScalarSubqueryCountAsteriskGtZero
Transform predicates comparing scalar subqueries with a count(SELECT COUNT(*) …) > 0to equivalentEXISTS (SELECT 1 …).Scalar subqueries that count rows and whose count is compared to 0 can be transformed into equivalent, but likely cheaper to execute EXISTS queries.
This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsScalarSubqueryCountAsteriskGtZero
Sets the value of the transformPatternsScalarSubqueryCountAsteriskGtZero property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsScalarSubqueryCountExpressionGtZero
Transform predicates comparing scalar subqueries with a count(SELECT COUNT(expr) …) > 0to equivalentEXISTS (SELECT 1 … WHERE expr IS NOT NULL).Scalar subqueries that count non-null expressions and whose count is compared to 0 can be transformed into equivalent, but likely cheaper to execute EXISTS queries.
This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsScalarSubqueryCountExpressionGtZero
Sets the value of the transformPatternsScalarSubqueryCountExpressionGtZero property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsEmptyScalarSubquery
Transform empty scalar subqueries like(SELECT 1 WHERE FALSE)toNULL.Scalar subqueries that are guaranteed to produce no results can be replaced by a
NULLvalue.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsEmptyScalarSubquery
Sets the value of the transformPatternsEmptyScalarSubquery property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsNegNeg
Transform-(-(x))toxThis transformation removes a redundant arithmetic negation.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsNegNeg
Sets the value of the transformPatternsNegNeg property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsBitNotBitNot
Transform~(~(x))tox.This transformation removes a redundant bitwise negation.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsBitNotBitNot
Sets the value of the transformPatternsBitNotBitNot property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsBitNotBitNand
Transform~(bitnand(x, y))tobitand(x, y)and~(bitand(x, y)tobitnand(x, y).This transformation removes a redundant bitwise negation.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsBitNotBitNand
Sets the value of the transformPatternsBitNotBitNand property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsBitNotBitNor
Transform~(bitnor(x, y))tobitor(x, y)and~(bitor(x, y)tobitnor(x, y).This transformation removes a redundant bitwise negation.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsBitNotBitNor
Sets the value of the transformPatternsBitNotBitNor property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsBitNotBitXNor
Transform~(bitxnor(x, y))tobitxor(x, y)and~(bitxor(x, y)tobitxnor(x, y).This transformation removes a redundant bitwise negation.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsBitNotBitXNor
Sets the value of the transformPatternsBitNotBitXNor property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsIdempotentFunctionRepetition
Transform all repetitions of idempotent functions, such asUPPER(UPPER(s))toUPPER(s).Idempotent functions that are covered so far, include:
LTRIM(LTRIM(s))toLTRIM(s)LTRIM(TRIM(s))toTRIM(s)RTRIM(RTRIM(s))toRTRIM(s)RTRIM(TRIM(s))toTRIM(s)TRIM(LTRIM(s))toTRIM(s)TRIM(RTRIM(s))toTRIM(s)UPPER(UPPER(s))toUPPER(s)LOWER(LOWER(s))toLOWER(s)
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsIdempotentFunctionRepetition
Sets the value of the transformPatternsIdempotentFunctionRepetition property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsArithmeticExpressions
Transform1 / y * xtox / y, and other transformations.This transformation simplifies arithmetic expressions.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsArithmeticExpressions
Sets the value of the transformPatternsArithmeticExpressions property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsTrigonometricFunctions
TransformSIN(x) / COS(x)toTAN(x), and other transformations.This transformation turns expanded trignonometric function definitions into their shorter equivalents.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsTrigonometricFunctions
Sets the value of the transformPatternsTrigonometricFunctions property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsLogarithmicFunctions
TransformLN(value) / LN(base)toLOG(base, value), and other transformations.This transformation turns expanded logarithmic function definitions into their shorter equivalents.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsLogarithmicFunctions
Sets the value of the transformPatternsLogarithmicFunctions property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsHyperbolicFunctions
Transform(EXP(x) - EXP(-x)) / 2toSINH(x), and other transformations.This transformation turns expanded hyperbolic function definitions into their shorter equivalents.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsHyperbolicFunctions
Sets the value of the transformPatternsHyperbolicFunctions property.- Parameters:
value- allowed object isBoolean
-
isTransformPatternsInverseHyperbolicFunctions
TransformLN(x + SQRT(SQUARE(x) + 1))toASINH(x), and other transformations.This transformation turns expanded inverse hyperbolic function definitions into their shorter equivalents.
To enable this feature,
transformPatternsmust be enabled as well.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformPatternsInverseHyperbolicFunctions
Sets the value of the transformPatternsInverseHyperbolicFunctions property.- Parameters:
value- allowed object isBoolean
-
isTransformInlineBindValuesForFieldComparisons
TransformQOM.CompareConditionand a few other types of condition to inline their bind values, in case they matchHistorically, prior to ANSI join syntax, joins were implemented by listing tables in the FROM clause and providing join predicates in the WHERE clause, possibly using vendor specific operators like
(+)(Oracle, DB2) or*=(SQL Server) for outer join support. For backwards compatibility with older RDBMS versions, ANSI joins in jOOQ code may be converted to equivalent table lists in generated SQL using this flag.This flag has a limited implementation that supports inner joins (in most cases) and outer joins (only for simple comparison predicates).
This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformInlineBindValuesForFieldComparisons
Sets the value of the transformInlineBindValuesForFieldComparisons property.- Parameters:
value- allowed object isBoolean
-
isTransformAnsiJoinToTableLists
Transform ANSI join to table lists if possible.Historically, prior to ANSI join syntax, joins were implemented by listing tables in the FROM clause and providing join predicates in the WHERE clause, possibly using vendor specific operators like
(+)(Oracle, DB2) or*=(SQL Server) for outer join support. For backwards compatibility with older RDBMS versions, ANSI joins in jOOQ code may be converted to equivalent table lists in generated SQL using this flag.This flag has a limited implementation that supports inner joins (in most cases) and outer joins (only for simple comparison predicates).
This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformAnsiJoinToTableLists
Sets the value of the transformAnsiJoinToTableLists property.- Parameters:
value- allowed object isBoolean
-
getTransformInConditionSubqueryWithLimitToDerivedTable
Transform a subquery from an IN condition with LIMIT to an equivalent derived table.This transformation works around a known MySQL limitation "ERROR 1235 (42000): This version of MySQL doesn't yet support 'LIMIT & IN/ALL/ANY/SOME subquery'"
This feature is available in the commercial distribution only.
-
setTransformInConditionSubqueryWithLimitToDerivedTable
Transform a subquery from an IN condition with LIMIT to an equivalent derived table.This transformation works around a known MySQL limitation "ERROR 1235 (42000): This version of MySQL doesn't yet support 'LIMIT & IN/ALL/ANY/SOME subquery'"
This feature is available in the commercial distribution only.
-
getTransformQualify
Transform theQUALIFYclause to an equivalent derived table to filter on window functions.This feature is available in the commercial distribution only.
-
setTransformQualify
Transform theQUALIFYclause to an equivalent derived table to filter on window functions.This feature is available in the commercial distribution only.
-
isTransformTableListsToAnsiJoin
Transform table lists to ANSI join if possible.(Very) historically, prior to ANSI join syntax, joins were implemented by listing tables in the FROM clause and providing join predicates in the WHERE clause, possibly using vendor specific operators like
(+)(Oracle, DB2) or*=(SQL Server) for outer join support. Migrating such join syntax is tedious. The jOOQ parser can parse the old syntax and this flag enables the transformation to ANSI join syntax.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setTransformTableListsToAnsiJoin
Sets the value of the transformTableListsToAnsiJoin property.- Parameters:
value- allowed object isBoolean
-
getTransformRownum
TransformROWNUMexpressions to correspondingLIMITclauses orROW_NUMBER()expressions.In Oracle 11g and less,
ROWNUMfiltering was the most popular way to paginate. This pseudo column is not supported in other RDBMS, and should be replaced in Oracle 12c by the FETCH clause orROW_NUMBER() OVER ()filtering. This transformation allows for replacing such a filter by equivalent SQL, if possible.This feature is available in the commercial distribution only.
-
setTransformRownum
TransformROWNUMexpressions to correspondingLIMITclauses orROW_NUMBER()expressions.In Oracle 11g and less,
ROWNUMfiltering was the most popular way to paginate. This pseudo column is not supported in other RDBMS, and should be replaced in Oracle 12c by the FETCH clause orROW_NUMBER() OVER ()filtering. This transformation allows for replacing such a filter by equivalent SQL, if possible.This feature is available in the commercial distribution only.
-
getTransformUnneededArithmeticExpressions
Transform arithmetic expressions on literals and bind variables.Arithmetic expressions may be implemented by the user, or arise from emulations from within jOOQ. Expressions on literals and bind variables could be evaluated in the client prior to generating SQL.
This feature is available in the commercial distribution only.
-
setTransformUnneededArithmeticExpressions
Transform arithmetic expressions on literals and bind variables.Arithmetic expressions may be implemented by the user, or arise from emulations from within jOOQ. Expressions on literals and bind variables could be evaluated in the client prior to generating SQL.
This feature is available in the commercial distribution only.
-
getBackslashEscaping
Whether string literals should be escaped with backslash. -
setBackslashEscaping
Whether string literals should be escaped with backslash. -
getParamType
Specify how bind variables are to be rendered.Possibilities include: - question marks - named parameters - named or inlined parameters - inlined parameters This value is overridden by statementType == STATIC_STATEMENT, in case of which, this defaults to INLINED
-
setParamType
Specify how bind variables are to be rendered.Possibilities include: - question marks - named parameters - named or inlined parameters - inlined parameters This value is overridden by statementType == STATIC_STATEMENT, in case of which, this defaults to INLINED
-
getParamCastMode
Whether rendered bind values should be cast to their respective type. -
setParamCastMode
Whether rendered bind values should be cast to their respective type. -
getStatementType
The type of statement that is to be executed. -
setStatementType
The type of statement that is to be executed. -
getInlineThreshold
The maximum number of allowed bind variables before inlining all values where0uses the dialect defaults:SQLDialect.ACCESS: 768SQLDialect.ASE: 2000SQLDialect.INGRES: 1024SQLDialect.ORACLE: 32767SQLDialect.POSTGRES: 32767SQLDialect.SQLITE: 999SQLDialect.SQLSERVER: 2100
-
setInlineThreshold
The maximum number of allowed bind variables before inlining all values where0uses the dialect defaults:SQLDialect.ACCESS: 768SQLDialect.ASE: 2000SQLDialect.INGRES: 1024SQLDialect.ORACLE: 32767SQLDialect.POSTGRES: 32767SQLDialect.SQLITE: 999SQLDialect.SQLSERVER: 2100
-
getTransactionListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredTransactionListeners. -
setTransactionListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredTransactionListeners. -
getTransactionListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredTransactionListeners. -
setTransactionListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredTransactionListeners. -
getMigrationListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredMigrationListeners. -
setMigrationListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredMigrationListeners. -
getMigrationListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredMigrationListeners. -
setMigrationListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredMigrationListeners. -
getVisitListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredVisitListeners. -
setVisitListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredVisitListeners. -
getVisitListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredVisitListeners. -
setVisitListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredVisitListeners. -
getRecordListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredRecordListeners. -
setRecordListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredRecordListeners. -
getRecordListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredRecordListeners. -
setRecordListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredRecordListeners. -
getExecuteListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredExecuteListeners. -
setExecuteListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredExecuteListeners. -
getExecuteListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredExecuteListeners. -
setExecuteListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredExecuteListeners. -
isExecuteLogging
When set to true, this will add jOOQ's default logging ExecuteListeners.- Returns:
- possible object is
Boolean
-
setExecuteLogging
Sets the value of the executeLogging property.- Parameters:
value- allowed object isBoolean
-
isUpdateRecordVersion
Whether store(), insert(), and update() methods should update the record version prior to the operation, for use withexecuteWithOptimisticLocking.- Returns:
- possible object is
Boolean
-
setUpdateRecordVersion
Sets the value of the updateRecordVersion property.- Parameters:
value- allowed object isBoolean
-
isUpdateRecordTimestamp
Whether store(), insert(), and update() methods should update the record timestamp prior to the operation, for use withexecuteWithOptimisticLocking.- Returns:
- possible object is
Boolean
-
setUpdateRecordTimestamp
Sets the value of the updateRecordTimestamp property.- Parameters:
value- allowed object isBoolean
-
isExecuteWithOptimisticLocking
Whether store() and delete() methods should be executed with optimistic locking.- Returns:
- possible object is
Boolean
-
setExecuteWithOptimisticLocking
Sets the value of the executeWithOptimisticLocking property.- Parameters:
value- allowed object isBoolean
-
isExecuteWithOptimisticLockingExcludeUnversioned
Whether store() and delete() methods should be executed with optimistic locking also on "unversioned" tables, i.e. on tables that do not have a version and/or timestamp column.This flag has no effect when "executeWithOptimisticLocking" is turned off.
- Returns:
- possible object is
Boolean
-
setExecuteWithOptimisticLockingExcludeUnversioned
Sets the value of the executeWithOptimisticLockingExcludeUnversioned property.- Parameters:
value- allowed object isBoolean
-
isAttachRecords
Whether fetched records should be attached to the fetching configuration.- Returns:
- possible object is
Boolean
-
setAttachRecords
Sets the value of the attachRecords property.- Parameters:
value- allowed object isBoolean
-
isInsertUnchangedRecords
WhetherTableRecord.insert()calls should be executed if the record is unchanged. This also affects theINSERTpart ofUpdatableRecord.store()andUpdatableRecord.merge()calls.- Returns:
- possible object is
Boolean
-
setInsertUnchangedRecords
Sets the value of the insertUnchangedRecords property.- Parameters:
value- allowed object isBoolean
-
getUpdateUnchangedRecords
WhetherUpdatableRecord.update()calls should be executed if the record is unchanged. This also affects theUPDATEpart ofUpdatableRecord.store()andUpdatableRecord.merge()calls. -
setUpdateUnchangedRecords
WhetherUpdatableRecord.update()calls should be executed if the record is unchanged. This also affects theUPDATEpart ofUpdatableRecord.store()andUpdatableRecord.merge()calls. -
isUpdatablePrimaryKeys
Whether primary key values are deemed to be "updatable" in jOOQ.Setting this to "true" will allow for updating primary key values through UpdatableRecord.store() and UpdatableRecord.update().
- Returns:
- possible object is
Boolean
-
setUpdatablePrimaryKeys
Sets the value of the updatablePrimaryKeys property.- Parameters:
value- allowed object isBoolean
-
isReflectionCaching
Whether reflection information should be cached in the configuration.- Returns:
- possible object is
Boolean
-
setReflectionCaching
Sets the value of the reflectionCaching property.- Parameters:
value- allowed object isBoolean
-
isCacheRecordMappers
Whether record mappers should be cached in the configuration.- Returns:
- possible object is
Boolean
-
setCacheRecordMappers
Sets the value of the cacheRecordMappers property.- Parameters:
value- allowed object isBoolean
-
isCacheParsingConnection
Whether parsing connection translations should be cached in the configuration.- Returns:
- possible object is
Boolean
-
setCacheParsingConnection
Sets the value of the cacheParsingConnection property.- Parameters:
value- allowed object isBoolean
-
getCacheParsingConnectionLRUCacheSize
The default implementation of the ParsingConnection cache's LRU cache size. -
setCacheParsingConnectionLRUCacheSize
The default implementation of the ParsingConnection cache's LRU cache size. -
isCachePreparedStatementInLoader
Whether JDBCPreparedStatementinstances should be cached in loader API.- Returns:
- possible object is
Boolean
-
setCachePreparedStatementInLoader
Sets the value of the cachePreparedStatementInLoader property.- Parameters:
value- allowed object isBoolean
-
getThrowExceptions
A strategy defining how exceptions from the database / JDBC driver should be propagated -
setThrowExceptions
A strategy defining how exceptions from the database / JDBC driver should be propagated -
isFetchWarnings
Whether warnings should be fetched after each query execution.- Returns:
- possible object is
Boolean
-
setFetchWarnings
Sets the value of the fetchWarnings property.- Parameters:
value- allowed object isBoolean
-
getFetchServerOutputSize
Whether server output should be fetched after each query execution. -
setFetchServerOutputSize
Whether server output should be fetched after each query execution. -
isReturnIdentityOnUpdatableRecord
Whether calls to store(), insert() and update() should return the identity column.- Returns:
- possible object is
Boolean
-
setReturnIdentityOnUpdatableRecord
Sets the value of the returnIdentityOnUpdatableRecord property.- Parameters:
value- allowed object isBoolean
-
isReturnAllOnUpdatableRecord
Whether calls to store(), insert() and update() should return all columns, not just identity columns.Do note that only few databases support this feature. It is supported only in case the INSERT's or UPDATE's RETURNING clause is fully supported, also for non-IDENTITY columns.
- Returns:
- possible object is
Boolean
-
setReturnAllOnUpdatableRecord
Sets the value of the returnAllOnUpdatableRecord property.- Parameters:
value- allowed object isBoolean
-
isReturnRecordToPojo
Whether calls to store(), insert(), update(), and delete() that are called on an UpdatableRecord that is created from a POJO (e.g. in a DAO) should return all Record values to the POJO, including IDENTITY values, and ifreturnAllOnUpdatableRecordis active, also other values.- Returns:
- possible object is
Boolean
-
setReturnRecordToPojo
Sets the value of the returnRecordToPojo property.- Parameters:
value- allowed object isBoolean
-
isMapJPAAnnotations
Whether JPA annotations should be considered by the DefaultRecordMapper.- Returns:
- possible object is
Boolean
-
setMapJPAAnnotations
Sets the value of the mapJPAAnnotations property.- Parameters:
value- allowed object isBoolean
-
isMapRecordComponentParameterNames
Whether constructor parameter names obtained from theRecordcomponent names should be considered by the DefaultRecordMapper.- Returns:
- possible object is
Boolean
-
setMapRecordComponentParameterNames
Sets the value of the mapRecordComponentParameterNames property.- Parameters:
value- allowed object isBoolean
-
isMapConstructorPropertiesParameterNames
Whether constructor parameter names obtained from theConstructorPropertiesannotation should be considered by the DefaultRecordMapper.- Returns:
- possible object is
Boolean
-
setMapConstructorPropertiesParameterNames
Sets the value of the mapConstructorPropertiesParameterNames property.- Parameters:
value- allowed object isBoolean
-
isMapConstructorParameterNames
Whether constructor parameter names obtained via reflection in Java 8+ should be considered by the DefaultRecordMapper. This flag has no effect in Java 6 or 7.- Returns:
- possible object is
Boolean
-
setMapConstructorParameterNames
Sets the value of the mapConstructorParameterNames property.- Parameters:
value- allowed object isBoolean
-
isMapConstructorParameterNamesInKotlin
Whether constructor parameter names obtained via reflection in Kotlin should be considered by the DefaultRecordMapper. This flag has no effect in Java.- Returns:
- possible object is
Boolean
-
setMapConstructorParameterNamesInKotlin
Sets the value of the mapConstructorParameterNamesInKotlin property.- Parameters:
value- allowed object isBoolean
-
getQueryPoolable
The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified. -
setQueryPoolable
The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified. -
getQueryTimeout
The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified. -
setQueryTimeout
The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified. -
getMaxRows
The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified. -
setMaxRows
The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified. -
getFetchSize
The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified. -
setFetchSize
The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified. -
getBatchSize
A property specifying a batch size that should be applied to all automatically createdBatchedConnectioninstances. -
setBatchSize
A property specifying a batch size that should be applied to all automatically createdBatchedConnectioninstances. -
isDebugInfoOnStackTrace
[#5570] Whether exception stack traces should be enhanced with additional debug information.- Returns:
- possible object is
Boolean
-
setDebugInfoOnStackTrace
Sets the value of the debugInfoOnStackTrace property.- Parameters:
value- allowed object isBoolean
-
isInListPadding
[#5600] Whether IN lists in IN predicates should be padded to powers of inListPadBase (default 2).- Returns:
- possible object is
Boolean
-
setInListPadding
Sets the value of the inListPadding property.- Parameters:
value- allowed object isBoolean
-
getInListPadBase
[#7095] The base to use to calculate the powers of when applying in list padding. -
setInListPadBase
[#7095] The base to use to calculate the powers of when applying in list padding. -
getDelimiter
[#5826] The delimiter character to be used to delimit statements in batches. -
setDelimiter
[#5826] The delimiter character to be used to delimit statements in batches. -
isEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly
[#6462] Use only the primary key to emulate MySQL's INSERT .. ON DUPLICATE KEY UPDATE statement. In MySQL, the statement considers all unique keys for duplicates to apply an update rather than an insert. Earlier versions of jOOQ considered only the PRIMARY KEY. This flag can be turned on to maintain backwards compatibility.- Returns:
- possible object is
Boolean
-
setEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly
Sets the value of the emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly property.- Parameters:
value- allowed object isBoolean
-
getEmulateMultiset
[#3884] HowMULTISETsupport should be emulated. -
setEmulateMultiset
[#3884] HowMULTISETsupport should be emulated. -
getExecuteUpdateWithoutWhere
[#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause. This has no effect on rendering the statements SQL string. -
setExecuteUpdateWithoutWhere
[#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause. This has no effect on rendering the statements SQL string. -
getExecuteDeleteWithoutWhere
[#6771] Specifies whether DELETE statements are allowed to be executed lacking a WHERE clause. This has no effect on rendering the statements SQL string. -
setExecuteDeleteWithoutWhere
[#6771] Specifies whether DELETE statements are allowed to be executed lacking a WHERE clause. This has no effect on rendering the statements SQL string. -
getInterpreterDialect
[#7337] The dialect that should be used to interpret SQL DDL statements.SQLDialect.DEFAULTmeans that jOOQ interprets the SQL itself. Any other dialect (if supported) will be interpreted on an actual JDBC connection. -
setInterpreterDialect
[#7337] The dialect that should be used to interpret SQL DDL statements.SQLDialect.DEFAULTmeans that jOOQ interprets the SQL itself. Any other dialect (if supported) will be interpreted on an actual JDBC connection. -
getInterpreterNameLookupCaseSensitivity
[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements. -
setInterpreterNameLookupCaseSensitivity
[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements. -
getInterpreterLocale
The Locale to be used with any interpreter locale dependent logic, defaulting togetLocale(). -
setInterpreterLocale
The Locale to be used with any interpreter locale dependent logic, defaulting togetLocale(). -
isInterpreterDelayForeignKeyDeclarations
Using this flag, the interpreter will be able to delay the addition of foreign key declarations until the end of the interpretation run.- Returns:
- possible object is
Boolean
-
setInterpreterDelayForeignKeyDeclarations
Sets the value of the interpreterDelayForeignKeyDeclarations property.- Parameters:
value- allowed object isBoolean
-
isMetaIncludeSystemIndexes
TheMetaimplementation that is backed byDatabaseMetaDatadoes not produce system generated indexes on constraints, by default.- Returns:
- possible object is
Boolean
-
setMetaIncludeSystemIndexes
Sets the value of the metaIncludeSystemIndexes property.- Parameters:
value- allowed object isBoolean
-
isMetaIncludeSystemSequences
TheMetaimplementation that is backed byDatabaseMetaDatadoes not produce system generated sequences, by default.- Returns:
- possible object is
Boolean
-
setMetaIncludeSystemSequences
Sets the value of the metaIncludeSystemSequences property.- Parameters:
value- allowed object isBoolean
-
isMigrationAllowsUndo
Whether migrations are allowed to be executed in inverse order.This is a potentially destructive feature, which should not be turned on in production. It is useful mostly to quickly switch between branches in a development environment. This feature is available only in commercial distributions.
- Returns:
- possible object is
Boolean
-
setMigrationAllowsUndo
Sets the value of the migrationAllowsUndo property.- Parameters:
value- allowed object isBoolean
-
isMigrationRevertUntracked
Whether migrations revert any untracked changes in the schemas that are being migrated.This is a potentially destructive feature, which should not be turned on in production. It is useful mostly to quickly revert any elements created in a development environment. This feature is available only in commercial distributions.
- Returns:
- possible object is
Boolean
-
setMigrationRevertUntracked
Sets the value of the migrationRevertUntracked property.- Parameters:
value- allowed object isBoolean
-
isMigrationAutoBaseline
Whether to automatically existing schemas that are not yet managed by jOOQ Migrations.- Returns:
- possible object is
Boolean
-
setMigrationAutoBaseline
Sets the value of the migrationAutoBaseline property.- Parameters:
value- allowed object isBoolean
-
isMigrationAutoValidation
Whether a migration automatically runs a validation first.- Returns:
- possible object is
Boolean
-
setMigrationAutoValidation
Sets the value of the migrationAutoValidation property.- Parameters:
value- allowed object isBoolean
-
isMigrationIgnoreDefaultTimestampPrecisionDiffs
VariousmigrateTo()methods (e.g.Meta.migrateTo(org.jooq.Meta)) ignore the difference betweenTIMESTAMPandTIMESTAMP(6), if 6 is the default precision for timestamps on the configured dialect.- Returns:
- possible object is
Boolean
-
setMigrationIgnoreDefaultTimestampPrecisionDiffs
Sets the value of the migrationIgnoreDefaultTimestampPrecisionDiffs property.- Parameters:
value- allowed object isBoolean
-
getLocale
The Locale to be used with any locale dependent logic if there is not a more specific locale available. More specific locales include e.g.getRenderLocale(),getParseLocale(), orgetInterpreterLocale(). -
setLocale
The Locale to be used with any locale dependent logic if there is not a more specific locale available. More specific locales include e.g.getRenderLocale(),getParseLocale(), orgetInterpreterLocale(). -
getParseDialect
[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax. -
setParseDialect
[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax. -
getParseLocale
The Locale to be used with any parser locale dependent logic, defaulting togetLocale(). -
setParseLocale
The Locale to be used with any parser locale dependent logic, defaulting togetLocale(). -
getParseDateFormat
The date format to use when parsing functions whose behaviour depends on some session date format, such as NLS_DATE_FORMAT in Oracle -
setParseDateFormat
The date format to use when parsing functions whose behaviour depends on some session date format, such as NLS_DATE_FORMAT in Oracle -
getParseTimestampFormat
The timestamp format to use when parsing functions whose behaviour depends on some session date format, such as NLS_TIMESTAMP_FORMAT in Oracle -
setParseTimestampFormat
The timestamp format to use when parsing functions whose behaviour depends on some session date format, such as NLS_TIMESTAMP_FORMAT in Oracle -
getParseNamedParamPrefix
The prefix to use for named parameters in parsed SQL.Named parameter syntax defaults to
:name(such as supported by Oracle, JPA, Spring), but vendor specific parameters may look differently. This flag can be used to determine the prefix to be used by named parameters, such as@for SQL Server's@nameor$for PostgreSQL's$namewhen parsing SQL."Named indexed" parameters can be obtained in the same way by specifingy
ParamType#NAMEDand not providing a name to parameters, resulting in:1or@1or$1, etc. -
setParseNamedParamPrefix
The prefix to use for named parameters in parsed SQL.Named parameter syntax defaults to
:name(such as supported by Oracle, JPA, Spring), but vendor specific parameters may look differently. This flag can be used to determine the prefix to be used by named parameters, such as@for SQL Server's@nameor$for PostgreSQL's$namewhen parsing SQL."Named indexed" parameters can be obtained in the same way by specifingy
ParamType#NAMEDand not providing a name to parameters, resulting in:1or@1or$1, etc. -
getParseNameCase
[#7337] The default name case for parsed identifiers. -
setParseNameCase
[#7337] The default name case for parsed identifiers. -
getParseWithMetaLookups
[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider. -
setParseWithMetaLookups
[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider. -
getParseAppendMissingTableReferences
Transform the parsed SQL to append missing table references to the query'sFROMorUSINGclause, if applicable.Teradata (and possibly others) allow for referencing tables that are not listed in the
FROMclause, such asSELECT t.* FROM t WHERE t.i = u.i. This transformation is executed in the parser, to produceSELECT t.* FROM t, u WHERE t.i = u.i, instead. By default, it is active when the input dialect supports this syntax.This feature is available in the commercial distribution only.
-
setParseAppendMissingTableReferences
Transform the parsed SQL to append missing table references to the query'sFROMorUSINGclause, if applicable.Teradata (and possibly others) allow for referencing tables that are not listed in the
FROMclause, such asSELECT t.* FROM t WHERE t.i = u.i. This transformation is executed in the parser, to produceSELECT t.* FROM t, u WHERE t.i = u.i, instead. By default, it is active when the input dialect supports this syntax.This feature is available in the commercial distribution only.
-
isParseSetCommands
[#9780] Whether commands of the typeSET key = valueshould be parsed rather than ignored.- Returns:
- possible object is
Boolean
-
setParseSetCommands
Sets the value of the parseSetCommands property.- Parameters:
value- allowed object isBoolean
-
getParseUnsupportedSyntax
[#5917] Whether the parser should accept unsupported (but known) syntax. -
setParseUnsupportedSyntax
[#5917] Whether the parser should accept unsupported (but known) syntax. -
getParseUnknownFunctions
[#7344] Whether the parser should accept unknown functions. -
setParseUnknownFunctions
[#7344] Whether the parser should accept unknown functions. -
isParseIgnoreCommercialOnlyFeatures
[#13109] Whether the parser of the jOOQ Open Source Edition should ignore commercial only features, rather than failing.- Returns:
- possible object is
Boolean
-
setParseIgnoreCommercialOnlyFeatures
Sets the value of the parseIgnoreCommercialOnlyFeatures property.- Parameters:
value- allowed object isBoolean
-
isParseIgnoreComments
[#8325] Whether the parser should ignore content between ignore comment tokens.- Returns:
- possible object is
Boolean
-
setParseIgnoreComments
Sets the value of the parseIgnoreComments property.- Parameters:
value- allowed object isBoolean
-
getParseIgnoreCommentStart
[#8325] The ignore comment start token -
setParseIgnoreCommentStart
[#8325] The ignore comment start token -
getParseIgnoreCommentStop
[#8325] The ignore comment stop token -
setParseIgnoreCommentStop
[#8325] The ignore comment stop token -
isParseRetainCommentsBetweenQueries
[#12538] Whether the parser should retain comments and whitespace between queries when parsing multiple queries throughParser.parse(String).jOOQ's query object model doesn't have a way to represent comments or other whitespace, and as such, the parser simply skips them by default. However, it may be desirable to retain comments before or in between top level queries, when parsing multiple such queries in a script. Comments inside of queries (including procedural statements) are still not supported.
- Returns:
- possible object is
Boolean
-
setParseRetainCommentsBetweenQueries
Sets the value of the parseRetainCommentsBetweenQueries property.- Parameters:
value- allowed object isBoolean
-
isParseMetaDefaultExpressions
[#8469] Whether to parse default expressions retrieved fromDatabaseMetaData.- Returns:
- possible object is
Boolean
-
setParseMetaDefaultExpressions
Sets the value of the parseMetaDefaultExpressions property.- Parameters:
value- allowed object isBoolean
-
getReadonlyTableRecordInsert
[#9864] The behaviour when trying to insert into readonly columns usingTableRecord.insert(). -
setReadonlyTableRecordInsert
[#9864] The behaviour when trying to insert into readonly columns usingTableRecord.insert(). -
getReadonlyUpdatableRecordUpdate
[#9864] The behaviour when trying to update a readonly column usingUpdatableRecord.update(). -
setReadonlyUpdatableRecordUpdate
[#9864] The behaviour when trying to update a readonly column usingUpdatableRecord.update(). -
getReadonlyInsert
-
setReadonlyInsert
-
getReadonlyUpdate
-
setReadonlyUpdate
-
isApplyWorkaroundFor7962
[#7963] Apply workaround for ORA-04043 when inserting into Oracle tables with qualified, quoted identifiers, and fetching generated keys- Returns:
- possible object is
Boolean
-
setApplyWorkaroundFor7962
Sets the value of the applyWorkaroundFor7962 property.- Parameters:
value- allowed object isBoolean
-
getInterpreterSearchPath
-
setInterpreterSearchPath
-
getMigrationSchemata
-
setMigrationSchemata
-
getParseSearchPath
-
setParseSearchPath
-
withForceIntegerTypesOnZeroScaleDecimals
-
withRenderCatalog
-
withRenderSchema
-
withRenderMapping
Configure render mapping for runtime schema / table rewriting in generated SQL. -
withRenderQuotedNames
Whether rendered schema, table, column names, etc should be quoted.This only affects names created through
DSL.name(String)methods (including those that are implicitly created through this method), notDSL.quotedName(String)orDSL.unquotedName(String), whose behaviour cannot be overridden.This setting does not affect any plain SQL usage.
-
withRenderNameCase
Whether the case ofNamereferences should be modified in any way.Names are modified irrespective of the
getRenderQuotedNames()setting.This setting does not affect any plain SQL usage.
-
withRenderNameStyle
Deprecated.- 3.12.0 - [#5909] - UseRenderQuotedNamesandRenderNameCaseinstead.Whether rendered schema, table, column names, etc should be quoted in rendered SQL, or transformed in any other way.This is set to "QUOTED" by default for backwards-compatibility.
-
withRenderNamedParamPrefix
The prefix to use for named parameters in generated SQL.Named parameter syntax defaults to
:name(such as supported by Oracle, JPA, Spring), but vendor specific parameters may look differently. This flag can be used to determine the prefix to be used by named parameters, such as@for SQL Server's@nameor$for PostgreSQL's$name, when generating SQL."Named indexed" parameters can be obtained in the same way by specifingy
ParamType#NAMEDand not providing a name to parameters, resulting in:1or@1or$1, etc. -
withRenderKeywordCase
Whether the case ofKeywordreferences should be modified in any way. -
withRenderKeywordStyle
Deprecated.- 3.12.0 - [#5909] - UseRenderKeywordCaseinstead.Whether the case ofKeywordreferences should be modified in any way. -
withRenderLocale
The Locale to be used with any render locale dependent logic (as e.g. transforming names to lower / uppper case), defaulting togetLocale(). -
withRenderFormatted
-
withRenderFormatting
All sorts of formatting flags / settings. -
withRenderOptionalAssociativityParentheses
Whether to render optional parentheses to make associativity explicit, e.g.((a + b) + c)instead of (a + b + c). -
withRenderOptionalAsKeywordForTableAliases
Whether to render the optionalASkeyword in table aliases, if it is optional in the output dialect. This is ignored if the keyword is not supported (e.g. in Oracle) -
withRenderOptionalAsKeywordForFieldAliases
Whether to render the optionalASkeyword in table aliases, if it is optional in the output dialect. -
withRenderOptionalInnerKeyword
Whether to render the optionalINNERkeyword inINNER JOIN, if it is optional in the output dialect. -
withRenderOptionalOuterKeyword
Whether to render the optionalOUTERkeyword inOUTER JOIN, if it is optional in the output dialect. -
withRenderImplicitWindowRange
Whether to render an explicit windowRANGEclause when an implicit clause is applied. -
withRenderScalarSubqueriesForStoredFunctions
-
withRenderImplicitJoinType
The join type to be generated by implicit joins. -
withRenderDefaultNullability
Whether theNullability.DEFAULTnullablity should be rendered in generated DDL, and how it should be rendered. -
withRenderCoalesceToEmptyStringInConcat
-
withRenderOrderByRownumberForEmulatedPagination
-
withRenderOutputForSQLServerReturningClause
-
withRenderGroupConcatMaxLenSessionVariable
-
withRenderParenthesisAroundSetOperationQueries
-
withNamePathSeparator
The character(s) to be used as a separator in paths encoded in aNameA few hierarchical mapping features work with paths encoded in names (specifically field aliases), such as the reflective mapping of nested values when aliasing fields as:
SELECT a.first_name AS "book.author.firstName" a.last_name AS "book.author.lastName" FROM ...Not all dialects support "." in identifiers. This setting allows for specifying an alternative String to use as separator, e.g. "__".
-
withBindOffsetDateTimeType
-
withBindOffsetTimeType
-
withFetchTriggerValuesAfterSQLServerOutput
-
withFetchIntermediateResult
Whether to fetch data into intermediateResultinstances.By default, a
ResultQueryproduces no intermediateResultinstances if they are not explicitly requested by the caller, e.g. by callingResultQuery.fetch(), or in the presence ofExecuteListenerinstances, which may require access toExecuteContext.result(). This default behaviour helps avoid unnecessary allocations of possibly large data structures.Using this flag, fetching of intermediate results can be turned off even when execute listeners are present, or turned on even if they're absent.
-
withTransformPatterns
-
withTransformPatternsLogging
-
withTransformPatternsTrim
-
withTransformPatternsNotNot
-
withTransformPatternsNotComparison
-
withTransformPatternsNotNotDistinct
-
withTransformPatternsNormaliseAssociativeOps
-
withTransformPatternsNormaliseInListSingleElementToComparison
-
withTransformPatternsNormaliseFieldCompareValue
-
withTransformPatternsOrEqToIn
-
withTransformPatternsAndNeToNotIn
-
withTransformPatternsMergeOrComparison
-
withTransformPatternsMergeAndComparison
-
withTransformPatternsMergeInLists
-
withTransformPatternsMergeRangePredicates
-
withTransformPatternsMergeBetweenSymmetricPredicates
-
withTransformPatternsTrivialCaseAbbreviation
-
withTransformPatternsTrivialPredicates
-
withTransformPatternsScalarSubqueryCountAsteriskGtZero
-
withTransformPatternsScalarSubqueryCountExpressionGtZero
-
withTransformPatternsEmptyScalarSubquery
-
withTransformPatternsNegNeg
-
withTransformPatternsBitNotBitNot
-
withTransformPatternsBitNotBitNand
-
withTransformPatternsBitNotBitNor
-
withTransformPatternsBitNotBitXNor
-
withTransformPatternsIdempotentFunctionRepetition
-
withTransformPatternsArithmeticExpressions
-
withTransformPatternsTrigonometricFunctions
-
withTransformPatternsLogarithmicFunctions
-
withTransformPatternsHyperbolicFunctions
-
withTransformPatternsInverseHyperbolicFunctions
-
withTransformInlineBindValuesForFieldComparisons
-
withTransformAnsiJoinToTableLists
-
withTransformInConditionSubqueryWithLimitToDerivedTable
Transform a subquery from an IN condition with LIMIT to an equivalent derived table.This transformation works around a known MySQL limitation "ERROR 1235 (42000): This version of MySQL doesn't yet support 'LIMIT & IN/ALL/ANY/SOME subquery'"
This feature is available in the commercial distribution only.
-
withTransformQualify
Transform theQUALIFYclause to an equivalent derived table to filter on window functions.This feature is available in the commercial distribution only.
-
withTransformTableListsToAnsiJoin
-
withTransformRownum
TransformROWNUMexpressions to correspondingLIMITclauses orROW_NUMBER()expressions.In Oracle 11g and less,
ROWNUMfiltering was the most popular way to paginate. This pseudo column is not supported in other RDBMS, and should be replaced in Oracle 12c by the FETCH clause orROW_NUMBER() OVER ()filtering. This transformation allows for replacing such a filter by equivalent SQL, if possible.This feature is available in the commercial distribution only.
-
withTransformUnneededArithmeticExpressions
public Settings withTransformUnneededArithmeticExpressions(TransformUnneededArithmeticExpressions value) Transform arithmetic expressions on literals and bind variables.Arithmetic expressions may be implemented by the user, or arise from emulations from within jOOQ. Expressions on literals and bind variables could be evaluated in the client prior to generating SQL.
This feature is available in the commercial distribution only.
-
withBackslashEscaping
Whether string literals should be escaped with backslash. -
withParamType
Specify how bind variables are to be rendered.Possibilities include: - question marks - named parameters - named or inlined parameters - inlined parameters This value is overridden by statementType == STATIC_STATEMENT, in case of which, this defaults to INLINED
-
withParamCastMode
Whether rendered bind values should be cast to their respective type. -
withStatementType
The type of statement that is to be executed. -
withInlineThreshold
The maximum number of allowed bind variables before inlining all values where0uses the dialect defaults:SQLDialect.ACCESS: 768SQLDialect.ASE: 2000SQLDialect.INGRES: 1024SQLDialect.ORACLE: 32767SQLDialect.POSTGRES: 32767SQLDialect.SQLITE: 999SQLDialect.SQLSERVER: 2100
-
withTransactionListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredTransactionListeners. -
withTransactionListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredTransactionListeners. -
withMigrationListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredMigrationListeners. -
withMigrationListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredMigrationListeners. -
withVisitListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredVisitListeners. -
withVisitListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredVisitListeners. -
withRecordListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredRecordListeners. -
withRecordListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredRecordListeners. -
withExecuteListenerStartInvocationOrder
The order of invocation for [action]start() methods registeredExecuteListeners. -
withExecuteListenerEndInvocationOrder
The order of invocation for [action]end() methods registeredExecuteListeners. -
withExecuteLogging
-
withUpdateRecordVersion
-
withUpdateRecordTimestamp
-
withExecuteWithOptimisticLocking
-
withExecuteWithOptimisticLockingExcludeUnversioned
-
withAttachRecords
-
withInsertUnchangedRecords
-
withUpdateUnchangedRecords
WhetherUpdatableRecord.update()calls should be executed if the record is unchanged. This also affects theUPDATEpart ofUpdatableRecord.store()andUpdatableRecord.merge()calls. -
withUpdatablePrimaryKeys
-
withReflectionCaching
-
withCacheRecordMappers
-
withCacheParsingConnection
-
withCacheParsingConnectionLRUCacheSize
The default implementation of the ParsingConnection cache's LRU cache size. -
withCachePreparedStatementInLoader
-
withThrowExceptions
A strategy defining how exceptions from the database / JDBC driver should be propagated -
withFetchWarnings
-
withFetchServerOutputSize
Whether server output should be fetched after each query execution. -
withReturnIdentityOnUpdatableRecord
-
withReturnAllOnUpdatableRecord
-
withReturnRecordToPojo
-
withMapJPAAnnotations
-
withMapRecordComponentParameterNames
-
withMapConstructorPropertiesParameterNames
-
withMapConstructorParameterNames
-
withMapConstructorParameterNamesInKotlin
-
withQueryPoolable
The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified. -
withQueryTimeout
The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified. -
withMaxRows
The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified. -
withFetchSize
The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified. -
withBatchSize
A property specifying a batch size that should be applied to all automatically createdBatchedConnectioninstances. -
withDebugInfoOnStackTrace
-
withInListPadding
-
withInListPadBase
[#7095] The base to use to calculate the powers of when applying in list padding. -
withDelimiter
[#5826] The delimiter character to be used to delimit statements in batches. -
withEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly
-
withEmulateMultiset
[#3884] HowMULTISETsupport should be emulated. -
withExecuteUpdateWithoutWhere
[#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause. This has no effect on rendering the statements SQL string. -
withExecuteDeleteWithoutWhere
[#6771] Specifies whether DELETE statements are allowed to be executed lacking a WHERE clause. This has no effect on rendering the statements SQL string. -
withInterpreterDialect
[#7337] The dialect that should be used to interpret SQL DDL statements.SQLDialect.DEFAULTmeans that jOOQ interprets the SQL itself. Any other dialect (if supported) will be interpreted on an actual JDBC connection. -
withInterpreterNameLookupCaseSensitivity
public Settings withInterpreterNameLookupCaseSensitivity(InterpreterNameLookupCaseSensitivity value) [#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements. -
withInterpreterLocale
The Locale to be used with any interpreter locale dependent logic, defaulting togetLocale(). -
withInterpreterDelayForeignKeyDeclarations
-
withMetaIncludeSystemIndexes
-
withMetaIncludeSystemSequences
-
withMigrationAllowsUndo
-
withMigrationRevertUntracked
-
withMigrationAutoBaseline
-
withMigrationAutoValidation
-
withMigrationIgnoreDefaultTimestampPrecisionDiffs
-
withLocale
The Locale to be used with any locale dependent logic if there is not a more specific locale available. More specific locales include e.g.getRenderLocale(),getParseLocale(), orgetInterpreterLocale(). -
withParseDialect
[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax. -
withParseLocale
The Locale to be used with any parser locale dependent logic, defaulting togetLocale(). -
withParseDateFormat
The date format to use when parsing functions whose behaviour depends on some session date format, such as NLS_DATE_FORMAT in Oracle -
withParseTimestampFormat
The timestamp format to use when parsing functions whose behaviour depends on some session date format, such as NLS_TIMESTAMP_FORMAT in Oracle -
withParseNamedParamPrefix
The prefix to use for named parameters in parsed SQL.Named parameter syntax defaults to
:name(such as supported by Oracle, JPA, Spring), but vendor specific parameters may look differently. This flag can be used to determine the prefix to be used by named parameters, such as@for SQL Server's@nameor$for PostgreSQL's$namewhen parsing SQL."Named indexed" parameters can be obtained in the same way by specifingy
ParamType#NAMEDand not providing a name to parameters, resulting in:1or@1or$1, etc. -
withParseNameCase
[#7337] The default name case for parsed identifiers. -
withParseWithMetaLookups
[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider. -
withParseAppendMissingTableReferences
Transform the parsed SQL to append missing table references to the query'sFROMorUSINGclause, if applicable.Teradata (and possibly others) allow for referencing tables that are not listed in the
FROMclause, such asSELECT t.* FROM t WHERE t.i = u.i. This transformation is executed in the parser, to produceSELECT t.* FROM t, u WHERE t.i = u.i, instead. By default, it is active when the input dialect supports this syntax.This feature is available in the commercial distribution only.
-
withParseSetCommands
-
withParseUnsupportedSyntax
[#5917] Whether the parser should accept unsupported (but known) syntax. -
withParseUnknownFunctions
[#7344] Whether the parser should accept unknown functions. -
withParseIgnoreCommercialOnlyFeatures
-
withParseIgnoreComments
-
withParseIgnoreCommentStart
[#8325] The ignore comment start token -
withParseIgnoreCommentStop
[#8325] The ignore comment stop token -
withParseRetainCommentsBetweenQueries
-
withParseMetaDefaultExpressions
-
withReadonlyTableRecordInsert
[#9864] The behaviour when trying to insert into readonly columns usingTableRecord.insert(). -
withReadonlyUpdatableRecordUpdate
[#9864] The behaviour when trying to update a readonly column usingUpdatableRecord.update(). -
withReadonlyInsert
-
withReadonlyUpdate
-
withApplyWorkaroundFor7962
-
withInterpreterSearchPath
-
withInterpreterSearchPath
-
withInterpreterSearchPath
-
withMigrationSchemata
-
withMigrationSchemata
-
withMigrationSchemata
-
withParseSearchPath
-
withParseSearchPath
-
withParseSearchPath
-
appendTo
- Specified by:
appendToin interfaceXMLAppendable
-
toString
-
equals
-
hashCode
public int hashCode() -
clone
-
RenderKeywordCaseinstead.