Uses of Class
org.jooq.conf.Settings

Packages that use Settings

Package	Description
org.jooq	This package contains jOOQ's public API.
org.jooq.conf
org.jooq.impl	This package contains jOOQ's implementation classes.
org.jooq.tools.jdbc	JDBC tooling.

Uses of Settings in org.jooq

Methods in org.jooq that return Settings

Modifier and Type	Method	Description
@NotNull Settings	Configuration.settings()	Retrieve the runtime configuration settings.
@NotNull Settings	DAO.settings()	The settings wrapped by this context.
@NotNull Settings	Scope.settings()	The settings wrapped by this context.

Methods in org.jooq with parameters of type Settings

Modifier and Type	Method	Description
@NotNull Configuration	Configuration.derive(Settings newSettings)	Create a derived configuration from this one, with new settings.
@NotNull Configuration	Configuration.set(Settings newSettings)	Change this configuration to hold a new settings.

Method parameters in org.jooq with type arguments of type Settings

Modifier and Type	Method	Description
@NotNull Configuration	Configuration.deriveSettings(Function<? super Settings,? extends Settings> newSettings)	Create a derived configuration from this one, with new settings constructed from a clone of the current settings.
@NotNull Configuration	Configuration.deriveSettings(Function<? super Settings,? extends Settings> newSettings)	Create a derived configuration from this one, with new settings constructed from a clone of the current settings.

Uses of Settings in org.jooq.conf

Methods in org.jooq.conf that return Settings

