Module org.jooq

Package org.jooq.conf

Class Settings

java.lang.Object

org.jooq.conf.Settings

All Implemented Interfaces:

Serializable, Cloneable, XMLAppendable

public class Settings
extends Object
implements Serializable, Cloneable, XMLAppendable

Settings that influence the way jOOQ renders SQL code.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	applyWorkaroundFor7962
protected Boolean	attachRecords
protected BackslashEscaping	backslashEscaping
protected Integer	batchSize
protected Boolean	bindOffsetDateTimeType
protected Boolean	bindOffsetTimeType
protected Boolean	cacheParsingConnection
protected Integer	cacheParsingConnectionLRUCacheSize
protected Boolean	cachePreparedStatementInLoader
protected Boolean	cacheRecordMappers
protected Boolean	debugInfoOnStackTrace
protected String	delimiter
protected NestedCollectionEmulation	emulateMultiset
protected Boolean	emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly
protected ExecuteWithoutWhere	executeDeleteWithoutWhere
protected InvocationOrder	executeListenerEndInvocationOrder
protected InvocationOrder	executeListenerStartInvocationOrder
protected Boolean	executeLogging
protected ExecuteWithoutWhere	executeUpdateWithoutWhere
protected Boolean	executeWithOptimisticLocking
protected Boolean	executeWithOptimisticLockingExcludeUnversioned
protected FetchIntermediateResult	fetchIntermediateResult
protected Integer	fetchServerOutputSize
protected Integer	fetchSize
protected Boolean	fetchTriggerValuesAfterSQLServerOutput
protected Boolean	fetchWarnings
protected Boolean	forceIntegerTypesOnZeroScaleDecimals
protected Integer	inlineThreshold
protected Integer	inListPadBase
protected Boolean	inListPadding
protected Boolean	insertUnchangedRecords
protected Boolean	interpreterDelayForeignKeyDeclarations
protected SQLDialect	interpreterDialect
protected Locale	interpreterLocale
protected InterpreterNameLookupCaseSensitivity	interpreterNameLookupCaseSensitivity
protected List<InterpreterSearchSchema>	interpreterSearchPath
protected Locale	locale
protected Boolean	mapConstructorParameterNames
protected Boolean	mapConstructorParameterNamesInKotlin
protected Boolean	mapConstructorPropertiesParameterNames
protected Boolean	mapJPAAnnotations
protected Boolean	mapRecordComponentParameterNames
protected Integer	maxRows
protected Boolean	metaIncludeSystemIndexes
protected Boolean	metaIncludeSystemSequences
protected Boolean	migrationAllowsUndo
protected Boolean	migrationAutoBaseline
protected Boolean	migrationAutoValidation
protected Boolean	migrationIgnoreDefaultTimestampPrecisionDiffs
protected InvocationOrder	migrationListenerEndInvocationOrder
protected InvocationOrder	migrationListenerStartInvocationOrder
protected Boolean	migrationRevertUntracked
protected List<MigrationSchema>	migrationSchemata
protected String	namePathSeparator
protected ParamCastMode	paramCastMode
protected ParamType	paramType
protected Transformation	parseAppendMissingTableReferences
protected String	parseDateFormat
protected SQLDialect	parseDialect
protected Boolean	parseIgnoreComments
protected String	parseIgnoreCommentStart
protected String	parseIgnoreCommentStop
protected Locale	parseLocale
protected Boolean	parseMetaDefaultExpressions
protected ParseNameCase	parseNameCase
protected String	parseNamedParamPrefix
protected Boolean	parseRetainCommentsBetweenQueries
protected List<ParseSearchSchema>	parseSearchPath
protected Boolean	parseSetCommands
protected String	parseTimestampFormat
protected ParseUnknownFunctions	parseUnknownFunctions
protected ParseUnsupportedSyntax	parseUnsupportedSyntax
protected ParseWithMetaLookups	parseWithMetaLookups
protected QueryPoolable	queryPoolable
protected Integer	queryTimeout
protected WriteIfReadonly	readonlyInsert
protected WriteIfReadonly	readonlyTableRecordInsert
protected WriteIfReadonly	readonlyUpdatableRecordUpdate
protected WriteIfReadonly	readonlyUpdate
protected InvocationOrder	recordListenerEndInvocationOrder
protected InvocationOrder	recordListenerStartInvocationOrder
protected Boolean	reflectionCaching
protected Boolean	renderCatalog
protected Boolean	renderCoalesceToEmptyStringInConcat
protected RenderDefaultNullability	renderDefaultNullability
protected Boolean	renderFormatted
protected RenderFormatting	renderFormatting
protected Boolean	renderGroupConcatMaxLenSessionVariable
protected RenderImplicitJoinType	renderImplicitJoinType
protected RenderImplicitWindowRange	renderImplicitWindowRange
protected RenderKeywordCase	renderKeywordCase
protected RenderKeywordStyle	renderKeywordStyle
protected Locale	renderLocale
protected RenderMapping	renderMapping
protected RenderNameCase	renderNameCase
protected String	renderNamedParamPrefix
protected RenderNameStyle	renderNameStyle
protected RenderOptionalKeyword	renderOptionalAsKeywordForFieldAliases
protected RenderOptionalKeyword	renderOptionalAsKeywordForTableAliases
protected RenderOptionalKeyword	renderOptionalInnerKeyword
protected RenderOptionalKeyword	renderOptionalOuterKeyword
protected Boolean	renderOrderByRownumberForEmulatedPagination
protected Boolean	renderOutputForSQLServerReturningClause
protected Boolean	renderParenthesisAroundSetOperationQueries
protected RenderQuotedNames	renderQuotedNames
protected Boolean	renderScalarSubqueriesForStoredFunctions
protected Boolean	renderSchema
protected Boolean	returnAllOnUpdatableRecord
protected Boolean	returnIdentityOnUpdatableRecord
protected Boolean	returnRecordToPojo
protected StatementType	statementType
protected ThrowExceptions	throwExceptions
protected InvocationOrder	transactionListenerEndInvocationOrder
protected InvocationOrder	transactionListenerStartInvocationOrder
protected Boolean	transformAnsiJoinToTableLists
protected Transformation	transformInConditionSubqueryWithLimitToDerivedTable
protected Transformation	transformQualify
protected Transformation	transformRownum
protected Boolean	transformTableListsToAnsiJoin
protected TransformUnneededArithmeticExpressions	transformUnneededArithmeticExpressions
protected Boolean	updatablePrimaryKeys
protected Boolean	updateRecordTimestamp
protected Boolean	updateRecordVersion
protected UpdateUnchangedRecords	updateUnchangedRecords
protected InvocationOrder	visitListenerEndInvocationOrder
protected InvocationOrder	visitListenerStartInvocationOrder

Constructor Summary

Constructors

Constructor	Description
Settings()

Method Summary

Modifier and Type	Method	Description
final void	appendTo(XMLBuilder builder)
Object	clone()
boolean	equals(Object that)
BackslashEscaping	getBackslashEscaping()	Whether string literals should be escaped with backslash.
Integer	getBatchSize()	A property specifying a batch size that should be applied to all automatically created BatchedConnection instances.
Integer	getCacheParsingConnectionLRUCacheSize()	The default implementation of the ParsingConnection cache's LRU cache size.
String	getDelimiter()	[#5826] The delimiter character to be used to delimit statements in batches.
NestedCollectionEmulation	getEmulateMultiset()	[#3884] How MULTISET support should be emulated.
ExecuteWithoutWhere	getExecuteDeleteWithoutWhere()	[#6771] Specifies whether DELETE statements are allowed to be executed lacking a WHERE clause.
InvocationOrder	getExecuteListenerEndInvocationOrder()	The order of invocation for [action]end() methods registered ExecuteListeners.
InvocationOrder	getExecuteListenerStartInvocationOrder()	The order of invocation for [action]start() methods registered ExecuteListeners.
ExecuteWithoutWhere	getExecuteUpdateWithoutWhere()	[#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause.
FetchIntermediateResult	getFetchIntermediateResult()	Whether to fetch data into intermediate Result instances.
Integer	getFetchServerOutputSize()	Whether server output should be fetched after each query execution.
Integer	getFetchSize()	The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified.
Integer	getInlineThreshold()	The maximum number of allowed bind variables before inlining all values where 0 uses the dialect defaults: SQLDialect.ACCESS : 768 SQLDialect.ASE : 2000 SQLDialect.INGRES : 1024 SQLDialect.ORACLE : 32767 SQLDialect.POSTGRES : 32767 SQLDialect.SQLITE : 999 SQLDialect.SQLSERVER : 2100
Integer	getInListPadBase()	[#7095] The base to use to calculate the powers of when applying in list padding.
SQLDialect	getInterpreterDialect()	[#7337] The dialect that should be used to interpret SQL DDL statements.
Locale	getInterpreterLocale()	The Locale to be used with any interpreter locale dependent logic, defaulting to getLocale().
InterpreterNameLookupCaseSensitivity	getInterpreterNameLookupCaseSensitivity()	[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements.
List<InterpreterSearchSchema>	getInterpreterSearchPath()
Locale	getLocale()	The Locale to be used with any locale dependent logic if there is not a more specific locale available.
Integer	getMaxRows()	The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified.
InvocationOrder	getMigrationListenerEndInvocationOrder()	The order of invocation for [action]end() methods registered MigrationListeners.
InvocationOrder	getMigrationListenerStartInvocationOrder()	The order of invocation for [action]start() methods registered MigrationListeners.
List<MigrationSchema>	getMigrationSchemata()
String	getNamePathSeparator()	The character(s) to be used as a separator in paths encoded in a Name
ParamCastMode	getParamCastMode()	Whether rendered bind values should be cast to their respective type.
ParamType	getParamType()	Specify how bind variables are to be rendered.
Transformation	getParseAppendMissingTableReferences()	Transform the parsed SQL to append missing table references to the query's FROM or USING clause, if applicable.
String	getParseDateFormat()	The date format to use when parsing functions whose behaviour depends on some session date format, such as NLS_DATE_FORMAT in Oracle
SQLDialect	getParseDialect()	[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.
String	getParseIgnoreCommentStart()	[#8325] The ignore comment start token
String	getParseIgnoreCommentStop()	[#8325] The ignore comment stop token
Locale	getParseLocale()	The Locale to be used with any parser locale dependent logic, defaulting to getLocale().
ParseNameCase	getParseNameCase()	[#7337] The default name case for parsed identifiers.
String	getParseNamedParamPrefix()	The prefix to use for named parameters in parsed SQL.
List<ParseSearchSchema>	getParseSearchPath()
String	getParseTimestampFormat()	The timestamp format to use when parsing functions whose behaviour depends on some session date format, such as NLS_TIMESTAMP_FORMAT in Oracle
ParseUnknownFunctions	getParseUnknownFunctions()	[#7344] Whether the parser should accept unknown functions.
ParseUnsupportedSyntax	getParseUnsupportedSyntax()	[#5917] Whether the parser should accept unsupported (but known) syntax.
ParseWithMetaLookups	getParseWithMetaLookups()	[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider.
QueryPoolable	getQueryPoolable()	The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified.
Integer	getQueryTimeout()	The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified.
WriteIfReadonly	getReadonlyInsert()	[#9864] The behaviour when trying to insert into readonly columns using Insert statements, or the insert clause of a Merge statement.
WriteIfReadonly	getReadonlyTableRecordInsert()	[#9864] The behaviour when trying to insert into readonly columns using TableRecord.insert().
WriteIfReadonly	getReadonlyUpdatableRecordUpdate()	[#9864] The behaviour when trying to update a readonly column using UpdatableRecord.update().
WriteIfReadonly	getReadonlyUpdate()	[#9864] The behaviour when trying to update a readonly column using Update statements, or the update clause of a Merge statement.
InvocationOrder	getRecordListenerEndInvocationOrder()	The order of invocation for [action]end() methods registered RecordListeners.
InvocationOrder	getRecordListenerStartInvocationOrder()	The order of invocation for [action]start() methods registered RecordListeners.
RenderDefaultNullability	getRenderDefaultNullability()	Whether the Nullability.DEFAULT nullablity should be rendered in generated DDL, and how it should be rendered.
RenderFormatting	getRenderFormatting()	All sorts of formatting flags / settings.
RenderImplicitJoinType	getRenderImplicitJoinType()	The join type to be generated by implicit joins.
RenderImplicitWindowRange	getRenderImplicitWindowRange()	Whether to render an explicit window RANGE clause when an implicit clause is applied.
RenderKeywordCase	getRenderKeywordCase()	Whether the case of Keyword references should be modified in any way.
RenderKeywordStyle	getRenderKeywordStyle()	Deprecated. - 3.12.0 - [#5909] - Use RenderKeywordCase instead.
Locale	getRenderLocale()	The Locale to be used with any render locale dependent logic (as e.g.
RenderMapping	getRenderMapping()	Configure render mapping for runtime schema / table rewriting in generated SQL.
RenderNameCase	getRenderNameCase()	Whether the case of Name references should be modified in any way.
String	getRenderNamedParamPrefix()	The prefix to use for named parameters in generated SQL.
RenderNameStyle	getRenderNameStyle()	Deprecated. - 3.12.0 - [#5909] - Use RenderQuotedNames and RenderNameCase instead.
RenderOptionalKeyword	getRenderOptionalAsKeywordForFieldAliases()	Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.
RenderOptionalKeyword	getRenderOptionalAsKeywordForTableAliases()	Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.
RenderOptionalKeyword	getRenderOptionalInnerKeyword()	Whether to render the optional INNER keyword in INNER JOIN, if it is optional in the output dialect.
RenderOptionalKeyword	getRenderOptionalOuterKeyword()	Whether to render the optional OUTER keyword in OUTER JOIN, if it is optional in the output dialect.
RenderQuotedNames	getRenderQuotedNames()	Whether rendered schema, table, column names, etc should be quoted.
StatementType	getStatementType()	The type of statement that is to be executed.
ThrowExceptions	getThrowExceptions()	A strategy defining how exceptions from the database / JDBC driver should be propagated
InvocationOrder	getTransactionListenerEndInvocationOrder()	The order of invocation for [action]end() methods registered TransactionListeners.
InvocationOrder	getTransactionListenerStartInvocationOrder()	The order of invocation for [action]start() methods registered TransactionListeners.
Transformation	getTransformInConditionSubqueryWithLimitToDerivedTable()	Transform a subquery from an IN condition with LIMIT to an equivalent derived table.
Transformation	getTransformQualify()	Transform the QUALIFY clause to an equivalent derived table to filter on window functions.
Transformation	getTransformRownum()	Transform ROWNUM expressions to corresponding LIMIT clauses or ROW_NUMBER() expressions.
TransformUnneededArithmeticExpressions	getTransformUnneededArithmeticExpressions()	Transform arithmetic expressions on literals and bind variables.
UpdateUnchangedRecords	getUpdateUnchangedRecords()	Whether UpdatableRecord.update() calls should be executed if the record is unchanged.
InvocationOrder	getVisitListenerEndInvocationOrder()	The order of invocation for [action]end() methods registered VisitListeners.
InvocationOrder	getVisitListenerStartInvocationOrder()	The order of invocation for [action]start() methods registered VisitListeners.
int	hashCode()
Boolean	isApplyWorkaroundFor7962()	[#7963] Apply workaround for ORA-04043 when inserting into Oracle tables with qualified, quoted identifiers, and fetching generated keys
Boolean	isAttachRecords()	Whether fetched records should be attached to the fetching configuration.
Boolean	isBindOffsetDateTimeType()	Whether the java.time (JSR 310) type OffsetDateTime should be bound natively to JDBC.
Boolean	isBindOffsetTimeType()	Whether the java.time (JSR 310) type OffsetTime should be bound natively to JDBC.
Boolean	isCacheParsingConnection()	Whether parsing connection translations should be cached in the configuration.
Boolean	isCachePreparedStatementInLoader()	Whether JDBC PreparedStatement instances should be cached in loader API.
Boolean	isCacheRecordMappers()	Whether record mappers should be cached in the configuration.
Boolean	isDebugInfoOnStackTrace()	[#5570] Whether exception stack traces should be enhanced with additional debug information.
Boolean	isEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly()	[#6462] Use only the primary key to emulate MySQL's INSERT ..
Boolean	isExecuteLogging()	When set to true, this will add jOOQ's default logging ExecuteListeners.
Boolean	isExecuteWithOptimisticLocking()	Whether store() and delete() methods should be executed with optimistic locking.
Boolean	isExecuteWithOptimisticLockingExcludeUnversioned()	Whether store() and delete() methods should be executed with optimistic locking also on "unversioned" tables, i.e.
Boolean	isFetchTriggerValuesAfterSQLServerOutput()	Fetch trigger values after SQL Server OUTPUT clause.
Boolean	isFetchWarnings()	Whether warnings should be fetched after each query execution.
Boolean	isForceIntegerTypesOnZeroScaleDecimals()	Historically, zero-scale decimal types are generated as their most appropriate, corresponding integer type (e.g.
Boolean	isInListPadding()	[#5600] Whether IN lists in IN predicates should be padded to powers of inListPadBase (default 2).
Boolean	isInsertUnchangedRecords()	Whether TableRecord.insert() calls should be executed if the record is unchanged.
Boolean	isInterpreterDelayForeignKeyDeclarations()	Using this flag, the interpreter will be able to delay the addition of foreign key declarations until the end of the interpretation run.
Boolean	isMapConstructorParameterNames()	Whether constructor parameter names obtained via reflection in Java 8+ should be considered by the DefaultRecordMapper.
Boolean	isMapConstructorParameterNamesInKotlin()	Whether constructor parameter names obtained via reflection in Kotlin should be considered by the DefaultRecordMapper.
Boolean	isMapConstructorPropertiesParameterNames()	Whether constructor parameter names obtained from the ConstructorProperties annotation should be considered by the DefaultRecordMapper.
Boolean	isMapJPAAnnotations()	Whether JPA annotations should be considered by the DefaultRecordMapper.
Boolean	isMapRecordComponentParameterNames()	Whether constructor parameter names obtained from the Record component names should be considered by the DefaultRecordMapper.
Boolean	isMetaIncludeSystemIndexes()	The Meta implementation that is backed by DatabaseMetaData does not produce system generated indexes on constraints, by default.
Boolean	isMetaIncludeSystemSequences()	The Meta implementation that is backed by DatabaseMetaData does not produce system generated sequences, by default.
Boolean	isMigrationAllowsUndo()	Whether migrations are allowed to be executed in inverse order.
Boolean	isMigrationAutoBaseline()	Whether to automatically existing schemas that are not yet managed by jOOQ Migrations.
Boolean	isMigrationAutoValidation()	Whether a migration automatically runs a validation first.
Boolean	isMigrationIgnoreDefaultTimestampPrecisionDiffs()	Various migrateTo() methods (e.g.
Boolean	isMigrationRevertUntracked()	Whether migrations revert any untracked changes in the schemas that are being migrated.
Boolean	isParseIgnoreComments()	[#8325] Whether the parser should ignore content between ignore comment tokens.
Boolean	isParseMetaDefaultExpressions()	[#8469] Whether to parse default expressions retrieved from DatabaseMetaData.
Boolean	isParseRetainCommentsBetweenQueries()	[#12538] Whether the parser should retain comments and whitespace between queries when parsing multiple queries through Parser.parse(String).
Boolean	isParseSetCommands()	[#9780] Whether commands of the type SET key = value should be parsed rather than ignored.
Boolean	isReflectionCaching()	Whether reflection information should be cached in the configuration.
Boolean	isRenderCatalog()	Whether any catalog name should be rendered at all.
Boolean	isRenderCoalesceToEmptyStringInConcat()	Whether stored function calls should be wrapped in scalar subqueries.
Boolean	isRenderFormatted()	Whether rendered SQL should be pretty-printed.
Boolean	isRenderGroupConcatMaxLenSessionVariable()	Whether the jOOQ GROUP_CONCAT function should be overflow-protected by setting the @@group_concat_max_len session variable in MySQL style database systems.
Boolean	isRenderOrderByRownumberForEmulatedPagination()	Whether an additional ORDER BY rn clause should be rendered on emulated paginated queries.
Boolean	isRenderOutputForSQLServerReturningClause()	Whether the jOOQ RETURNING clause should map to SQL Server's OUTPUT clause.
Boolean	isRenderParenthesisAroundSetOperationQueries()	Whether queries combined with set operators (e.g.
Boolean	isRenderScalarSubqueriesForStoredFunctions()	Whether stored function calls should be wrapped in scalar subqueries.
Boolean	isRenderSchema()	Whether any schema name should be rendered at all.
Boolean	isReturnAllOnUpdatableRecord()	Whether calls to store(), insert() and update() should return all columns, not just identity columns.
Boolean	isReturnIdentityOnUpdatableRecord()	Whether calls to store(), insert() and update() should return the identity column.
Boolean	isReturnRecordToPojo()	Whether calls to store(), insert(), update(), and delete() that are called on an UpdatableRecord that is created from a POJO (e.g.
Boolean	isTransformAnsiJoinToTableLists()	Transform ANSI join to table lists if possible.
Boolean	isTransformTableListsToAnsiJoin()	Transform table lists to ANSI join if possible.
Boolean	isUpdatablePrimaryKeys()	Whether primary key values are deemed to be "updatable" in jOOQ.
Boolean	isUpdateRecordTimestamp()	Whether store(), insert(), and update() methods should update the record timestamp prior to the operation, for use with executeWithOptimisticLocking.
Boolean	isUpdateRecordVersion()	Whether store(), insert(), and update() methods should update the record version prior to the operation, for use with executeWithOptimisticLocking.
void	setApplyWorkaroundFor7962(Boolean value)	Sets the value of the applyWorkaroundFor7962 property.
void	setAttachRecords(Boolean value)	Sets the value of the attachRecords property.
void	setBackslashEscaping(BackslashEscaping value)	Whether string literals should be escaped with backslash.
void	setBatchSize(Integer value)	A property specifying a batch size that should be applied to all automatically created BatchedConnection instances.
void	setBindOffsetDateTimeType(Boolean value)	Sets the value of the bindOffsetDateTimeType property.
void	setBindOffsetTimeType(Boolean value)	Sets the value of the bindOffsetTimeType property.
void	setCacheParsingConnection(Boolean value)	Sets the value of the cacheParsingConnection property.
void	setCacheParsingConnectionLRUCacheSize(Integer value)	The default implementation of the ParsingConnection cache's LRU cache size.
void	setCachePreparedStatementInLoader(Boolean value)	Sets the value of the cachePreparedStatementInLoader property.
void	setCacheRecordMappers(Boolean value)	Sets the value of the cacheRecordMappers property.
void	setDebugInfoOnStackTrace(Boolean value)	Sets the value of the debugInfoOnStackTrace property.
void	setDelimiter(String value)	[#5826] The delimiter character to be used to delimit statements in batches.
void	setEmulateMultiset(NestedCollectionEmulation value)	[#3884] How MULTISET support should be emulated.
void	setEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly(Boolean value)	Sets the value of the emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly property.
void	setExecuteDeleteWithoutWhere(ExecuteWithoutWhere value)	[#6771] Specifies whether DELETE statements are allowed to be executed lacking a WHERE clause.
void	setExecuteListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered ExecuteListeners.
void	setExecuteListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered ExecuteListeners.
void	setExecuteLogging(Boolean value)	Sets the value of the executeLogging property.
void	setExecuteUpdateWithoutWhere(ExecuteWithoutWhere value)	[#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause.
void	setExecuteWithOptimisticLocking(Boolean value)	Sets the value of the executeWithOptimisticLocking property.
void	setExecuteWithOptimisticLockingExcludeUnversioned(Boolean value)	Sets the value of the executeWithOptimisticLockingExcludeUnversioned property.
void	setFetchIntermediateResult(FetchIntermediateResult value)	Whether to fetch data into intermediate Result instances.
void	setFetchServerOutputSize(Integer value)	Whether server output should be fetched after each query execution.
void	setFetchSize(Integer value)	The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified.
void	setFetchTriggerValuesAfterSQLServerOutput(Boolean value)	Sets the value of the fetchTriggerValuesAfterSQLServerOutput property.
void	setFetchWarnings(Boolean value)	Sets the value of the fetchWarnings property.
void	setForceIntegerTypesOnZeroScaleDecimals(Boolean value)	Sets the value of the forceIntegerTypesOnZeroScaleDecimals property.
void	setInlineThreshold(Integer value)	The maximum number of allowed bind variables before inlining all values where 0 uses the dialect defaults: SQLDialect.ACCESS : 768 SQLDialect.ASE : 2000 SQLDialect.INGRES : 1024 SQLDialect.ORACLE : 32767 SQLDialect.POSTGRES : 32767 SQLDialect.SQLITE : 999 SQLDialect.SQLSERVER : 2100
void	setInListPadBase(Integer value)	[#7095] The base to use to calculate the powers of when applying in list padding.
void	setInListPadding(Boolean value)	Sets the value of the inListPadding property.
void	setInsertUnchangedRecords(Boolean value)	Sets the value of the insertUnchangedRecords property.
void	setInterpreterDelayForeignKeyDeclarations(Boolean value)	Sets the value of the interpreterDelayForeignKeyDeclarations property.
void	setInterpreterDialect(SQLDialect value)	[#7337] The dialect that should be used to interpret SQL DDL statements.
void	setInterpreterLocale(Locale value)	The Locale to be used with any interpreter locale dependent logic, defaulting to getLocale().
void	setInterpreterNameLookupCaseSensitivity(InterpreterNameLookupCaseSensitivity value)	[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements.
void	setInterpreterSearchPath(List<InterpreterSearchSchema> interpreterSearchPath)
void	setLocale(Locale value)	The Locale to be used with any locale dependent logic if there is not a more specific locale available.
void	setMapConstructorParameterNames(Boolean value)	Sets the value of the mapConstructorParameterNames property.
void	setMapConstructorParameterNamesInKotlin(Boolean value)	Sets the value of the mapConstructorParameterNamesInKotlin property.
void	setMapConstructorPropertiesParameterNames(Boolean value)	Sets the value of the mapConstructorPropertiesParameterNames property.
void	setMapJPAAnnotations(Boolean value)	Sets the value of the mapJPAAnnotations property.
void	setMapRecordComponentParameterNames(Boolean value)	Sets the value of the mapRecordComponentParameterNames property.
void	setMaxRows(Integer value)	The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified.
void	setMetaIncludeSystemIndexes(Boolean value)	Sets the value of the metaIncludeSystemIndexes property.
void	setMetaIncludeSystemSequences(Boolean value)	Sets the value of the metaIncludeSystemSequences property.
void	setMigrationAllowsUndo(Boolean value)	Sets the value of the migrationAllowsUndo property.
void	setMigrationAutoBaseline(Boolean value)	Sets the value of the migrationAutoBaseline property.
void	setMigrationAutoValidation(Boolean value)	Sets the value of the migrationAutoValidation property.
void	setMigrationIgnoreDefaultTimestampPrecisionDiffs(Boolean value)	Sets the value of the migrationIgnoreDefaultTimestampPrecisionDiffs property.
void	setMigrationListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered MigrationListeners.
void	setMigrationListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered MigrationListeners.
void	setMigrationRevertUntracked(Boolean value)	Sets the value of the migrationRevertUntracked property.
void	setMigrationSchemata(List<MigrationSchema> migrationSchemata)
void	setNamePathSeparator(String value)	The character(s) to be used as a separator in paths encoded in a Name
void	setParamCastMode(ParamCastMode value)	Whether rendered bind values should be cast to their respective type.
void	setParamType(ParamType value)	Specify how bind variables are to be rendered.
void	setParseAppendMissingTableReferences(Transformation value)	Transform the parsed SQL to append missing table references to the query's FROM or USING clause, if applicable.
void	setParseDateFormat(String value)	The date format to use when parsing functions whose behaviour depends on some session date format, such as NLS_DATE_FORMAT in Oracle
void	setParseDialect(SQLDialect value)	[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.
void	setParseIgnoreComments(Boolean value)	Sets the value of the parseIgnoreComments property.
void	setParseIgnoreCommentStart(String value)	[#8325] The ignore comment start token
void	setParseIgnoreCommentStop(String value)	[#8325] The ignore comment stop token
void	setParseLocale(Locale value)	The Locale to be used with any parser locale dependent logic, defaulting to getLocale().
void	setParseMetaDefaultExpressions(Boolean value)	Sets the value of the parseMetaDefaultExpressions property.
void	setParseNameCase(ParseNameCase value)	[#7337] The default name case for parsed identifiers.
void	setParseNamedParamPrefix(String value)	The prefix to use for named parameters in parsed SQL.
void	setParseRetainCommentsBetweenQueries(Boolean value)	Sets the value of the parseRetainCommentsBetweenQueries property.
void	setParseSearchPath(List<ParseSearchSchema> parseSearchPath)
void	setParseSetCommands(Boolean value)	Sets the value of the parseSetCommands property.
void	setParseTimestampFormat(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
void	setParseUnknownFunctions(ParseUnknownFunctions value)	[#7344] Whether the parser should accept unknown functions.
void	setParseUnsupportedSyntax(ParseUnsupportedSyntax value)	[#5917] Whether the parser should accept unsupported (but known) syntax.
void	setParseWithMetaLookups(ParseWithMetaLookups value)	[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider.
void	setQueryPoolable(QueryPoolable value)	The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified.
void	setQueryTimeout(Integer value)	The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified.
void	setReadonlyInsert(WriteIfReadonly value)	[#9864] The behaviour when trying to insert into readonly columns using Insert statements, or the insert clause of a Merge statement.
void	setReadonlyTableRecordInsert(WriteIfReadonly value)	[#9864] The behaviour when trying to insert into readonly columns using TableRecord.insert().
void	setReadonlyUpdatableRecordUpdate(WriteIfReadonly value)	[#9864] The behaviour when trying to update a readonly column using UpdatableRecord.update().
void	setReadonlyUpdate(WriteIfReadonly value)	[#9864] The behaviour when trying to update a readonly column using Update statements, or the update clause of a Merge statement.
void	setRecordListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered RecordListeners.
void	setRecordListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered RecordListeners.
void	setReflectionCaching(Boolean value)	Sets the value of the reflectionCaching property.
void	setRenderCatalog(Boolean value)	Sets the value of the renderCatalog property.
void	setRenderCoalesceToEmptyStringInConcat(Boolean value)	Sets the value of the renderCoalesceToEmptyStringInConcat property.
void	setRenderDefaultNullability(RenderDefaultNullability value)	Whether the Nullability.DEFAULT nullablity should be rendered in generated DDL, and how it should be rendered.
void	setRenderFormatted(Boolean value)	Sets the value of the renderFormatted property.
void	setRenderFormatting(RenderFormatting value)	All sorts of formatting flags / settings.
void	setRenderGroupConcatMaxLenSessionVariable(Boolean value)	Sets the value of the renderGroupConcatMaxLenSessionVariable property.
void	setRenderImplicitJoinType(RenderImplicitJoinType value)	The join type to be generated by implicit joins.
void	setRenderImplicitWindowRange(RenderImplicitWindowRange value)	Whether to render an explicit window RANGE clause when an implicit clause is applied.
void	setRenderKeywordCase(RenderKeywordCase value)	Whether the case of Keyword references should be modified in any way.
void	setRenderKeywordStyle(RenderKeywordStyle value)	Deprecated. - 3.12.0 - [#5909] - Use RenderKeywordCase instead.
void	setRenderLocale(Locale value)	The Locale to be used with any render locale dependent logic (as e.g.
void	setRenderMapping(RenderMapping value)	Configure render mapping for runtime schema / table rewriting in generated SQL.
void	setRenderNameCase(RenderNameCase value)	Whether the case of Name references should be modified in any way.
void	setRenderNamedParamPrefix(String value)	The prefix to use for named parameters in generated SQL.
void	setRenderNameStyle(RenderNameStyle value)	Deprecated. - 3.12.0 - [#5909] - Use RenderQuotedNames and RenderNameCase instead.
void	setRenderOptionalAsKeywordForFieldAliases(RenderOptionalKeyword value)	Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.
void	setRenderOptionalAsKeywordForTableAliases(RenderOptionalKeyword value)	Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.
void	setRenderOptionalInnerKeyword(RenderOptionalKeyword value)	Whether to render the optional INNER keyword in INNER JOIN, if it is optional in the output dialect.
void	setRenderOptionalOuterKeyword(RenderOptionalKeyword value)	Whether to render the optional OUTER keyword in OUTER JOIN, if it is optional in the output dialect.
void	setRenderOrderByRownumberForEmulatedPagination(Boolean value)	Sets the value of the renderOrderByRownumberForEmulatedPagination property.
void	setRenderOutputForSQLServerReturningClause(Boolean value)	Sets the value of the renderOutputForSQLServerReturningClause property.
void	setRenderParenthesisAroundSetOperationQueries(Boolean value)	Sets the value of the renderParenthesisAroundSetOperationQueries property.
void	setRenderQuotedNames(RenderQuotedNames value)	Whether rendered schema, table, column names, etc should be quoted.
void	setRenderScalarSubqueriesForStoredFunctions(Boolean value)	Sets the value of the renderScalarSubqueriesForStoredFunctions property.
void	setRenderSchema(Boolean value)	Sets the value of the renderSchema property.
void	setReturnAllOnUpdatableRecord(Boolean value)	Sets the value of the returnAllOnUpdatableRecord property.
void	setReturnIdentityOnUpdatableRecord(Boolean value)	Sets the value of the returnIdentityOnUpdatableRecord property.
void	setReturnRecordToPojo(Boolean value)	Sets the value of the returnRecordToPojo property.
void	setStatementType(StatementType value)	The type of statement that is to be executed.
void	setThrowExceptions(ThrowExceptions value)	A strategy defining how exceptions from the database / JDBC driver should be propagated
void	setTransactionListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered TransactionListeners.
void	setTransactionListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered TransactionListeners.
void	setTransformAnsiJoinToTableLists(Boolean value)	Sets the value of the transformAnsiJoinToTableLists property.
void	setTransformInConditionSubqueryWithLimitToDerivedTable(Transformation value)	Transform a subquery from an IN condition with LIMIT to an equivalent derived table.
void	setTransformQualify(Transformation value)	Transform the QUALIFY clause to an equivalent derived table to filter on window functions.
void	setTransformRownum(Transformation value)	Transform ROWNUM expressions to corresponding LIMIT clauses or ROW_NUMBER() expressions.
void	setTransformTableListsToAnsiJoin(Boolean value)	Sets the value of the transformTableListsToAnsiJoin property.
void	setTransformUnneededArithmeticExpressions(TransformUnneededArithmeticExpressions value)	Transform arithmetic expressions on literals and bind variables.
void	setUpdatablePrimaryKeys(Boolean value)	Sets the value of the updatablePrimaryKeys property.
void	setUpdateRecordTimestamp(Boolean value)	Sets the value of the updateRecordTimestamp property.
void	setUpdateRecordVersion(Boolean value)	Sets the value of the updateRecordVersion property.
void	setUpdateUnchangedRecords(UpdateUnchangedRecords value)	Whether UpdatableRecord.update() calls should be executed if the record is unchanged.
void	setVisitListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered VisitListeners.
void	setVisitListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered VisitListeners.
String	toString()
Settings	withApplyWorkaroundFor7962(Boolean value)
Settings	withAttachRecords(Boolean value)
Settings	withBackslashEscaping(BackslashEscaping value)	Whether string literals should be escaped with backslash.
Settings	withBatchSize(Integer value)	A property specifying a batch size that should be applied to all automatically created BatchedConnection instances.
Settings	withBindOffsetDateTimeType(Boolean value)
Settings	withBindOffsetTimeType(Boolean value)
Settings	withCacheParsingConnection(Boolean value)
Settings	withCacheParsingConnectionLRUCacheSize(Integer value)	The default implementation of the ParsingConnection cache's LRU cache size.
Settings	withCachePreparedStatementInLoader(Boolean value)
Settings	withCacheRecordMappers(Boolean value)
Settings	withDebugInfoOnStackTrace(Boolean value)
Settings	withDelimiter(String value)	[#5826] The delimiter character to be used to delimit statements in batches.
Settings	withEmulateMultiset(NestedCollectionEmulation value)	[#3884] How MULTISET support should be emulated.
Settings	withEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly(Boolean value)
Settings	withExecuteDeleteWithoutWhere(ExecuteWithoutWhere value)	[#6771] Specifies whether DELETE statements are allowed to be executed lacking a WHERE clause.
Settings	withExecuteListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered ExecuteListeners.
Settings	withExecuteListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered ExecuteListeners.
Settings	withExecuteLogging(Boolean value)
Settings	withExecuteUpdateWithoutWhere(ExecuteWithoutWhere value)	[#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause.
Settings	withExecuteWithOptimisticLocking(Boolean value)
Settings	withExecuteWithOptimisticLockingExcludeUnversioned(Boolean value)
Settings	withFetchIntermediateResult(FetchIntermediateResult value)	Whether to fetch data into intermediate Result instances.
Settings	withFetchServerOutputSize(Integer value)	Whether server output should be fetched after each query execution.
Settings	withFetchSize(Integer value)	The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified.
Settings	withFetchTriggerValuesAfterSQLServerOutput(Boolean value)
Settings	withFetchWarnings(Boolean value)
Settings	withForceIntegerTypesOnZeroScaleDecimals(Boolean value)
Settings	withInlineThreshold(Integer value)	The maximum number of allowed bind variables before inlining all values where 0 uses the dialect defaults: SQLDialect.ACCESS : 768 SQLDialect.ASE : 2000 SQLDialect.INGRES : 1024 SQLDialect.ORACLE : 32767 SQLDialect.POSTGRES : 32767 SQLDialect.SQLITE : 999 SQLDialect.SQLSERVER : 2100
Settings	withInListPadBase(Integer value)	[#7095] The base to use to calculate the powers of when applying in list padding.
Settings	withInListPadding(Boolean value)
Settings	withInsertUnchangedRecords(Boolean value)
Settings	withInterpreterDelayForeignKeyDeclarations(Boolean value)
Settings	withInterpreterDialect(SQLDialect value)	[#7337] The dialect that should be used to interpret SQL DDL statements.
Settings	withInterpreterLocale(Locale value)	The Locale to be used with any interpreter locale dependent logic, defaulting to getLocale().
Settings	withInterpreterNameLookupCaseSensitivity(InterpreterNameLookupCaseSensitivity value)	[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements.
Settings	withInterpreterSearchPath(Collection<InterpreterSearchSchema> values)
Settings	withInterpreterSearchPath(List<InterpreterSearchSchema> interpreterSearchPath)
Settings	withInterpreterSearchPath(InterpreterSearchSchema... values)
Settings	withLocale(Locale value)	The Locale to be used with any locale dependent logic if there is not a more specific locale available.
Settings	withMapConstructorParameterNames(Boolean value)
Settings	withMapConstructorParameterNamesInKotlin(Boolean value)
Settings	withMapConstructorPropertiesParameterNames(Boolean value)
Settings	withMapJPAAnnotations(Boolean value)
Settings	withMapRecordComponentParameterNames(Boolean value)
Settings	withMaxRows(Integer value)	The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified.
Settings	withMetaIncludeSystemIndexes(Boolean value)
Settings	withMetaIncludeSystemSequences(Boolean value)
Settings	withMigrationAllowsUndo(Boolean value)
Settings	withMigrationAutoBaseline(Boolean value)
Settings	withMigrationAutoValidation(Boolean value)
Settings	withMigrationIgnoreDefaultTimestampPrecisionDiffs(Boolean value)
Settings	withMigrationListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered MigrationListeners.
Settings	withMigrationListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered MigrationListeners.
Settings	withMigrationRevertUntracked(Boolean value)
Settings	withMigrationSchemata(Collection<MigrationSchema> values)
Settings	withMigrationSchemata(List<MigrationSchema> migrationSchemata)
Settings	withMigrationSchemata(MigrationSchema... values)
Settings	withNamePathSeparator(String value)	The character(s) to be used as a separator in paths encoded in a Name
Settings	withParamCastMode(ParamCastMode value)	Whether rendered bind values should be cast to their respective type.
Settings	withParamType(ParamType value)	Specify how bind variables are to be rendered.
Settings	withParseAppendMissingTableReferences(Transformation value)	Transform the parsed SQL to append missing table references to the query's FROM or USING clause, if applicable.
Settings	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 Oracle
Settings	withParseDialect(SQLDialect value)	[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.
Settings	withParseIgnoreComments(Boolean value)
Settings	withParseIgnoreCommentStart(String value)	[#8325] The ignore comment start token
Settings	withParseIgnoreCommentStop(String value)	[#8325] The ignore comment stop token
Settings	withParseLocale(Locale value)	The Locale to be used with any parser locale dependent logic, defaulting to getLocale().
Settings	withParseMetaDefaultExpressions(Boolean value)
Settings	withParseNameCase(ParseNameCase value)	[#7337] The default name case for parsed identifiers.
Settings	withParseNamedParamPrefix(String value)	The prefix to use for named parameters in parsed SQL.
Settings	withParseRetainCommentsBetweenQueries(Boolean value)
Settings	withParseSearchPath(Collection<ParseSearchSchema> values)
Settings	withParseSearchPath(List<ParseSearchSchema> parseSearchPath)
Settings	withParseSearchPath(ParseSearchSchema... values)
Settings	withParseSetCommands(Boolean value)
Settings	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
Settings	withParseUnknownFunctions(ParseUnknownFunctions value)	[#7344] Whether the parser should accept unknown functions.
Settings	withParseUnsupportedSyntax(ParseUnsupportedSyntax value)	[#5917] Whether the parser should accept unsupported (but known) syntax.
Settings	withParseWithMetaLookups(ParseWithMetaLookups value)	[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider.
Settings	withQueryPoolable(QueryPoolable value)	The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified.
Settings	withQueryTimeout(Integer value)	The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified.
Settings	withReadonlyInsert(WriteIfReadonly value)	[#9864] The behaviour when trying to insert into readonly columns using Insert statements, or the insert clause of a Merge statement.
Settings	withReadonlyTableRecordInsert(WriteIfReadonly value)	[#9864] The behaviour when trying to insert into readonly columns using TableRecord.insert().
Settings	withReadonlyUpdatableRecordUpdate(WriteIfReadonly value)	[#9864] The behaviour when trying to update a readonly column using UpdatableRecord.update().
Settings	withReadonlyUpdate(WriteIfReadonly value)	[#9864] The behaviour when trying to update a readonly column using Update statements, or the update clause of a Merge statement.
Settings	withRecordListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered RecordListeners.
Settings	withRecordListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered RecordListeners.
Settings	withReflectionCaching(Boolean value)
Settings	withRenderCatalog(Boolean value)
Settings	withRenderCoalesceToEmptyStringInConcat(Boolean value)
Settings	withRenderDefaultNullability(RenderDefaultNullability value)	Whether the Nullability.DEFAULT nullablity should be rendered in generated DDL, and how it should be rendered.
Settings	withRenderFormatted(Boolean value)
Settings	withRenderFormatting(RenderFormatting value)	All sorts of formatting flags / settings.
Settings	withRenderGroupConcatMaxLenSessionVariable(Boolean value)
Settings	withRenderImplicitJoinType(RenderImplicitJoinType value)	The join type to be generated by implicit joins.
Settings	withRenderImplicitWindowRange(RenderImplicitWindowRange value)	Whether to render an explicit window RANGE clause when an implicit clause is applied.
Settings	withRenderKeywordCase(RenderKeywordCase value)	Whether the case of Keyword references should be modified in any way.
Settings	withRenderKeywordStyle(RenderKeywordStyle value)	Deprecated. - 3.12.0 - [#5909] - Use RenderKeywordCase instead.
Settings	withRenderLocale(Locale value)	The Locale to be used with any render locale dependent logic (as e.g.
Settings	withRenderMapping(RenderMapping value)	Configure render mapping for runtime schema / table rewriting in generated SQL.
Settings	withRenderNameCase(RenderNameCase value)	Whether the case of Name references should be modified in any way.
Settings	withRenderNamedParamPrefix(String value)	The prefix to use for named parameters in generated SQL.
Settings	withRenderNameStyle(RenderNameStyle value)	Deprecated. - 3.12.0 - [#5909] - Use RenderQuotedNames and RenderNameCase instead.
Settings	withRenderOptionalAsKeywordForFieldAliases(RenderOptionalKeyword value)	Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.
Settings	withRenderOptionalAsKeywordForTableAliases(RenderOptionalKeyword value)	Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.
Settings	withRenderOptionalInnerKeyword(RenderOptionalKeyword value)	Whether to render the optional INNER keyword in INNER JOIN, if it is optional in the output dialect.
Settings	withRenderOptionalOuterKeyword(RenderOptionalKeyword value)	Whether to render the optional OUTER keyword in OUTER JOIN, if it is optional in the output dialect.
Settings	withRenderOrderByRownumberForEmulatedPagination(Boolean value)
Settings	withRenderOutputForSQLServerReturningClause(Boolean value)
Settings	withRenderParenthesisAroundSetOperationQueries(Boolean value)
Settings	withRenderQuotedNames(RenderQuotedNames value)	Whether rendered schema, table, column names, etc should be quoted.
Settings	withRenderScalarSubqueriesForStoredFunctions(Boolean value)
Settings	withRenderSchema(Boolean value)
Settings	withReturnAllOnUpdatableRecord(Boolean value)
Settings	withReturnIdentityOnUpdatableRecord(Boolean value)
Settings	withReturnRecordToPojo(Boolean value)
Settings	withStatementType(StatementType value)	The type of statement that is to be executed.
Settings	withThrowExceptions(ThrowExceptions value)	A strategy defining how exceptions from the database / JDBC driver should be propagated
Settings	withTransactionListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered TransactionListeners.
Settings	withTransactionListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered TransactionListeners.
Settings	withTransformAnsiJoinToTableLists(Boolean value)
Settings	withTransformInConditionSubqueryWithLimitToDerivedTable(Transformation value)	Transform a subquery from an IN condition with LIMIT to an equivalent derived table.
Settings	withTransformQualify(Transformation value)	Transform the QUALIFY clause to an equivalent derived table to filter on window functions.
Settings	withTransformRownum(Transformation value)	Transform ROWNUM expressions to corresponding LIMIT clauses or ROW_NUMBER() expressions.
Settings	withTransformTableListsToAnsiJoin(Boolean value)
Settings	withTransformUnneededArithmeticExpressions(TransformUnneededArithmeticExpressions value)	Transform arithmetic expressions on literals and bind variables.
Settings	withUpdatablePrimaryKeys(Boolean value)
Settings	withUpdateRecordTimestamp(Boolean value)
Settings	withUpdateRecordVersion(Boolean value)
Settings	withUpdateUnchangedRecords(UpdateUnchangedRecords value)	Whether UpdatableRecord.update() calls should be executed if the record is unchanged.
Settings	withVisitListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered VisitListeners.
Settings	withVisitListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered VisitListeners.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

forceIntegerTypesOnZeroScaleDecimals

protected Boolean forceIntegerTypesOnZeroScaleDecimals

renderCatalog

protected Boolean renderCatalog

renderSchema

protected Boolean renderSchema

renderMapping

protected RenderMapping renderMapping

renderQuotedNames

protected RenderQuotedNames renderQuotedNames

renderNameCase

protected RenderNameCase renderNameCase

renderNameStyle

protected RenderNameStyle renderNameStyle

renderNamedParamPrefix

protected String renderNamedParamPrefix

renderKeywordCase

protected RenderKeywordCase renderKeywordCase

renderKeywordStyle

protected RenderKeywordStyle renderKeywordStyle

renderLocale

protected Locale renderLocale

renderFormatted

protected Boolean renderFormatted

renderFormatting

protected RenderFormatting renderFormatting

renderOptionalAsKeywordForTableAliases

protected RenderOptionalKeyword renderOptionalAsKeywordForTableAliases

renderOptionalAsKeywordForFieldAliases

protected RenderOptionalKeyword renderOptionalAsKeywordForFieldAliases

renderOptionalInnerKeyword

protected RenderOptionalKeyword renderOptionalInnerKeyword

renderOptionalOuterKeyword

protected RenderOptionalKeyword renderOptionalOuterKeyword

renderImplicitWindowRange

protected RenderImplicitWindowRange renderImplicitWindowRange

renderScalarSubqueriesForStoredFunctions

protected Boolean renderScalarSubqueriesForStoredFunctions

renderImplicitJoinType

protected RenderImplicitJoinType renderImplicitJoinType

renderDefaultNullability

protected RenderDefaultNullability renderDefaultNullability

renderCoalesceToEmptyStringInConcat

protected Boolean renderCoalesceToEmptyStringInConcat

renderOrderByRownumberForEmulatedPagination

protected Boolean renderOrderByRownumberForEmulatedPagination

renderOutputForSQLServerReturningClause

protected Boolean renderOutputForSQLServerReturningClause

renderGroupConcatMaxLenSessionVariable

protected Boolean renderGroupConcatMaxLenSessionVariable

renderParenthesisAroundSetOperationQueries

protected Boolean renderParenthesisAroundSetOperationQueries

namePathSeparator

protected String namePathSeparator

bindOffsetDateTimeType

protected Boolean bindOffsetDateTimeType

bindOffsetTimeType

protected Boolean bindOffsetTimeType

fetchTriggerValuesAfterSQLServerOutput

protected Boolean fetchTriggerValuesAfterSQLServerOutput

fetchIntermediateResult

protected FetchIntermediateResult fetchIntermediateResult

transformAnsiJoinToTableLists

protected Boolean transformAnsiJoinToTableLists

transformInConditionSubqueryWithLimitToDerivedTable

protected Transformation transformInConditionSubqueryWithLimitToDerivedTable

transformQualify

protected Transformation transformQualify

transformTableListsToAnsiJoin

protected Boolean transformTableListsToAnsiJoin

transformRownum

protected Transformation transformRownum

transformUnneededArithmeticExpressions

protected TransformUnneededArithmeticExpressions transformUnneededArithmeticExpressions

backslashEscaping

protected BackslashEscaping backslashEscaping

paramType

protected ParamType paramType

paramCastMode

protected ParamCastMode paramCastMode

statementType

protected StatementType statementType

inlineThreshold

protected Integer inlineThreshold

transactionListenerStartInvocationOrder

protected InvocationOrder transactionListenerStartInvocationOrder

transactionListenerEndInvocationOrder

protected InvocationOrder transactionListenerEndInvocationOrder

migrationListenerStartInvocationOrder

protected InvocationOrder migrationListenerStartInvocationOrder

migrationListenerEndInvocationOrder

protected InvocationOrder migrationListenerEndInvocationOrder

visitListenerStartInvocationOrder

protected InvocationOrder visitListenerStartInvocationOrder

visitListenerEndInvocationOrder

protected InvocationOrder visitListenerEndInvocationOrder

recordListenerStartInvocationOrder

protected InvocationOrder recordListenerStartInvocationOrder

recordListenerEndInvocationOrder

protected InvocationOrder recordListenerEndInvocationOrder

executeListenerStartInvocationOrder

protected InvocationOrder executeListenerStartInvocationOrder

executeListenerEndInvocationOrder

protected InvocationOrder executeListenerEndInvocationOrder

executeLogging

protected Boolean executeLogging

updateRecordVersion

protected Boolean updateRecordVersion

updateRecordTimestamp

protected Boolean updateRecordTimestamp

executeWithOptimisticLocking

protected Boolean executeWithOptimisticLocking

executeWithOptimisticLockingExcludeUnversioned

protected Boolean executeWithOptimisticLockingExcludeUnversioned

attachRecords

protected Boolean attachRecords

insertUnchangedRecords

protected Boolean insertUnchangedRecords

updateUnchangedRecords

protected UpdateUnchangedRecords updateUnchangedRecords

updatablePrimaryKeys

protected Boolean updatablePrimaryKeys

reflectionCaching

protected Boolean reflectionCaching

cacheRecordMappers

protected Boolean cacheRecordMappers

cacheParsingConnection

protected Boolean cacheParsingConnection

cacheParsingConnectionLRUCacheSize

protected Integer cacheParsingConnectionLRUCacheSize

cachePreparedStatementInLoader

protected Boolean cachePreparedStatementInLoader

throwExceptions

protected ThrowExceptions throwExceptions

fetchWarnings

protected Boolean fetchWarnings

fetchServerOutputSize

protected Integer fetchServerOutputSize

returnIdentityOnUpdatableRecord

protected Boolean returnIdentityOnUpdatableRecord

returnAllOnUpdatableRecord

protected Boolean returnAllOnUpdatableRecord

returnRecordToPojo

protected Boolean returnRecordToPojo

mapJPAAnnotations

protected Boolean mapJPAAnnotations

mapRecordComponentParameterNames

protected Boolean mapRecordComponentParameterNames

mapConstructorPropertiesParameterNames

protected Boolean mapConstructorPropertiesParameterNames

mapConstructorParameterNames

protected Boolean mapConstructorParameterNames

mapConstructorParameterNamesInKotlin

protected Boolean mapConstructorParameterNamesInKotlin

queryPoolable

protected QueryPoolable queryPoolable

queryTimeout

protected Integer queryTimeout

maxRows

protected Integer maxRows

fetchSize

protected Integer fetchSize

batchSize

protected Integer batchSize

debugInfoOnStackTrace

protected Boolean debugInfoOnStackTrace

inListPadding

protected Boolean inListPadding

inListPadBase

protected Integer inListPadBase

delimiter

protected String delimiter

emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly

protected Boolean emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly

emulateMultiset

protected NestedCollectionEmulation emulateMultiset

executeUpdateWithoutWhere

protected ExecuteWithoutWhere executeUpdateWithoutWhere

executeDeleteWithoutWhere

protected ExecuteWithoutWhere executeDeleteWithoutWhere

interpreterDialect

protected SQLDialect interpreterDialect

interpreterNameLookupCaseSensitivity

protected InterpreterNameLookupCaseSensitivity interpreterNameLookupCaseSensitivity

interpreterLocale

protected Locale interpreterLocale

interpreterDelayForeignKeyDeclarations

protected Boolean interpreterDelayForeignKeyDeclarations

metaIncludeSystemIndexes

protected Boolean metaIncludeSystemIndexes

metaIncludeSystemSequences

protected Boolean metaIncludeSystemSequences

migrationAllowsUndo

protected Boolean migrationAllowsUndo

migrationRevertUntracked

protected Boolean migrationRevertUntracked

migrationAutoBaseline

protected Boolean migrationAutoBaseline

migrationAutoValidation

protected Boolean migrationAutoValidation

migrationIgnoreDefaultTimestampPrecisionDiffs

protected Boolean migrationIgnoreDefaultTimestampPrecisionDiffs

locale

protected Locale locale

parseDialect

protected SQLDialect parseDialect

parseLocale

protected Locale parseLocale

parseDateFormat

protected String parseDateFormat

parseTimestampFormat

protected String parseTimestampFormat

parseNamedParamPrefix

protected String parseNamedParamPrefix

parseNameCase

protected ParseNameCase parseNameCase

parseWithMetaLookups

protected ParseWithMetaLookups parseWithMetaLookups

parseAppendMissingTableReferences

protected Transformation parseAppendMissingTableReferences

parseSetCommands

protected Boolean parseSetCommands

parseUnsupportedSyntax

protected ParseUnsupportedSyntax parseUnsupportedSyntax

parseUnknownFunctions

protected ParseUnknownFunctions parseUnknownFunctions

parseIgnoreComments

protected Boolean parseIgnoreComments

parseIgnoreCommentStart

protected String parseIgnoreCommentStart

parseIgnoreCommentStop

protected String parseIgnoreCommentStop

parseRetainCommentsBetweenQueries

protected Boolean parseRetainCommentsBetweenQueries

parseMetaDefaultExpressions

protected Boolean parseMetaDefaultExpressions

readonlyTableRecordInsert

protected WriteIfReadonly readonlyTableRecordInsert

readonlyUpdatableRecordUpdate

protected WriteIfReadonly readonlyUpdatableRecordUpdate

readonlyInsert

protected WriteIfReadonly readonlyInsert

readonlyUpdate

protected WriteIfReadonly readonlyUpdate

applyWorkaroundFor7962

protected Boolean applyWorkaroundFor7962

interpreterSearchPath

protected List<InterpreterSearchSchema> interpreterSearchPath

migrationSchemata

protected List<MigrationSchema> migrationSchemata

parseSearchPath

protected List<ParseSearchSchema> parseSearchPath

Constructor Details

Settings

public Settings()

Method Details

isForceIntegerTypesOnZeroScaleDecimals

public Boolean 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 the Meta API. This flag allows for turning off this feature.

Returns:

possible object is Boolean

setForceIntegerTypesOnZeroScaleDecimals

public void setForceIntegerTypesOnZeroScaleDecimals(Boolean value)

Sets the value of the forceIntegerTypesOnZeroScaleDecimals property.

Parameters:

value - allowed object is Boolean

isRenderCatalog

public Boolean 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

public void setRenderCatalog(Boolean value)

Sets the value of the renderCatalog property.

Parameters:

value - allowed object is Boolean

isRenderSchema

public Boolean 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

public void setRenderSchema(Boolean value)

Sets the value of the renderSchema property.

Parameters:

value - allowed object is Boolean

getRenderMapping

public RenderMapping getRenderMapping()

Configure render mapping for runtime schema / table rewriting in generated SQL.

setRenderMapping

public void setRenderMapping(RenderMapping value)

Configure render mapping for runtime schema / table rewriting in generated SQL.

getRenderQuotedNames

public RenderQuotedNames 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), not DSL.quotedName(String) or DSL.unquotedName(String), whose behaviour cannot be overridden.

This setting does not affect any plain SQL usage.

setRenderQuotedNames

public void setRenderQuotedNames(RenderQuotedNames value)

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), not DSL.quotedName(String) or DSL.unquotedName(String), whose behaviour cannot be overridden.

This setting does not affect any plain SQL usage.

getRenderNameCase

public RenderNameCase getRenderNameCase()

Whether the case of Name references should be modified in any way.

Names are modified irrespective of the getRenderQuotedNames() setting.

This setting does not affect any plain SQL usage.

setRenderNameCase

public void setRenderNameCase(RenderNameCase value)

Whether the case of Name references 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
public RenderNameStyle getRenderNameStyle()

Deprecated.

- 3.12.0 - [#5909] - Use RenderQuotedNames and RenderNameCase instead.

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
public void setRenderNameStyle(RenderNameStyle value)

Deprecated.

- 3.12.0 - [#5909] - Use RenderQuotedNames and RenderNameCase instead.

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

public String 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 @name or $ for PostgreSQL's $name, when generating SQL.

"Named indexed" parameters can be obtained in the same way by specifingy ParamType#NAMED and not providing a name to parameters, resulting in :1 or @1 or $1, etc.

setRenderNamedParamPrefix

public void setRenderNamedParamPrefix(String value)

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 @name or $ for PostgreSQL's $name, when generating SQL.

"Named indexed" parameters can be obtained in the same way by specifingy ParamType#NAMED and not providing a name to parameters, resulting in :1 or @1 or $1, etc.

getRenderKeywordCase

public RenderKeywordCase getRenderKeywordCase()

Whether the case of Keyword references should be modified in any way.

setRenderKeywordCase

public void setRenderKeywordCase(RenderKeywordCase value)

Whether the case of Keyword references should be modified in any way.

getRenderKeywordStyle

@Deprecated
public RenderKeywordStyle getRenderKeywordStyle()

Deprecated.

- 3.12.0 - [#5909] - Use RenderKeywordCase instead.

Whether the case of Keyword references should be modified in any way.

setRenderKeywordStyle

@Deprecated
public void setRenderKeywordStyle(RenderKeywordStyle value)

Deprecated.

- 3.12.0 - [#5909] - Use RenderKeywordCase instead.

Whether the case of Keyword references should be modified in any way.

getRenderLocale

public Locale getRenderLocale()

The Locale to be used with any render locale dependent logic (as e.g. transforming names to lower / uppper case), defaulting to getLocale().

setRenderLocale

public void setRenderLocale(Locale value)

The Locale to be used with any render locale dependent logic (as e.g. transforming names to lower / uppper case), defaulting to getLocale().

isRenderFormatted

public Boolean isRenderFormatted()

Whether rendered SQL should be pretty-printed.

Returns:

possible object is Boolean

setRenderFormatted

public void setRenderFormatted(Boolean value)

Sets the value of the renderFormatted property.

Parameters:

value - allowed object is Boolean

getRenderFormatting

public RenderFormatting getRenderFormatting()

All sorts of formatting flags / settings.

setRenderFormatting

public void setRenderFormatting(RenderFormatting value)

All sorts of formatting flags / settings.

getRenderOptionalAsKeywordForTableAliases

public RenderOptionalKeyword getRenderOptionalAsKeywordForTableAliases()

Whether to render the optional AS keyword 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

public void setRenderOptionalAsKeywordForTableAliases(RenderOptionalKeyword value)

Whether to render the optional AS keyword 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

public RenderOptionalKeyword getRenderOptionalAsKeywordForFieldAliases()

Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.

setRenderOptionalAsKeywordForFieldAliases

public void setRenderOptionalAsKeywordForFieldAliases(RenderOptionalKeyword value)

Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.

getRenderOptionalInnerKeyword

public RenderOptionalKeyword getRenderOptionalInnerKeyword()

Whether to render the optional INNER keyword in INNER JOIN, if it is optional in the output dialect.

setRenderOptionalInnerKeyword

public void setRenderOptionalInnerKeyword(RenderOptionalKeyword value)

Whether to render the optional INNER keyword in INNER JOIN, if it is optional in the output dialect.

getRenderOptionalOuterKeyword

public RenderOptionalKeyword getRenderOptionalOuterKeyword()

Whether to render the optional OUTER keyword in OUTER JOIN, if it is optional in the output dialect.

setRenderOptionalOuterKeyword

public void setRenderOptionalOuterKeyword(RenderOptionalKeyword value)

Whether to render the optional OUTER keyword in OUTER JOIN, if it is optional in the output dialect.

getRenderImplicitWindowRange

public RenderImplicitWindowRange getRenderImplicitWindowRange()

Whether to render an explicit window RANGE clause when an implicit clause is applied.

setRenderImplicitWindowRange

public void setRenderImplicitWindowRange(RenderImplicitWindowRange value)

Whether to render an explicit window RANGE clause when an implicit clause is applied.

isRenderScalarSubqueriesForStoredFunctions

public Boolean 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

public void setRenderScalarSubqueriesForStoredFunctions(Boolean value)

Sets the value of the renderScalarSubqueriesForStoredFunctions property.

Parameters:

value - allowed object is Boolean

getRenderImplicitJoinType

public RenderImplicitJoinType getRenderImplicitJoinType()

The join type to be generated by implicit joins.

setRenderImplicitJoinType

public void setRenderImplicitJoinType(RenderImplicitJoinType value)

The join type to be generated by implicit joins.

getRenderDefaultNullability

public RenderDefaultNullability getRenderDefaultNullability()

Whether the Nullability.DEFAULT nullablity should be rendered in generated DDL, and how it should be rendered.

setRenderDefaultNullability

public void setRenderDefaultNullability(RenderDefaultNullability value)

Whether the Nullability.DEFAULT nullablity should be rendered in generated DDL, and how it should be rendered.

isRenderCoalesceToEmptyStringInConcat

public Boolean 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

public void setRenderCoalesceToEmptyStringInConcat(Boolean value)

Sets the value of the renderCoalesceToEmptyStringInConcat property.

Parameters:

value - allowed object is Boolean

isRenderOrderByRownumberForEmulatedPagination

public Boolean isRenderOrderByRownumberForEmulatedPagination()

Whether an additional ORDER BY rn clause 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) or ROW_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 excess ORDER BY clause may add some additional performance overhead. This setting forces jOOQ to not generate the additional ORDER BY clause.

For details, see https://github.com/jOOQ/jOOQ/issues/7609.

Returns:

possible object is Boolean

setRenderOrderByRownumberForEmulatedPagination

public void setRenderOrderByRownumberForEmulatedPagination(Boolean value)

Sets the value of the renderOrderByRownumberForEmulatedPagination property.

Parameters:

value - allowed object is Boolean

isRenderOutputForSQLServerReturningClause

public Boolean isRenderOutputForSQLServerReturningClause()

Whether the jOOQ RETURNING clause should map to SQL Server's OUTPUT clause.

SQL Server supports an OUTPUT clause in most DML statements, whose behaviour is almost identical to RETURNING in Firebird, Oracle, PostgreSQL. Users who want to prevent jOOQ from rendering this OUTPUT clause can deactivate this flag to revert to jOOQ calling java.sql.Statement#getGeneratedKeys() instead, which is only supported for single row inserts.

This OUTPUT clause does not support fetching trigger generated values. In order to fetch trigger generated values, fetchTriggerValuesAfterSQLServerOutput needs to be enabled as well.

For details, see https://github.com/jOOQ/jOOQ/issues/4498.

Returns:

possible object is Boolean

setRenderOutputForSQLServerReturningClause

public void setRenderOutputForSQLServerReturningClause(Boolean value)

Sets the value of the renderOutputForSQLServerReturningClause property.

Parameters:

value - allowed object is Boolean

isRenderGroupConcatMaxLenSessionVariable

public Boolean isRenderGroupConcatMaxLenSessionVariable()

Whether the jOOQ GROUP_CONCAT function should be overflow-protected by setting the @@group_concat_max_len session variable in MySQL style database systems.

MySQL truncates GROUP_CONCAT results after a certain length, which may be way too small for jOOQ's usage, especially when using the MULTISET emulation. By default, jOOQ sets a session variable to the highest possible value prior to executing a query containing GROUP_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

public void setRenderGroupConcatMaxLenSessionVariable(Boolean value)

Sets the value of the renderGroupConcatMaxLenSessionVariable property.

Parameters:

value - allowed object is Boolean

isRenderParenthesisAroundSetOperationQueries

public Boolean 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 false jOOQ 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 true the 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

public void setRenderParenthesisAroundSetOperationQueries(Boolean value)

Sets the value of the renderParenthesisAroundSetOperationQueries property.

Parameters:

value - allowed object is Boolean

getNamePathSeparator

public String getNamePathSeparator()

The character(s) to be used as a separator in paths encoded in a Name

A 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

public void setNamePathSeparator(String value)

The character(s) to be used as a separator in paths encoded in a Name

A 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

public Boolean isBindOffsetDateTimeType()

Whether the java.time (JSR 310) type OffsetDateTime should be bound natively to JDBC.

Historically, jOOQ encoded the java.time types as strings to offer better compatibility with older JDBC drivers. By now, most drivers should support the java.time types. 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

public void setBindOffsetDateTimeType(Boolean value)

Sets the value of the bindOffsetDateTimeType property.

Parameters:

value - allowed object is Boolean

isBindOffsetTimeType

public Boolean isBindOffsetTimeType()

Whether the java.time (JSR 310) type OffsetTime should be bound natively to JDBC.

Historically, jOOQ encoded the java.time types as strings to offer better compatibility with older JDBC drivers. By now, most drivers should support the java.time types. 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

public void setBindOffsetTimeType(Boolean value)

Sets the value of the bindOffsetTimeType property.

Parameters:

value - allowed object is Boolean

isFetchTriggerValuesAfterSQLServerOutput

public Boolean isFetchTriggerValuesAfterSQLServerOutput()

Fetch trigger values after SQL Server OUTPUT clause.

SQL Server OUTPUT statements do not support fetching trigger generated values. This is a limitation of the renderOutputForSQLServerReturningClause. An additional MERGE statement can run a second query if (and only if) the primary key has been included in the OUTPUT clause.

For details, see https://github.com/jOOQ/jOOQ/issues/4498.

Returns:

possible object is Boolean

setFetchTriggerValuesAfterSQLServerOutput

public void setFetchTriggerValuesAfterSQLServerOutput(Boolean value)

Sets the value of the fetchTriggerValuesAfterSQLServerOutput property.

Parameters:

value - allowed object is Boolean

getFetchIntermediateResult

public FetchIntermediateResult getFetchIntermediateResult()

Whether to fetch data into intermediate Result instances.

By default, a ResultQuery produces no intermediate Result instances if they are not explicitly requested by the caller, e.g. by calling ResultQuery.fetch(), or in the presence of ExecuteListener instances, which may require access to ExecuteContext.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

public void setFetchIntermediateResult(FetchIntermediateResult value)

Whether to fetch data into intermediate Result instances.

By default, a ResultQuery produces no intermediate Result instances if they are not explicitly requested by the caller, e.g. by calling ResultQuery.fetch(), or in the presence of ExecuteListener instances, which may require access to ExecuteContext.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.

isTransformAnsiJoinToTableLists

public Boolean 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

public void setTransformAnsiJoinToTableLists(Boolean value)

Sets the value of the transformAnsiJoinToTableLists property.

Parameters:

value - allowed object is Boolean

getTransformInConditionSubqueryWithLimitToDerivedTable

public Transformation 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

public void setTransformInConditionSubqueryWithLimitToDerivedTable(Transformation value)

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

public Transformation getTransformQualify()

Transform the QUALIFY clause to an equivalent derived table to filter on window functions.

This feature is available in the commercial distribution only.

setTransformQualify

public void setTransformQualify(Transformation value)

Transform the QUALIFY clause to an equivalent derived table to filter on window functions.

This feature is available in the commercial distribution only.

isTransformTableListsToAnsiJoin

public Boolean 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

public void setTransformTableListsToAnsiJoin(Boolean value)

Sets the value of the transformTableListsToAnsiJoin property.

Parameters:

value - allowed object is Boolean

getTransformRownum

public Transformation getTransformRownum()

Transform ROWNUM expressions to corresponding LIMIT clauses or ROW_NUMBER() expressions.

In Oracle 11g and less, ROWNUM filtering 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 or ROW_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

public void setTransformRownum(Transformation value)

Transform ROWNUM expressions to corresponding LIMIT clauses or ROW_NUMBER() expressions.

In Oracle 11g and less, ROWNUM filtering 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 or ROW_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

public TransformUnneededArithmeticExpressions 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

public void setTransformUnneededArithmeticExpressions(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.

getBackslashEscaping

public BackslashEscaping getBackslashEscaping()

Whether string literals should be escaped with backslash.

setBackslashEscaping

public void setBackslashEscaping(BackslashEscaping value)

Whether string literals should be escaped with backslash.

getParamType

public ParamType 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

public void setParamType(ParamType value)

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

public ParamCastMode getParamCastMode()

Whether rendered bind values should be cast to their respective type.

setParamCastMode

public void setParamCastMode(ParamCastMode value)

Whether rendered bind values should be cast to their respective type.

getStatementType

public StatementType getStatementType()

The type of statement that is to be executed.

setStatementType

public void setStatementType(StatementType value)

The type of statement that is to be executed.

getInlineThreshold

public Integer getInlineThreshold()

The maximum number of allowed bind variables before inlining all values where 0 uses the dialect defaults:

• SQLDialect.ACCESS : 768
• SQLDialect.ASE : 2000
• SQLDialect.INGRES : 1024
• SQLDialect.ORACLE : 32767
• SQLDialect.POSTGRES : 32767
• SQLDialect.SQLITE : 999
• SQLDialect.SQLSERVER : 2100

setInlineThreshold

public void setInlineThreshold(Integer value)

The maximum number of allowed bind variables before inlining all values where 0 uses the dialect defaults:

• SQLDialect.ACCESS : 768
• SQLDialect.ASE : 2000
• SQLDialect.INGRES : 1024
• SQLDialect.ORACLE : 32767
• SQLDialect.POSTGRES : 32767
• SQLDialect.SQLITE : 999
• SQLDialect.SQLSERVER : 2100

getTransactionListenerStartInvocationOrder

public InvocationOrder getTransactionListenerStartInvocationOrder()

The order of invocation for [action]start() methods registered TransactionListeners.

setTransactionListenerStartInvocationOrder

public void setTransactionListenerStartInvocationOrder(InvocationOrder value)

The order of invocation for [action]start() methods registered TransactionListeners.

getTransactionListenerEndInvocationOrder

public InvocationOrder getTransactionListenerEndInvocationOrder()

The order of invocation for [action]end() methods registered TransactionListeners.

setTransactionListenerEndInvocationOrder

public void setTransactionListenerEndInvocationOrder(InvocationOrder value)

The order of invocation for [action]end() methods registered TransactionListeners.

getMigrationListenerStartInvocationOrder

public InvocationOrder getMigrationListenerStartInvocationOrder()

The order of invocation for [action]start() methods registered MigrationListeners.

setMigrationListenerStartInvocationOrder

public void setMigrationListenerStartInvocationOrder(InvocationOrder value)

The order of invocation for [action]start() methods registered MigrationListeners.

getMigrationListenerEndInvocationOrder

public InvocationOrder getMigrationListenerEndInvocationOrder()

The order of invocation for [action]end() methods registered MigrationListeners.

setMigrationListenerEndInvocationOrder

public void setMigrationListenerEndInvocationOrder(InvocationOrder value)

The order of invocation for [action]end() methods registered MigrationListeners.

getVisitListenerStartInvocationOrder

public InvocationOrder getVisitListenerStartInvocationOrder()

The order of invocation for [action]start() methods registered VisitListeners.

setVisitListenerStartInvocationOrder

public void setVisitListenerStartInvocationOrder(InvocationOrder value)

The order of invocation for [action]start() methods registered VisitListeners.

getVisitListenerEndInvocationOrder

public InvocationOrder getVisitListenerEndInvocationOrder()

The order of invocation for [action]end() methods registered VisitListeners.

setVisitListenerEndInvocationOrder

public void setVisitListenerEndInvocationOrder(InvocationOrder value)

The order of invocation for [action]end() methods registered VisitListeners.

getRecordListenerStartInvocationOrder

public InvocationOrder getRecordListenerStartInvocationOrder()

The order of invocation for [action]start() methods registered RecordListeners.

setRecordListenerStartInvocationOrder

public void setRecordListenerStartInvocationOrder(InvocationOrder value)

The order of invocation for [action]start() methods registered RecordListeners.

getRecordListenerEndInvocationOrder

public InvocationOrder getRecordListenerEndInvocationOrder()

The order of invocation for [action]end() methods registered RecordListeners.

setRecordListenerEndInvocationOrder

public void setRecordListenerEndInvocationOrder(InvocationOrder value)

The order of invocation for [action]end() methods registered RecordListeners.

getExecuteListenerStartInvocationOrder

public InvocationOrder getExecuteListenerStartInvocationOrder()

The order of invocation for [action]start() methods registered ExecuteListeners.

setExecuteListenerStartInvocationOrder

public void setExecuteListenerStartInvocationOrder(InvocationOrder value)

The order of invocation for [action]start() methods registered ExecuteListeners.

getExecuteListenerEndInvocationOrder

public InvocationOrder getExecuteListenerEndInvocationOrder()

The order of invocation for [action]end() methods registered ExecuteListeners.

setExecuteListenerEndInvocationOrder

public void setExecuteListenerEndInvocationOrder(InvocationOrder value)

The order of invocation for [action]end() methods registered ExecuteListeners.

isExecuteLogging

public Boolean isExecuteLogging()

When set to true, this will add jOOQ's default logging ExecuteListeners.

Returns:

possible object is Boolean

setExecuteLogging

public void setExecuteLogging(Boolean value)

Sets the value of the executeLogging property.

Parameters:

value - allowed object is Boolean

isUpdateRecordVersion

public Boolean isUpdateRecordVersion()

Whether store(), insert(), and update() methods should update the record version prior to the operation, for use with executeWithOptimisticLocking.

Returns:

possible object is Boolean

setUpdateRecordVersion

public void setUpdateRecordVersion(Boolean value)

Sets the value of the updateRecordVersion property.

Parameters:

value - allowed object is Boolean

isUpdateRecordTimestamp

public Boolean isUpdateRecordTimestamp()

Whether store(), insert(), and update() methods should update the record timestamp prior to the operation, for use with executeWithOptimisticLocking.

Returns:

possible object is Boolean

setUpdateRecordTimestamp

public void setUpdateRecordTimestamp(Boolean value)

Sets the value of the updateRecordTimestamp property.

Parameters:

value - allowed object is Boolean

isExecuteWithOptimisticLocking

public Boolean isExecuteWithOptimisticLocking()

Whether store() and delete() methods should be executed with optimistic locking.

Returns:

possible object is Boolean

setExecuteWithOptimisticLocking

public void setExecuteWithOptimisticLocking(Boolean value)

Sets the value of the executeWithOptimisticLocking property.

Parameters:

value - allowed object is Boolean

isExecuteWithOptimisticLockingExcludeUnversioned

public Boolean 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

public void setExecuteWithOptimisticLockingExcludeUnversioned(Boolean value)

Sets the value of the executeWithOptimisticLockingExcludeUnversioned property.

Parameters:

value - allowed object is Boolean

isAttachRecords

public Boolean isAttachRecords()

Whether fetched records should be attached to the fetching configuration.

Returns:

possible object is Boolean

setAttachRecords

public void setAttachRecords(Boolean value)

Sets the value of the attachRecords property.

Parameters:

value - allowed object is Boolean

isInsertUnchangedRecords

public Boolean isInsertUnchangedRecords()

Whether TableRecord.insert() calls should be executed if the record is unchanged. This also affects the INSERT part of UpdatableRecord.store() and UpdatableRecord.merge() calls.

Returns:

possible object is Boolean

setInsertUnchangedRecords

public void setInsertUnchangedRecords(Boolean value)

Sets the value of the insertUnchangedRecords property.

Parameters:

value - allowed object is Boolean

getUpdateUnchangedRecords

public UpdateUnchangedRecords getUpdateUnchangedRecords()

Whether UpdatableRecord.update() calls should be executed if the record is unchanged. This also affects the UPDATE part of UpdatableRecord.store() and UpdatableRecord.merge() calls.

setUpdateUnchangedRecords

public void setUpdateUnchangedRecords(UpdateUnchangedRecords value)

Whether UpdatableRecord.update() calls should be executed if the record is unchanged. This also affects the UPDATE part of UpdatableRecord.store() and UpdatableRecord.merge() calls.

isUpdatablePrimaryKeys

public Boolean 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

public void setUpdatablePrimaryKeys(Boolean value)

Sets the value of the updatablePrimaryKeys property.

Parameters:

value - allowed object is Boolean

isReflectionCaching

public Boolean isReflectionCaching()

Whether reflection information should be cached in the configuration.

Returns:

possible object is Boolean

setReflectionCaching

public void setReflectionCaching(Boolean value)

Sets the value of the reflectionCaching property.

Parameters:

value - allowed object is Boolean

isCacheRecordMappers

public Boolean isCacheRecordMappers()

Whether record mappers should be cached in the configuration.

Returns:

possible object is Boolean

setCacheRecordMappers

public void setCacheRecordMappers(Boolean value)

Sets the value of the cacheRecordMappers property.

Parameters:

value - allowed object is Boolean

isCacheParsingConnection

public Boolean isCacheParsingConnection()

Whether parsing connection translations should be cached in the configuration.

Returns:

possible object is Boolean

setCacheParsingConnection

public void setCacheParsingConnection(Boolean value)

Sets the value of the cacheParsingConnection property.

Parameters:

value - allowed object is Boolean

getCacheParsingConnectionLRUCacheSize

public Integer getCacheParsingConnectionLRUCacheSize()

The default implementation of the ParsingConnection cache's LRU cache size.

setCacheParsingConnectionLRUCacheSize

public void setCacheParsingConnectionLRUCacheSize(Integer value)

The default implementation of the ParsingConnection cache's LRU cache size.

isCachePreparedStatementInLoader

public Boolean isCachePreparedStatementInLoader()

Whether JDBC PreparedStatement instances should be cached in loader API.

Returns:

possible object is Boolean

setCachePreparedStatementInLoader

public void setCachePreparedStatementInLoader(Boolean value)

Sets the value of the cachePreparedStatementInLoader property.

Parameters:

value - allowed object is Boolean

getThrowExceptions

public ThrowExceptions getThrowExceptions()

A strategy defining how exceptions from the database / JDBC driver should be propagated

setThrowExceptions

public void setThrowExceptions(ThrowExceptions value)

A strategy defining how exceptions from the database / JDBC driver should be propagated

isFetchWarnings

public Boolean isFetchWarnings()

Whether warnings should be fetched after each query execution.

Returns:

possible object is Boolean

setFetchWarnings

public void setFetchWarnings(Boolean value)

Sets the value of the fetchWarnings property.

Parameters:

value - allowed object is Boolean

getFetchServerOutputSize

public Integer getFetchServerOutputSize()

Whether server output should be fetched after each query execution.

setFetchServerOutputSize

public void setFetchServerOutputSize(Integer value)

Whether server output should be fetched after each query execution.

isReturnIdentityOnUpdatableRecord

public Boolean isReturnIdentityOnUpdatableRecord()

Whether calls to store(), insert() and update() should return the identity column.

Returns:

possible object is Boolean

setReturnIdentityOnUpdatableRecord

public void setReturnIdentityOnUpdatableRecord(Boolean value)

Sets the value of the returnIdentityOnUpdatableRecord property.

Parameters:

value - allowed object is Boolean

isReturnAllOnUpdatableRecord

public Boolean 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

public void setReturnAllOnUpdatableRecord(Boolean value)

Sets the value of the returnAllOnUpdatableRecord property.

Parameters:

value - allowed object is Boolean

isReturnRecordToPojo

public Boolean 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 if returnAllOnUpdatableRecord is active, also other values.

Returns:

possible object is Boolean

setReturnRecordToPojo

public void setReturnRecordToPojo(Boolean value)

Sets the value of the returnRecordToPojo property.

Parameters:

value - allowed object is Boolean

isMapJPAAnnotations

public Boolean isMapJPAAnnotations()

Whether JPA annotations should be considered by the DefaultRecordMapper.

Returns:

possible object is Boolean

setMapJPAAnnotations

public void setMapJPAAnnotations(Boolean value)

Sets the value of the mapJPAAnnotations property.

Parameters:

value - allowed object is Boolean

isMapRecordComponentParameterNames

public Boolean isMapRecordComponentParameterNames()

Whether constructor parameter names obtained from the Record component names should be considered by the DefaultRecordMapper.

Returns:

possible object is Boolean

setMapRecordComponentParameterNames

public void setMapRecordComponentParameterNames(Boolean value)

Sets the value of the mapRecordComponentParameterNames property.

Parameters:

value - allowed object is Boolean

isMapConstructorPropertiesParameterNames

public Boolean isMapConstructorPropertiesParameterNames()

Whether constructor parameter names obtained from the ConstructorProperties annotation should be considered by the DefaultRecordMapper.

Returns:

possible object is Boolean

setMapConstructorPropertiesParameterNames

public void setMapConstructorPropertiesParameterNames(Boolean value)

Sets the value of the mapConstructorPropertiesParameterNames property.

Parameters:

value - allowed object is Boolean

isMapConstructorParameterNames

public Boolean 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

public void setMapConstructorParameterNames(Boolean value)

Sets the value of the mapConstructorParameterNames property.

Parameters:

value - allowed object is Boolean

isMapConstructorParameterNamesInKotlin

public Boolean 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

public void setMapConstructorParameterNamesInKotlin(Boolean value)

Sets the value of the mapConstructorParameterNamesInKotlin property.

Parameters:

value - allowed object is Boolean

getQueryPoolable

public QueryPoolable getQueryPoolable()

The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified.

setQueryPoolable

public void setQueryPoolable(QueryPoolable value)

The default JDBC poolable property that should be applied to all jOOQ queries, for which no specific poolable flag was specified.

getQueryTimeout

public Integer getQueryTimeout()

The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified.

setQueryTimeout

public void setQueryTimeout(Integer value)

The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified.

getMaxRows

public Integer getMaxRows()

The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified.

setMaxRows

public void setMaxRows(Integer value)

The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified.

getFetchSize

public Integer getFetchSize()

The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified.

setFetchSize

public void setFetchSize(Integer value)

The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified.

getBatchSize

public Integer getBatchSize()

A property specifying a batch size that should be applied to all automatically created BatchedConnection instances.

setBatchSize

public void setBatchSize(Integer value)

A property specifying a batch size that should be applied to all automatically created BatchedConnection instances.

isDebugInfoOnStackTrace

public Boolean isDebugInfoOnStackTrace()

[#5570] Whether exception stack traces should be enhanced with additional debug information.

Returns:

possible object is Boolean

setDebugInfoOnStackTrace

public void setDebugInfoOnStackTrace(Boolean value)

Sets the value of the debugInfoOnStackTrace property.

Parameters:

value - allowed object is Boolean

isInListPadding

public Boolean isInListPadding()

[#5600] Whether IN lists in IN predicates should be padded to powers of inListPadBase (default 2).

Returns:

possible object is Boolean

setInListPadding

public void setInListPadding(Boolean value)

Sets the value of the inListPadding property.

Parameters:

value - allowed object is Boolean

getInListPadBase

public Integer getInListPadBase()

[#7095] The base to use to calculate the powers of when applying in list padding.

setInListPadBase

public void setInListPadBase(Integer value)

[#7095] The base to use to calculate the powers of when applying in list padding.

getDelimiter

public String getDelimiter()

[#5826] The delimiter character to be used to delimit statements in batches.

setDelimiter

public void setDelimiter(String value)

[#5826] The delimiter character to be used to delimit statements in batches.

isEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly

public Boolean 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

public void setEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly(Boolean value)

Sets the value of the emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly property.

Parameters:

value - allowed object is Boolean

getEmulateMultiset

public NestedCollectionEmulation getEmulateMultiset()

[#3884] How MULTISET support should be emulated.

setEmulateMultiset

public void setEmulateMultiset(NestedCollectionEmulation value)

[#3884] How MULTISET support should be emulated.

getExecuteUpdateWithoutWhere

public ExecuteWithoutWhere 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

public void setExecuteUpdateWithoutWhere(ExecuteWithoutWhere value)

[#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

public ExecuteWithoutWhere 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

public void setExecuteDeleteWithoutWhere(ExecuteWithoutWhere value)

[#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

public SQLDialect getInterpreterDialect()

[#7337] The dialect that should be used to interpret SQL DDL statements. SQLDialect.DEFAULT means that jOOQ interprets the SQL itself. Any other dialect (if supported) will be interpreted on an actual JDBC connection.

setInterpreterDialect

public void setInterpreterDialect(SQLDialect value)

[#7337] The dialect that should be used to interpret SQL DDL statements. SQLDialect.DEFAULT means that jOOQ interprets the SQL itself. Any other dialect (if supported) will be interpreted on an actual JDBC connection.

getInterpreterNameLookupCaseSensitivity

public InterpreterNameLookupCaseSensitivity getInterpreterNameLookupCaseSensitivity()

[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements.

setInterpreterNameLookupCaseSensitivity

public void setInterpreterNameLookupCaseSensitivity(InterpreterNameLookupCaseSensitivity value)

[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements.

getInterpreterLocale

public Locale getInterpreterLocale()

The Locale to be used with any interpreter locale dependent logic, defaulting to getLocale().

setInterpreterLocale

public void setInterpreterLocale(Locale value)

The Locale to be used with any interpreter locale dependent logic, defaulting to getLocale().

isInterpreterDelayForeignKeyDeclarations

public Boolean 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

public void setInterpreterDelayForeignKeyDeclarations(Boolean value)

Sets the value of the interpreterDelayForeignKeyDeclarations property.

Parameters:

value - allowed object is Boolean

isMetaIncludeSystemIndexes

public Boolean isMetaIncludeSystemIndexes()

The Meta implementation that is backed by DatabaseMetaData does not produce system generated indexes on constraints, by default.

Returns:

possible object is Boolean

setMetaIncludeSystemIndexes

public void setMetaIncludeSystemIndexes(Boolean value)

Sets the value of the metaIncludeSystemIndexes property.

Parameters:

value - allowed object is Boolean

isMetaIncludeSystemSequences

public Boolean isMetaIncludeSystemSequences()

The Meta implementation that is backed by DatabaseMetaData does not produce system generated sequences, by default.

Returns:

possible object is Boolean

setMetaIncludeSystemSequences

public void setMetaIncludeSystemSequences(Boolean value)

Sets the value of the metaIncludeSystemSequences property.

Parameters:

value - allowed object is Boolean

isMigrationAllowsUndo

public Boolean 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

public void setMigrationAllowsUndo(Boolean value)

Sets the value of the migrationAllowsUndo property.

Parameters:

value - allowed object is Boolean

isMigrationRevertUntracked

public Boolean 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

public void setMigrationRevertUntracked(Boolean value)

Sets the value of the migrationRevertUntracked property.

Parameters:

value - allowed object is Boolean

isMigrationAutoBaseline

public Boolean isMigrationAutoBaseline()

Whether to automatically existing schemas that are not yet managed by jOOQ Migrations.

Returns:

possible object is Boolean

setMigrationAutoBaseline

public void setMigrationAutoBaseline(Boolean value)

Sets the value of the migrationAutoBaseline property.

Parameters:

value - allowed object is Boolean

isMigrationAutoValidation

public Boolean isMigrationAutoValidation()

Whether a migration automatically runs a validation first.

Returns:

possible object is Boolean

setMigrationAutoValidation

public void setMigrationAutoValidation(Boolean value)

Sets the value of the migrationAutoValidation property.

Parameters:

value - allowed object is Boolean

isMigrationIgnoreDefaultTimestampPrecisionDiffs

public Boolean isMigrationIgnoreDefaultTimestampPrecisionDiffs()

Various migrateTo() methods (e.g. Meta.migrateTo(org.jooq.Meta)) ignore the difference between TIMESTAMP and TIMESTAMP(6), if 6 is the default precision for timestamps on the configured dialect.

Returns:

possible object is Boolean

setMigrationIgnoreDefaultTimestampPrecisionDiffs

public void setMigrationIgnoreDefaultTimestampPrecisionDiffs(Boolean value)

Sets the value of the migrationIgnoreDefaultTimestampPrecisionDiffs property.

Parameters:

value - allowed object is Boolean

getLocale

public Locale 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(), or getInterpreterLocale().

setLocale

public void setLocale(Locale value)

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(), or getInterpreterLocale().

getParseDialect

public SQLDialect getParseDialect()

[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.

setParseDialect

public void setParseDialect(SQLDialect value)

[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.

getParseLocale

public Locale getParseLocale()

The Locale to be used with any parser locale dependent logic, defaulting to getLocale().

setParseLocale

public void setParseLocale(Locale value)

The Locale to be used with any parser locale dependent logic, defaulting to getLocale().

getParseDateFormat

public String 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

public void setParseDateFormat(String value)

The date format to use when parsing functions whose behaviour depends on some session date format, such as NLS_DATE_FORMAT in Oracle

getParseTimestampFormat

public String 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

public void setParseTimestampFormat(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

getParseNamedParamPrefix

public String 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 @name or $ for PostgreSQL's $name when parsing SQL.

"Named indexed" parameters can be obtained in the same way by specifingy ParamType#NAMED and not providing a name to parameters, resulting in :1 or @1 or $1, etc.

setParseNamedParamPrefix

public void setParseNamedParamPrefix(String value)

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 @name or $ for PostgreSQL's $name when parsing SQL.

"Named indexed" parameters can be obtained in the same way by specifingy ParamType#NAMED and not providing a name to parameters, resulting in :1 or @1 or $1, etc.

getParseNameCase

public ParseNameCase getParseNameCase()

[#7337] The default name case for parsed identifiers.

setParseNameCase

public void setParseNameCase(ParseNameCase value)

[#7337] The default name case for parsed identifiers.

getParseWithMetaLookups

public ParseWithMetaLookups getParseWithMetaLookups()

[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider.

setParseWithMetaLookups

public void setParseWithMetaLookups(ParseWithMetaLookups value)

[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider.

getParseAppendMissingTableReferences

public Transformation getParseAppendMissingTableReferences()

Transform the parsed SQL to append missing table references to the query's FROM or USING clause, if applicable.

Teradata (and possibly others) allow for referencing tables that are not listed in the FROM clause, such as SELECT t.* FROM t WHERE t.i = u.i. This transformation is executed in the parser, to produce SELECT 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

public void setParseAppendMissingTableReferences(Transformation value)

Transform the parsed SQL to append missing table references to the query's FROM or USING clause, if applicable.

Teradata (and possibly others) allow for referencing tables that are not listed in the FROM clause, such as SELECT t.* FROM t WHERE t.i = u.i. This transformation is executed in the parser, to produce SELECT 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

public Boolean isParseSetCommands()

[#9780] Whether commands of the type SET key = value should be parsed rather than ignored.

Returns:

possible object is Boolean

setParseSetCommands

public void setParseSetCommands(Boolean value)

Sets the value of the parseSetCommands property.

Parameters:

value - allowed object is Boolean

getParseUnsupportedSyntax

public ParseUnsupportedSyntax getParseUnsupportedSyntax()

[#5917] Whether the parser should accept unsupported (but known) syntax.

setParseUnsupportedSyntax

public void setParseUnsupportedSyntax(ParseUnsupportedSyntax value)

[#5917] Whether the parser should accept unsupported (but known) syntax.

getParseUnknownFunctions

public ParseUnknownFunctions getParseUnknownFunctions()

[#7344] Whether the parser should accept unknown functions.

setParseUnknownFunctions

public void setParseUnknownFunctions(ParseUnknownFunctions value)

[#7344] Whether the parser should accept unknown functions.

isParseIgnoreComments

public Boolean isParseIgnoreComments()

[#8325] Whether the parser should ignore content between ignore comment tokens.

Returns:

possible object is Boolean

setParseIgnoreComments

public void setParseIgnoreComments(Boolean value)

Sets the value of the parseIgnoreComments property.

Parameters:

value - allowed object is Boolean

getParseIgnoreCommentStart

public String getParseIgnoreCommentStart()

[#8325] The ignore comment start token

setParseIgnoreCommentStart

public void setParseIgnoreCommentStart(String value)

[#8325] The ignore comment start token

getParseIgnoreCommentStop

public String getParseIgnoreCommentStop()

[#8325] The ignore comment stop token

setParseIgnoreCommentStop

public void setParseIgnoreCommentStop(String value)

[#8325] The ignore comment stop token

isParseRetainCommentsBetweenQueries

public Boolean isParseRetainCommentsBetweenQueries()

[#12538] Whether the parser should retain comments and whitespace between queries when parsing multiple queries through Parser.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

public void setParseRetainCommentsBetweenQueries(Boolean value)

Sets the value of the parseRetainCommentsBetweenQueries property.

Parameters:

value - allowed object is Boolean

isParseMetaDefaultExpressions

public Boolean isParseMetaDefaultExpressions()

[#8469] Whether to parse default expressions retrieved from DatabaseMetaData.

Returns:

possible object is Boolean

setParseMetaDefaultExpressions

public void setParseMetaDefaultExpressions(Boolean value)

Sets the value of the parseMetaDefaultExpressions property.

Parameters:

value - allowed object is Boolean

getReadonlyTableRecordInsert

public WriteIfReadonly getReadonlyTableRecordInsert()

[#9864] The behaviour when trying to insert into readonly columns using TableRecord.insert().

setReadonlyTableRecordInsert

public void setReadonlyTableRecordInsert(WriteIfReadonly value)

[#9864] The behaviour when trying to insert into readonly columns using TableRecord.insert().

getReadonlyUpdatableRecordUpdate

public WriteIfReadonly getReadonlyUpdatableRecordUpdate()

[#9864] The behaviour when trying to update a readonly column using UpdatableRecord.update().

setReadonlyUpdatableRecordUpdate

public void setReadonlyUpdatableRecordUpdate(WriteIfReadonly value)

[#9864] The behaviour when trying to update a readonly column using UpdatableRecord.update().

getReadonlyInsert

public WriteIfReadonly getReadonlyInsert()

[#9864] The behaviour when trying to insert into readonly columns using Insert statements, or the insert clause of a Merge statement.

setReadonlyInsert

public void setReadonlyInsert(WriteIfReadonly value)

[#9864] The behaviour when trying to insert into readonly columns using Insert statements, or the insert clause of a Merge statement.

getReadonlyUpdate

public WriteIfReadonly getReadonlyUpdate()

[#9864] The behaviour when trying to update a readonly column using Update statements, or the update clause of a Merge statement.

setReadonlyUpdate

public void setReadonlyUpdate(WriteIfReadonly value)

[#9864] The behaviour when trying to update a readonly column using Update statements, or the update clause of a Merge statement.

isApplyWorkaroundFor7962

public Boolean 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

public void setApplyWorkaroundFor7962(Boolean value)

Sets the value of the applyWorkaroundFor7962 property.

Parameters:

value - allowed object is Boolean

getInterpreterSearchPath

public List<InterpreterSearchSchema> getInterpreterSearchPath()

setInterpreterSearchPath

public void setInterpreterSearchPath(List<InterpreterSearchSchema> interpreterSearchPath)

getMigrationSchemata

public List<MigrationSchema> getMigrationSchemata()

setMigrationSchemata

public void setMigrationSchemata(List<MigrationSchema> migrationSchemata)

getParseSearchPath

public List<ParseSearchSchema> getParseSearchPath()

setParseSearchPath

public void setParseSearchPath(List<ParseSearchSchema> parseSearchPath)

withForceIntegerTypesOnZeroScaleDecimals

public Settings withForceIntegerTypesOnZeroScaleDecimals(Boolean value)

withRenderCatalog

public Settings withRenderCatalog(Boolean value)

withRenderSchema

public Settings withRenderSchema(Boolean value)

withRenderMapping

public Settings withRenderMapping(RenderMapping value)

Configure render mapping for runtime schema / table rewriting in generated SQL.

withRenderQuotedNames

public Settings withRenderQuotedNames(RenderQuotedNames value)

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), not DSL.quotedName(String) or DSL.unquotedName(String), whose behaviour cannot be overridden.

This setting does not affect any plain SQL usage.

withRenderNameCase

public Settings withRenderNameCase(RenderNameCase value)

Whether the case of Name references 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
public Settings withRenderNameStyle(RenderNameStyle value)

Deprecated.

- 3.12.0 - [#5909] - Use RenderQuotedNames and RenderNameCase instead.

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

public Settings withRenderNamedParamPrefix(String value)

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 @name or $ for PostgreSQL's $name, when generating SQL.

"Named indexed" parameters can be obtained in the same way by specifingy ParamType#NAMED and not providing a name to parameters, resulting in :1 or @1 or $1, etc.

withRenderKeywordCase

public Settings withRenderKeywordCase(RenderKeywordCase value)

Whether the case of Keyword references should be modified in any way.

withRenderKeywordStyle

@Deprecated
public Settings withRenderKeywordStyle(RenderKeywordStyle value)

Deprecated.

- 3.12.0 - [#5909] - Use RenderKeywordCase instead.

Whether the case of Keyword references should be modified in any way.

withRenderLocale

public Settings withRenderLocale(Locale value)

The Locale to be used with any render locale dependent logic (as e.g. transforming names to lower / uppper case), defaulting to getLocale().

withRenderFormatted

public Settings withRenderFormatted(Boolean value)

withRenderFormatting

public Settings withRenderFormatting(RenderFormatting value)

All sorts of formatting flags / settings.

withRenderOptionalAsKeywordForTableAliases

public Settings withRenderOptionalAsKeywordForTableAliases(RenderOptionalKeyword value)

Whether to render the optional AS keyword 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

public Settings withRenderOptionalAsKeywordForFieldAliases(RenderOptionalKeyword value)

Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.

withRenderOptionalInnerKeyword

public Settings withRenderOptionalInnerKeyword(RenderOptionalKeyword value)

Whether to render the optional INNER keyword in INNER JOIN, if it is optional in the output dialect.

withRenderOptionalOuterKeyword

public Settings withRenderOptionalOuterKeyword(RenderOptionalKeyword value)

Whether to render the optional OUTER keyword in OUTER JOIN, if it is optional in the output dialect.

withRenderImplicitWindowRange

public Settings withRenderImplicitWindowRange(RenderImplicitWindowRange value)

Whether to render an explicit window RANGE clause when an implicit clause is applied.

withRenderScalarSubqueriesForStoredFunctions

public Settings withRenderScalarSubqueriesForStoredFunctions(Boolean value)

withRenderImplicitJoinType

public Settings withRenderImplicitJoinType(RenderImplicitJoinType value)

The join type to be generated by implicit joins.

withRenderDefaultNullability

public Settings withRenderDefaultNullability(RenderDefaultNullability value)

Whether the Nullability.DEFAULT nullablity should be rendered in generated DDL, and how it should be rendered.

withRenderCoalesceToEmptyStringInConcat

public Settings withRenderCoalesceToEmptyStringInConcat(Boolean value)

withRenderOrderByRownumberForEmulatedPagination

public Settings withRenderOrderByRownumberForEmulatedPagination(Boolean value)

withRenderOutputForSQLServerReturningClause

public Settings withRenderOutputForSQLServerReturningClause(Boolean value)

withRenderGroupConcatMaxLenSessionVariable

public Settings withRenderGroupConcatMaxLenSessionVariable(Boolean value)

withRenderParenthesisAroundSetOperationQueries

public Settings withRenderParenthesisAroundSetOperationQueries(Boolean value)

withNamePathSeparator

public Settings withNamePathSeparator(String value)

The character(s) to be used as a separator in paths encoded in a Name

A 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

public Settings withBindOffsetDateTimeType(Boolean value)

withBindOffsetTimeType

public Settings withBindOffsetTimeType(Boolean value)

withFetchTriggerValuesAfterSQLServerOutput

public Settings withFetchTriggerValuesAfterSQLServerOutput(Boolean value)

withFetchIntermediateResult

public Settings withFetchIntermediateResult(FetchIntermediateResult value)

Whether to fetch data into intermediate Result instances.

By default, a ResultQuery produces no intermediate Result instances if they are not explicitly requested by the caller, e.g. by calling ResultQuery.fetch(), or in the presence of ExecuteListener instances, which may require access to ExecuteContext.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.

withTransformAnsiJoinToTableLists

public Settings withTransformAnsiJoinToTableLists(Boolean value)

withTransformInConditionSubqueryWithLimitToDerivedTable

public Settings withTransformInConditionSubqueryWithLimitToDerivedTable(Transformation value)

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

public Settings withTransformQualify(Transformation value)

Transform the QUALIFY clause to an equivalent derived table to filter on window functions.

This feature is available in the commercial distribution only.

withTransformTableListsToAnsiJoin

public Settings withTransformTableListsToAnsiJoin(Boolean value)

withTransformRownum

public Settings withTransformRownum(Transformation value)

Transform ROWNUM expressions to corresponding LIMIT clauses or ROW_NUMBER() expressions.

In Oracle 11g and less, ROWNUM filtering 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 or ROW_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

public Settings withBackslashEscaping(BackslashEscaping value)

Whether string literals should be escaped with backslash.

withParamType

public Settings withParamType(ParamType value)

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

public Settings withParamCastMode(ParamCastMode value)

Whether rendered bind values should be cast to their respective type.

withStatementType

public Settings withStatementType(StatementType value)

The type of statement that is to be executed.

withInlineThreshold

public Settings withInlineThreshold(Integer value)

The maximum number of allowed bind variables before inlining all values where 0 uses the dialect defaults:

• SQLDialect.ACCESS : 768
• SQLDialect.ASE : 2000
• SQLDialect.INGRES : 1024
• SQLDialect.ORACLE : 32767
• SQLDialect.POSTGRES : 32767
• SQLDialect.SQLITE : 999
• SQLDialect.SQLSERVER : 2100

withTransactionListenerStartInvocationOrder

public Settings withTransactionListenerStartInvocationOrder(InvocationOrder value)

The order of invocation for [action]start() methods registered TransactionListeners.

withTransactionListenerEndInvocationOrder

public Settings withTransactionListenerEndInvocationOrder(InvocationOrder value)

The order of invocation for [action]end() methods registered TransactionListeners.

withMigrationListenerStartInvocationOrder

public Settings withMigrationListenerStartInvocationOrder(InvocationOrder value)

The order of invocation for [action]start() methods registered MigrationListeners.

withMigrationListenerEndInvocationOrder

public Settings withMigrationListenerEndInvocationOrder(InvocationOrder value)

The order of invocation for [action]end() methods registered MigrationListeners.

withVisitListenerStartInvocationOrder

public Settings withVisitListenerStartInvocationOrder(InvocationOrder value)

The order of invocation for [action]start() methods registered VisitListeners.

withVisitListenerEndInvocationOrder

public Settings withVisitListenerEndInvocationOrder(InvocationOrder value)

The order of invocation for [action]end() methods registered VisitListeners.

withRecordListenerStartInvocationOrder

public Settings withRecordListenerStartInvocationOrder(InvocationOrder value)

The order of invocation for [action]start() methods registered RecordListeners.

withRecordListenerEndInvocationOrder

public Settings withRecordListenerEndInvocationOrder(InvocationOrder value)

The order of invocation for [action]end() methods registered RecordListeners.

withExecuteListenerStartInvocationOrder

public Settings withExecuteListenerStartInvocationOrder(InvocationOrder value)

The order of invocation for [action]start() methods registered ExecuteListeners.

withExecuteListenerEndInvocationOrder

public Settings withExecuteListenerEndInvocationOrder(InvocationOrder value)

The order of invocation for [action]end() methods registered ExecuteListeners.

withExecuteLogging

public Settings withExecuteLogging(Boolean value)

withUpdateRecordVersion

public Settings withUpdateRecordVersion(Boolean value)

withUpdateRecordTimestamp

public Settings withUpdateRecordTimestamp(Boolean value)

withExecuteWithOptimisticLocking

public Settings withExecuteWithOptimisticLocking(Boolean value)

withExecuteWithOptimisticLockingExcludeUnversioned

public Settings withExecuteWithOptimisticLockingExcludeUnversioned(Boolean value)

withAttachRecords

public Settings withAttachRecords(Boolean value)

withInsertUnchangedRecords

public Settings withInsertUnchangedRecords(Boolean value)

withUpdateUnchangedRecords

public Settings withUpdateUnchangedRecords(UpdateUnchangedRecords value)

Whether UpdatableRecord.update() calls should be executed if the record is unchanged. This also affects the UPDATE part of UpdatableRecord.store() and UpdatableRecord.merge() calls.

withUpdatablePrimaryKeys

public Settings withUpdatablePrimaryKeys(Boolean value)

withReflectionCaching

public Settings withReflectionCaching(Boolean value)

withCacheRecordMappers

public Settings withCacheRecordMappers(Boolean value)

withCacheParsingConnection

public Settings withCacheParsingConnection(Boolean value)

withCacheParsingConnectionLRUCacheSize

public Settings withCacheParsingConnectionLRUCacheSize(Integer value)

The default implementation of the ParsingConnection cache's LRU cache size.

withCachePreparedStatementInLoader

public Settings withCachePreparedStatementInLoader(Boolean value)

withThrowExceptions

public Settings withThrowExceptions(ThrowExceptions value)

A strategy defining how exceptions from the database / JDBC driver should be propagated

withFetchWarnings

public Settings withFetchWarnings(Boolean value)

withFetchServerOutputSize

public Settings withFetchServerOutputSize(Integer value)

Whether server output should be fetched after each query execution.

withReturnIdentityOnUpdatableRecord

public Settings withReturnIdentityOnUpdatableRecord(Boolean value)

withReturnAllOnUpdatableRecord

public Settings withReturnAllOnUpdatableRecord(Boolean value)

withReturnRecordToPojo

public Settings withReturnRecordToPojo(Boolean value)

withMapJPAAnnotations

public Settings withMapJPAAnnotations(Boolean value)

withMapRecordComponentParameterNames

public Settings withMapRecordComponentParameterNames(Boolean value)

withMapConstructorPropertiesParameterNames

public Settings withMapConstructorPropertiesParameterNames(Boolean value)

withMapConstructorParameterNames

public Settings withMapConstructorParameterNames(Boolean value)

withMapConstructorParameterNamesInKotlin

public Settings withMapConstructorParameterNamesInKotlin(Boolean value)

withQueryPoolable

public Settings 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

public Settings withQueryTimeout(Integer value)

The default JDBC queryTimeout property that should be applied to all jOOQ queries, for which no specific queryTimeout was specified.

withMaxRows

public Settings withMaxRows(Integer value)

The default JDBC maxRows property that should be applied to all jOOQ queries, for which no specific maxRows value was specified.

withFetchSize

public Settings withFetchSize(Integer value)

The default JDBC fetchSize property that should be applied to all jOOQ queries, for which no specific fetchSize value was specified.

withBatchSize

public Settings withBatchSize(Integer value)

A property specifying a batch size that should be applied to all automatically created BatchedConnection instances.

withDebugInfoOnStackTrace

public Settings withDebugInfoOnStackTrace(Boolean value)

withInListPadding

public Settings withInListPadding(Boolean value)

withInListPadBase

public Settings withInListPadBase(Integer value)

[#7095] The base to use to calculate the powers of when applying in list padding.

withDelimiter

public Settings withDelimiter(String value)

[#5826] The delimiter character to be used to delimit statements in batches.

withEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly

public Settings withEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly(Boolean value)

withEmulateMultiset

public Settings withEmulateMultiset(NestedCollectionEmulation value)

[#3884] How MULTISET support should be emulated.

withExecuteUpdateWithoutWhere

public Settings withExecuteUpdateWithoutWhere(ExecuteWithoutWhere value)

[#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

public Settings withExecuteDeleteWithoutWhere(ExecuteWithoutWhere value)

[#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

public Settings withInterpreterDialect(SQLDialect value)

[#7337] The dialect that should be used to interpret SQL DDL statements. SQLDialect.DEFAULT means 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

public Settings withInterpreterLocale(Locale value)

The Locale to be used with any interpreter locale dependent logic, defaulting to getLocale().

withInterpreterDelayForeignKeyDeclarations

public Settings withInterpreterDelayForeignKeyDeclarations(Boolean value)

withMetaIncludeSystemIndexes

public Settings withMetaIncludeSystemIndexes(Boolean value)

withMetaIncludeSystemSequences

public Settings withMetaIncludeSystemSequences(Boolean value)

withMigrationAllowsUndo

public Settings withMigrationAllowsUndo(Boolean value)

withMigrationRevertUntracked

public Settings withMigrationRevertUntracked(Boolean value)

withMigrationAutoBaseline

public Settings withMigrationAutoBaseline(Boolean value)

withMigrationAutoValidation

public Settings withMigrationAutoValidation(Boolean value)

withMigrationIgnoreDefaultTimestampPrecisionDiffs

public Settings withMigrationIgnoreDefaultTimestampPrecisionDiffs(Boolean value)

withLocale

public Settings withLocale(Locale value)

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(), or getInterpreterLocale().

withParseDialect

public Settings withParseDialect(SQLDialect value)

[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.

withParseLocale

public Settings withParseLocale(Locale value)

The Locale to be used with any parser locale dependent logic, defaulting to getLocale().

withParseDateFormat

public Settings 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 Oracle

withParseTimestampFormat

public Settings 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

withParseNamedParamPrefix

public Settings withParseNamedParamPrefix(String value)

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 @name or $ for PostgreSQL's $name when parsing SQL.

"Named indexed" parameters can be obtained in the same way by specifingy ParamType#NAMED and not providing a name to parameters, resulting in :1 or @1 or $1, etc.

withParseNameCase

public Settings withParseNameCase(ParseNameCase value)

[#7337] The default name case for parsed identifiers.

withParseWithMetaLookups

public Settings withParseWithMetaLookups(ParseWithMetaLookups value)

[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider.

withParseAppendMissingTableReferences

public Settings withParseAppendMissingTableReferences(Transformation value)

Transform the parsed SQL to append missing table references to the query's FROM or USING clause, if applicable.

Teradata (and possibly others) allow for referencing tables that are not listed in the FROM clause, such as SELECT t.* FROM t WHERE t.i = u.i. This transformation is executed in the parser, to produce SELECT 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

public Settings withParseSetCommands(Boolean value)

withParseUnsupportedSyntax

public Settings withParseUnsupportedSyntax(ParseUnsupportedSyntax value)

[#5917] Whether the parser should accept unsupported (but known) syntax.

withParseUnknownFunctions

public Settings withParseUnknownFunctions(ParseUnknownFunctions value)

[#7344] Whether the parser should accept unknown functions.

withParseIgnoreComments

public Settings withParseIgnoreComments(Boolean value)

withParseIgnoreCommentStart

public Settings withParseIgnoreCommentStart(String value)

[#8325] The ignore comment start token

withParseIgnoreCommentStop

public Settings withParseIgnoreCommentStop(String value)

[#8325] The ignore comment stop token

withParseRetainCommentsBetweenQueries

public Settings withParseRetainCommentsBetweenQueries(Boolean value)

withParseMetaDefaultExpressions

public Settings withParseMetaDefaultExpressions(Boolean value)

withReadonlyTableRecordInsert

public Settings withReadonlyTableRecordInsert(WriteIfReadonly value)

[#9864] The behaviour when trying to insert into readonly columns using TableRecord.insert().

withReadonlyUpdatableRecordUpdate

public Settings withReadonlyUpdatableRecordUpdate(WriteIfReadonly value)

[#9864] The behaviour when trying to update a readonly column using UpdatableRecord.update().

withReadonlyInsert

public Settings withReadonlyInsert(WriteIfReadonly value)

[#9864] The behaviour when trying to insert into readonly columns using Insert statements, or the insert clause of a Merge statement.

withReadonlyUpdate

public Settings withReadonlyUpdate(WriteIfReadonly value)

[#9864] The behaviour when trying to update a readonly column using Update statements, or the update clause of a Merge statement.

withApplyWorkaroundFor7962

public Settings withApplyWorkaroundFor7962(Boolean value)

withInterpreterSearchPath

public Settings withInterpreterSearchPath(InterpreterSearchSchema... values)

withInterpreterSearchPath

public Settings withInterpreterSearchPath(Collection<InterpreterSearchSchema> values)

withInterpreterSearchPath

public Settings withInterpreterSearchPath(List<InterpreterSearchSchema> interpreterSearchPath)

withMigrationSchemata

public Settings withMigrationSchemata(MigrationSchema... values)

withMigrationSchemata

public Settings withMigrationSchemata(Collection<MigrationSchema> values)

withMigrationSchemata

public Settings withMigrationSchemata(List<MigrationSchema> migrationSchemata)

withParseSearchPath

public Settings withParseSearchPath(ParseSearchSchema... values)

withParseSearchPath

public Settings withParseSearchPath(Collection<ParseSearchSchema> values)

withParseSearchPath

public Settings withParseSearchPath(List<ParseSearchSchema> parseSearchPath)

appendTo

public final void appendTo(XMLBuilder builder)

Specified by:

appendTo in interface XMLAppendable

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Object clone()

Overrides:

clone in class Object