Modifier and Type	Method	Description
static final Settings	SettingsTools.clone(Settings settings)	Clone some settings.
Settings	ObjectFactory.createSettings()	Create an instance of Settings
static final Settings	SettingsTools.defaultSettings()	Retrieve the configured default settings.
Settings	Settings.withApplyWorkaroundFor7962(Boolean value)
Settings	Settings.withAttachRecords(Boolean value)
Settings	Settings.withBackslashEscaping(BackslashEscaping value)	Whether string literals should be escaped with backslash.
Settings	Settings.withBatchSize(Integer value)	A property specifying a batch size that should be applied to all automatically created BatchedConnection instances.
Settings	Settings.withBindOffsetDateTimeType(Boolean value)
Settings	Settings.withBindOffsetTimeType(Boolean value)
Settings	Settings.withCacheParsingConnection(Boolean value)
Settings	Settings.withCacheParsingConnectionLRUCacheSize(Integer value)	The default implementation of the ParsingConnection cache's LRU cache size.
Settings	Settings.withCachePreparedStatementInLoader(Boolean value)
Settings	Settings.withCacheRecordMappers(Boolean value)
Settings	Settings.withDebugInfoOnStackTrace(Boolean value)
Settings	Settings.withDelimiter(String value)	[#5826] The delimiter character to be used to delimit statements in batches.
Settings	Settings.withEmulateMultiset(NestedCollectionEmulation value)	[#3884] How MULTISET support should be emulated.
Settings	Settings.withEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly(Boolean value)
Settings	Settings.withExecuteDeleteWithoutWhere(ExecuteWithoutWhere value)	[#6771] Specifies whether DELETE statements are allowed to be executed lacking a WHERE clause.
Settings	Settings.withExecuteListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered ExecuteListeners.
Settings	Settings.withExecuteListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered ExecuteListeners.
Settings	Settings.withExecuteLogging(Boolean value)
Settings	Settings.withExecuteUpdateWithoutWhere(ExecuteWithoutWhere value)	[#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause.
Settings	Settings.withExecuteWithOptimisticLocking(Boolean value)
Settings	Settings.withExecuteWithOptimisticLockingExcludeUnversioned(Boolean value)
Settings	Settings.withFetchIntermediateResult(FetchIntermediateResult value)	Whether to fetch data into intermediate Result instances.
Settings	Settings.withFetchServerOutputSize(Integer value)	Whether server output should be fetched after each query execution.
Settings	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	Settings.withFetchTriggerValuesAfterSQLServerOutput(Boolean value)
Settings	Settings.withFetchWarnings(Boolean value)
Settings	Settings.withForceIntegerTypesOnZeroScaleDecimals(Boolean value)
Settings	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	Settings.withInListPadBase(Integer value)	[#7095] The base to use to calculate the powers of when applying in list padding.
Settings	Settings.withInListPadding(Boolean value)
Settings	Settings.withInsertUnchangedRecords(Boolean value)
Settings	Settings.withInterpreterDelayForeignKeyDeclarations(Boolean value)
Settings	Settings.withInterpreterDialect(SQLDialect value)	[#7337] The dialect that should be used to interpret SQL DDL statements.
Settings	Settings.withInterpreterLocale(Locale value)	The Locale to be used with any interpreter locale dependent logic, defaulting to getLocale().
Settings	Settings.withInterpreterNameLookupCaseSensitivity(InterpreterNameLookupCaseSensitivity value)	[#9633] The case sensitivity of identifiers used when interpreting SQL DDL statements.
Settings	Settings.withInterpreterSearchPath(Collection<InterpreterSearchSchema> values)
Settings	Settings.withInterpreterSearchPath(List<InterpreterSearchSchema> interpreterSearchPath)
Settings	Settings.withInterpreterSearchPath(InterpreterSearchSchema... values)
Settings	Settings.withLocale(Locale value)	The Locale to be used with any locale dependent logic if there is not a more specific locale available.
Settings	Settings.withMapConstructorParameterNames(Boolean value)
Settings	Settings.withMapConstructorParameterNamesInKotlin(Boolean value)
Settings	Settings.withMapConstructorPropertiesParameterNames(Boolean value)
Settings	Settings.withMapJPAAnnotations(Boolean value)
Settings	Settings.withMapRecordComponentParameterNames(Boolean value)
Settings	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	Settings.withMetaIncludeSystemIndexes(Boolean value)
Settings	Settings.withMetaIncludeSystemSequences(Boolean value)
Settings	Settings.withMigrationAllowsUndo(Boolean value)
Settings	Settings.withMigrationAutoBaseline(Boolean value)
Settings	Settings.withMigrationAutoValidation(Boolean value)
Settings	Settings.withMigrationIgnoreDefaultTimestampPrecisionDiffs(Boolean value)
Settings	Settings.withMigrationListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered MigrationListeners.
Settings	Settings.withMigrationListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered MigrationListeners.
Settings	Settings.withMigrationRevertUntracked(Boolean value)
Settings	Settings.withMigrationSchemata(Collection<MigrationSchema> values)
Settings	Settings.withMigrationSchemata(List<MigrationSchema> migrationSchemata)
Settings	Settings.withMigrationSchemata(MigrationSchema... values)
Settings	Settings.withNamePathSeparator(String value)	The character(s) to be used as a separator in paths encoded in a Name
Settings	Settings.withParamCastMode(ParamCastMode value)	Whether rendered bind values should be cast to their respective type.
Settings	Settings.withParamType(ParamType value)	Specify how bind variables are to be rendered.
Settings	Settings.withParseAppendMissingTableReferences(Transformation value)	Transform the parsed SQL to append missing table references to the query's FROM or USING clause, if applicable.
Settings	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	Settings.withParseDialect(SQLDialect value)	[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.
Settings	Settings.withParseIgnoreComments(Boolean value)
Settings	Settings.withParseIgnoreCommentStart(String value)	[#8325] The ignore comment start token
Settings	Settings.withParseIgnoreCommentStop(String value)	[#8325] The ignore comment stop token
Settings	Settings.withParseLocale(Locale value)	The Locale to be used with any parser locale dependent logic, defaulting to getLocale().
Settings	Settings.withParseMetaDefaultExpressions(Boolean value)
Settings	Settings.withParseNameCase(ParseNameCase value)	[#7337] The default name case for parsed identifiers.
Settings	Settings.withParseNamedParamPrefix(String value)	The prefix to use for named parameters in parsed SQL.
Settings	Settings.withParseRetainCommentsBetweenQueries(Boolean value)
Settings	Settings.withParseSearchPath(Collection<ParseSearchSchema> values)
Settings	Settings.withParseSearchPath(List<ParseSearchSchema> parseSearchPath)
Settings	Settings.withParseSearchPath(ParseSearchSchema... values)
Settings	Settings.withParseSetCommands(Boolean value)
Settings	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	Settings.withParseUnknownFunctions(ParseUnknownFunctions value)	[#7344] Whether the parser should accept unknown functions.
Settings	Settings.withParseUnsupportedSyntax(ParseUnsupportedSyntax value)	[#5917] Whether the parser should accept unsupported (but known) syntax.
Settings	Settings.withParseWithMetaLookups(ParseWithMetaLookups value)	[#7163] Whether the parser should perform meta lookups in the Configuration's MetaProvider.
Settings	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	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	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	Settings.withReadonlyTableRecordInsert(WriteIfReadonly value)	[#9864] The behaviour when trying to insert into readonly columns using TableRecord.insert().
Settings	Settings.withReadonlyUpdatableRecordUpdate(WriteIfReadonly value)	[#9864] The behaviour when trying to update a readonly column using UpdatableRecord.update().
Settings	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	Settings.withRecordListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered RecordListeners.
Settings	Settings.withRecordListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered RecordListeners.
Settings	Settings.withReflectionCaching(Boolean value)
Settings	Settings.withRenderCatalog(Boolean value)
Settings	Settings.withRenderCoalesceToEmptyStringInConcat(Boolean value)
Settings	Settings.withRenderDefaultNullability(RenderDefaultNullability value)	Whether the Nullability.DEFAULT nullablity should be rendered in generated DDL, and how it should be rendered.
Settings	Settings.withRenderFormatted(Boolean value)
Settings	Settings.withRenderFormatting(RenderFormatting value)	All sorts of formatting flags / settings.
Settings	Settings.withRenderGroupConcatMaxLenSessionVariable(Boolean value)
Settings	Settings.withRenderImplicitJoinType(RenderImplicitJoinType value)	The join type to be generated by implicit joins.
Settings	Settings.withRenderImplicitWindowRange(RenderImplicitWindowRange value)	Whether to render an explicit window RANGE clause when an implicit clause is applied.
Settings	Settings.withRenderKeywordCase(RenderKeywordCase value)	Whether the case of Keyword references should be modified in any way.
Settings	Settings.withRenderKeywordStyle(RenderKeywordStyle value)	Deprecated. - 3.12.0 - [#5909] - Use RenderKeywordCase instead.
Settings	Settings.withRenderLocale(Locale value)	The Locale to be used with any render locale dependent logic (as e.g.
Settings	Settings.withRenderMapping(RenderMapping value)	Configure render mapping for runtime schema / table rewriting in generated SQL.
Settings	Settings.withRenderNameCase(RenderNameCase value)	Whether the case of Name references should be modified in any way.
Settings	Settings.withRenderNamedParamPrefix(String value)	The prefix to use for named parameters in generated SQL.
Settings	Settings.withRenderNameStyle(RenderNameStyle value)	Deprecated. - 3.12.0 - [#5909] - Use RenderQuotedNames and RenderNameCase instead.
Settings	Settings.withRenderOptionalAsKeywordForFieldAliases(RenderOptionalKeyword value)	Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.
Settings	Settings.withRenderOptionalAsKeywordForTableAliases(RenderOptionalKeyword value)	Whether to render the optional AS keyword in table aliases, if it is optional in the output dialect.
Settings	Settings.withRenderOptionalInnerKeyword(RenderOptionalKeyword value)	Whether to render the optional INNER keyword in INNER JOIN, if it is optional in the output dialect.
Settings	Settings.withRenderOptionalOuterKeyword(RenderOptionalKeyword value)	Whether to render the optional OUTER keyword in OUTER JOIN, if it is optional in the output dialect.
Settings	Settings.withRenderOrderByRownumberForEmulatedPagination(Boolean value)
Settings	Settings.withRenderOutputForSQLServerReturningClause(Boolean value)
Settings	Settings.withRenderParenthesisAroundSetOperationQueries(Boolean value)
Settings	Settings.withRenderQuotedNames(RenderQuotedNames value)	Whether rendered schema, table, column names, etc should be quoted.
Settings	Settings.withRenderScalarSubqueriesForStoredFunctions(Boolean value)
Settings	Settings.withRenderSchema(Boolean value)
Settings	Settings.withReturnAllOnUpdatableRecord(Boolean value)
Settings	Settings.withReturnIdentityOnUpdatableRecord(Boolean value)
Settings	Settings.withReturnRecordToPojo(Boolean value)
Settings	Settings.withStatementType(StatementType value)	The type of statement that is to be executed.
Settings	Settings.withThrowExceptions(ThrowExceptions value)	A strategy defining how exceptions from the database / JDBC driver should be propagated
Settings	Settings.withTransactionListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered TransactionListeners.
Settings	Settings.withTransactionListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered TransactionListeners.
Settings	Settings.withTransformAnsiJoinToTableLists(Boolean value)
Settings	Settings.withTransformInConditionSubqueryWithLimitToDerivedTable(Transformation value)	Transform a subquery from an IN condition with LIMIT to an equivalent derived table.
Settings	Settings.withTransformQualify(Transformation value)	Transform the QUALIFY clause to an equivalent derived table to filter on window functions.
Settings	Settings.withTransformRownum(Transformation value)	Transform ROWNUM expressions to corresponding LIMIT clauses or ROW_NUMBER() expressions.
Settings	Settings.withTransformTableListsToAnsiJoin(Boolean value)
Settings	Settings.withTransformUnneededArithmeticExpressions(TransformUnneededArithmeticExpressions value)	Transform arithmetic expressions on literals and bind variables.
Settings	Settings.withUpdatablePrimaryKeys(Boolean value)
Settings	Settings.withUpdateRecordTimestamp(Boolean value)
Settings	Settings.withUpdateRecordVersion(Boolean value)
Settings	Settings.withUpdateUnchangedRecords(UpdateUnchangedRecords value)	Whether UpdatableRecord.update() calls should be executed if the record is unchanged.
Settings	Settings.withVisitListenerEndInvocationOrder(InvocationOrder value)	The order of invocation for [action]end() methods registered VisitListeners.
Settings	Settings.withVisitListenerStartInvocationOrder(InvocationOrder value)	The order of invocation for [action]start() methods registered VisitListeners.

Methods in org.jooq.conf that return types with arguments of type Settings

Modifier and Type	Method	Description
jakarta.xml.bind.JAXBElement<Settings>	ObjectFactory.createSettings(Settings value)	Create an instance of JAXBElement<Settings>

Methods in org.jooq.conf with parameters of type Settings

Modifier and Type	Method	Description
static final Settings	SettingsTools.clone(Settings settings)	Clone some settings.
jakarta.xml.bind.JAXBElement<Settings>	ObjectFactory.createSettings(Settings value)	Create an instance of JAXBElement<Settings>
static final boolean	SettingsTools.executePreparedStatements(Settings settings)	Whether a PreparedStatement should be executed.
static final boolean	SettingsTools.executeStaticStatements(Settings settings)	Whether static Statement should be executed.
static final BackslashEscaping	SettingsTools.getBackslashEscaping(Settings settings)	Get the value BackslashEscaping value.
static final int	SettingsTools.getBatchSize(Settings settings)	Return the specified getBatchSize().
static final ExecuteWithoutWhere	SettingsTools.getExecuteDeleteWithoutWhere(Settings settings)	Lazy access to getExecuteDeleteWithoutWhere().
static final ExecuteWithoutWhere	SettingsTools.getExecuteUpdateWithoutWhere(Settings settings)	Lazy access to getExecuteUpdateWithoutWhere().
static final int	SettingsTools.getFetchServerOutputSize(int fetchServerOutputSize, Settings settings)	Return fetchServerOutputSize if it is not 0, or the specified getFetchServerOutputSize().
static final int	SettingsTools.getFetchSize(int fetchSize, Settings settings)	Return fetchSize if it is not 0, or the specified getFetchSize().
static final int	SettingsTools.getMaxRows(int maxRows, Settings settings)	Return maxRows if it is not 0, or the specified getMaxRows().
static final ParamType	SettingsTools.getParamType(Settings settings)	Get the parameter type from the settings.
static final QueryPoolable	SettingsTools.getQueryPoolable(QueryPoolable poolable, Settings settings)	Return poolable if it is not null, or the specified getQueryPoolable().
static final int	SettingsTools.getQueryTimeout(int timeout, Settings settings)	Return timeout if it is not 0, or the specified getQueryTimeout().
static final RenderKeywordCase	SettingsTools.getRenderKeywordCase(Settings settings)	Backwards compatible access to RenderKeywordCase and/or RenderKeywordStyle (the latter being deprecated).
static final RenderMapping	SettingsTools.getRenderMapping(Settings settings)	Lazy access to RenderMapping.
static final RenderNameCase	SettingsTools.getRenderNameCase(Settings settings)	Backwards compatible access to RenderNameCase and/or RenderNameStyle (the latter being deprecated).
static final RenderQuotedNames	SettingsTools.getRenderQuotedNames(Settings settings)	Backwards compatible access to RenderQuotedNames and/or RenderNameStyle (the latter being deprecated).
static final StatementType	SettingsTools.getStatementType(Settings settings)	Get the statement type from the settings.
static final TransformUnneededArithmeticExpressions	SettingsTools.getTransformUnneededArithmeticExpressions(Settings settings)	Lazy access to getTransformUnneededArithmeticExpressions().
static final Locale	SettingsTools.interpreterLocale(Settings settings)	The interpreter locale that is applicable, or the default locale if no such locale is configured.
static final Locale	SettingsTools.locale(Settings settings)	The render locale that is applicable, or the default locale if no such locale is configured.
static final Locale	SettingsTools.parseLocale(Settings settings)	The parser locale that is applicable, or the default locale if no such locale is configured.
static final boolean	SettingsTools.parsingConnectionCaching(Settings settings)	Whether parsing connection caching is active.
static final boolean	SettingsTools.recordMapperCaching(Settings settings)	Whether record mapper caching is active.
static final boolean	SettingsTools.reflectionCaching(Settings settings)	Whether reflection caching is active.
static final Locale	SettingsTools.renderLocale(Settings settings)	The render locale that is applicable, or the default locale if no such locale is configured.
static final boolean	SettingsTools.updatablePrimaryKeys(Settings settings)	Whether primary keys should be updatable.

Uses of Settings in org.jooq.impl

Methods in org.jooq.impl that return Settings

Modifier and Type	Method	Description
Settings	DAOImpl.settings()
final Settings	DefaultConfiguration.settings()

Methods in org.jooq.impl with parameters of type Settings

Modifier and Type	Method	Description
final Configuration	DefaultConfiguration.derive(Settings newSettings)
final Configuration	DefaultConfiguration.set(Settings newSettings)
final void	DefaultConfiguration.setSettings(Settings newSettings)
static @NotNull DSLContext	DSL.using(io.r2dbc.spi.ConnectionFactory connectionFactory, SQLDialect dialect, Settings settings)	Create an executor with a custom R2DBC connection factory, a dialect and settings configured.
static @NotNull DSLContext	DSL.using(io.r2dbc.spi.Connection connection, SQLDialect dialect, Settings settings)	Create an executor with a custom R2DBC connection, a dialect and settings configured.
static @NotNull DSLContext	DSL.using(Connection connection, Settings settings)	Create an executor with a connection, a dialect and settings configured.
static @NotNull DSLContext	DSL.using(Connection connection, SQLDialect dialect, Settings settings)	Create an executor with a connection, a dialect and settings configured.
static @NotNull DSLContext	DSL.using(DataSource datasource, SQLDialect dialect, Settings settings)	Create an executor with a data source, a dialect and settings configured.
static @NotNull DSLContext	DSL.using(ConnectionProvider connectionProvider, SQLDialect dialect, Settings settings)	Create an executor with a custom connection provider, a dialect and settings configured.
static @NotNull DSLContext	DSL.using(SQLDialect dialect, Settings settings)	Create an executor with a dialect and settings configured.

Method parameters in org.jooq.impl with type arguments of type Settings

Modifier and Type	Method	Description
final Configuration	DefaultConfiguration.deriveSettings(Function<? super Settings,? extends Settings> newSettings)
final Configuration	DefaultConfiguration.deriveSettings(Function<? super Settings,? extends Settings> newSettings)

Constructors in org.jooq.impl with parameters of type Settings

Modifier	Constructor	Description
	DefaultCloseableDSLContext(io.r2dbc.spi.ConnectionFactory connectionFactory, SQLDialect dialect, Settings settings)
	DefaultCloseableDSLContext(ConnectionProvider connectionProvider, SQLDialect dialect, Settings settings)
	DefaultDSLContext(io.r2dbc.spi.ConnectionFactory connectionFactory, SQLDialect dialect, Settings settings)
	DefaultDSLContext(Connection connection, SQLDialect dialect, Settings settings)
	DefaultDSLContext(DataSource datasource, SQLDialect dialect, Settings settings)
	DefaultDSLContext(ConnectionProvider connectionProvider, SQLDialect dialect, Settings settings)
	DefaultDSLContext(SQLDialect dialect, Settings settings)

Uses of Settings in org.jooq.tools.jdbc

Methods in org.jooq.tools.jdbc that return Settings

Modifier and Type	Method	Description
Settings	MockConfiguration.settings()

Methods in org.jooq.tools.jdbc with parameters of type Settings

Modifier and Type	Method	Description
Configuration	MockConfiguration.derive(Settings newSettings)
Configuration	MockConfiguration.set(Settings newSettings)

Method parameters in org.jooq.tools.jdbc with type arguments of type Settings

Modifier and Type	Method	Description
Configuration	MockConfiguration.deriveSettings(Function<? super Settings,? extends Settings> newSettings)
Configuration	MockConfiguration.deriveSettings(Function<? super Settings,? extends Settings> newSettings)