- 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
-
Constructor Summary
Constructors Constructor Description Settings()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
appendTo(XMLBuilder builder)
Object
clone()
boolean
equals(Object that)
BackslashEscaping
getBackslashEscaping()
Whether string literals should be escaped with backslash.String
getDelimiter()
[#5826] The delimiter character to be used to delimit statements in batches.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 registeredExecuteListener
s.InvocationOrder
getExecuteListenerStartInvocationOrder()
The order of invocation for [action]start() methods registeredExecuteListener
s.ExecuteWithoutWhere
getExecuteUpdateWithoutWhere()
[#6771] Specifies whether UPDATE statements are allowed to be executed lacking a WHERE clause.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 where0
uses the dialect defaults:SQLDialect.ACCESS
: 768SQLDialect.ASE
: 2000SQLDialect.INGRES
: 1024SQLDialect.ORACLE
: 32767SQLDialect.POSTGRES
: 32767SQLDialect.SQLITE
: 999SQLDialect.SQLSERVER
: 2100Integer
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 togetLocale()
.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 registeredMigrationListener
s.InvocationOrder
getMigrationListenerStartInvocationOrder()
The order of invocation for [action]start() methods registeredMigrationListener
s.ParamCastMode
getParamCastMode()
Whether rendered bind values should be cast to their respective type.ParamType
getParamType()
Specify how bind variables are to be rendered.SQLDialect
getParseDialect()
[#7337] The input dialect that should be chosen to disambiguate ambiguous SQL syntax.String
getParseIgnoreCommentStart()
[#8325] The ignore comment start tokenString
getParseIgnoreCommentStop()
[#8325] The ignore comment stop tokenLocale
getParseLocale()
The Locale to be used with any parser locale dependent logic, defaulting togetLocale()
.ParseNameCase
getParseNameCase()
[#7337] The default name case for parsed identifiers.List<ParseSearchSchema>
getParseSearchPath()
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.InvocationOrder
getRecordListenerEndInvocationOrder()
The order of invocation for [action]end() methods registeredRecordListener
s.InvocationOrder
getRecordListenerStartInvocationOrder()
The order of invocation for [action]start() methods registeredRecordListener
s.RenderFormatting
getRenderFormatting()
All sorts of formatting flags / settings.RenderKeywordCase
getRenderKeywordCase()
Whether the case ofKeyword
references should be modified in any way.RenderKeywordStyle
getRenderKeywordStyle()
Deprecated.- 3.12.0 - [#5909] - UseRenderKeywordCase
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 ofName
references should be modified in any way.String
getRenderNamedParamPrefix()
The prefix to use for named parameters.RenderNameStyle
getRenderNameStyle()
Deprecated.- 3.12.0 - [#5909] - UseRenderQuotedNames
andRenderNameCase
instead.RenderOptionalKeyword
getRenderOptionalAsKeywordForFieldAliases()
Whether to render the optionalAS
keyword in table aliases, if it is optional in the output dialect.RenderOptionalKeyword
getRenderOptionalAsKeywordForTableAliases()
Whether to render the optionalAS
keyword in table aliases, if it is optional in the output dialect.RenderOptionalKeyword
getRenderOptionalInnerKeyword()
Whether to render the optionalINNER
keyword inINNER JOIN
, if it is optional in the output dialect.RenderOptionalKeyword
getRenderOptionalOuterKeyword()
Whether to render the optionalOUTER
keyword inOUTER 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 propagatedInvocationOrder
getTransactionListenerEndInvocationOrder()
The order of invocation for [action]end() methods registeredTransactionListener
s.InvocationOrder
getTransactionListenerStartInvocationOrder()
The order of invocation for [action]start() methods registeredTransactionListener
s.InvocationOrder
getVisitListenerEndInvocationOrder()
The order of invocation for [action]end() methods registeredVisitListener
s.InvocationOrder
getVisitListenerStartInvocationOrder()
The order of invocation for [action]start() methods registeredVisitListener
s.int
hashCode()
Boolean
isApplyWorkaroundFor7962()
[#7963] Apply workaround for ORA-04043 when inserting into Oracle tables with qualified, quoted identifiers, and fetching generated keysBoolean
isAttachRecords()
Whether fetched records should be attached to the fetching configuration.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 ServerOUTPUT
clause.Boolean
isFetchWarnings()
Whether warnings should be fetched after each query execution.Boolean
isInListPadding()
[#5600] Whether IN lists in IN predicates should be padded to powers of inListPadBase (default 2).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
isMapJPAAnnotations()
Whether JPA annotations should be considered by the DefaultRecordMapper.Boolean
isMigrationAllowsUndo()
Whether migrations are allowed to be executed in inverse order.Boolean
isMigrationAutoValidation()
Whether a migration automatically runs a validation first.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
isParseSetCommands()
[#9780] Whether commands of the typeSET 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
isRenderFormatted()
Whether rendered SQL should be pretty-printed.Boolean
isRenderOrderByRownumberForEmulatedPagination()
Whether an additionalORDER BY rn
clause should be rendered on emulated paginated queries.Boolean
isRenderOutputForSQLServerReturningClause()
Whether the jOOQRETURNING
clause should map to SQL Server'sOUTPUT
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 possibleBoolean
isTransformTableListsToAnsiJoin()
Transform table lists to ANSI join if possibleBoolean
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 withexecuteWithOptimisticLocking
.Boolean
isUpdateRecordVersion()
Whether store(), insert(), and update() methods should update the record version prior to the operation, for use withexecuteWithOptimisticLocking
.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
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
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 registeredExecuteListener
s.void
setExecuteListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredExecuteListener
s.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
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
setInlineThreshold(Integer value)
The maximum number of allowed bind variables before inlining all values where0
uses the dialect defaults:SQLDialect.ACCESS
: 768SQLDialect.ASE
: 2000SQLDialect.INGRES
: 1024SQLDialect.ORACLE
: 32767SQLDialect.POSTGRES
: 32767SQLDialect.SQLITE
: 999SQLDialect.SQLSERVER
: 2100void
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
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 togetLocale()
.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
setMapJPAAnnotations(Boolean value)
Sets the value of the mapJPAAnnotations 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
setMigrationAllowsUndo(Boolean value)
Sets the value of the migrationAllowsUndo property.void
setMigrationAutoValidation(Boolean value)
Sets the value of the migrationAutoValidation property.void
setMigrationListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredMigrationListener
s.void
setMigrationListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredMigrationListener
s.void
setMigrationRevertUntracked(Boolean value)
Sets the value of the migrationRevertUntracked property.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
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 tokenvoid
setParseIgnoreCommentStop(String value)
[#8325] The ignore comment stop tokenvoid
setParseLocale(Locale value)
The Locale to be used with any parser locale dependent logic, defaulting togetLocale()
.void
setParseNameCase(ParseNameCase value)
[#7337] The default name case for parsed identifiers.void
setParseSearchPath(List<ParseSearchSchema> parseSearchPath)
void
setParseSetCommands(Boolean value)
Sets the value of the parseSetCommands property.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
setRecordListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredRecordListener
s.void
setRecordListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredRecordListener
s.void
setReflectionCaching(Boolean value)
Sets the value of the reflectionCaching property.void
setRenderCatalog(Boolean value)
Sets the value of the renderCatalog property.void
setRenderFormatted(Boolean value)
Sets the value of the renderFormatted property.void
setRenderFormatting(RenderFormatting value)
All sorts of formatting flags / settings.void
setRenderKeywordCase(RenderKeywordCase value)
Whether the case ofKeyword
references should be modified in any way.void
setRenderKeywordStyle(RenderKeywordStyle value)
Deprecated.- 3.12.0 - [#5909] - UseRenderKeywordCase
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 ofName
references should be modified in any way.void
setRenderNamedParamPrefix(String value)
The prefix to use for named parameters.void
setRenderNameStyle(RenderNameStyle value)
Deprecated.- 3.12.0 - [#5909] - UseRenderQuotedNames
andRenderNameCase
instead.void
setRenderOptionalAsKeywordForFieldAliases(RenderOptionalKeyword value)
Whether to render the optionalAS
keyword in table aliases, if it is optional in the output dialect.void
setRenderOptionalAsKeywordForTableAliases(RenderOptionalKeyword value)
Whether to render the optionalAS
keyword in table aliases, if it is optional in the output dialect.void
setRenderOptionalInnerKeyword(RenderOptionalKeyword value)
Whether to render the optionalINNER
keyword inINNER JOIN
, if it is optional in the output dialect.void
setRenderOptionalOuterKeyword(RenderOptionalKeyword value)
Whether to render the optionalOUTER
keyword inOUTER 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 propagatedvoid
setTransactionListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredTransactionListener
s.void
setTransactionListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredTransactionListener
s.void
setTransformAnsiJoinToTableLists(Boolean value)
Sets the value of the transformAnsiJoinToTableLists property.void
setTransformTableListsToAnsiJoin(Boolean value)
Sets the value of the transformTableListsToAnsiJoin property.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
setVisitListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredVisitListener
s.void
setVisitListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredVisitListener
s.String
toString()
Settings
withApplyWorkaroundFor7962(Boolean value)
Settings
withAttachRecords(Boolean value)
Settings
withBackslashEscaping(BackslashEscaping value)
Whether string literals should be escaped with backslash.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
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 registeredExecuteListener
s.Settings
withExecuteListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredExecuteListener
s.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
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
withInlineThreshold(Integer value)
The maximum number of allowed bind variables before inlining all values where0
uses the dialect defaults:SQLDialect.ACCESS
: 768SQLDialect.ASE
: 2000SQLDialect.INGRES
: 1024SQLDialect.ORACLE
: 32767SQLDialect.POSTGRES
: 32767SQLDialect.SQLITE
: 999SQLDialect.SQLSERVER
: 2100Settings
withInListPadBase(Integer value)
[#7095] The base to use to calculate the powers of when applying in list padding.Settings
withInListPadding(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 togetLocale()
.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
withMapJPAAnnotations(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
withMigrationAllowsUndo(Boolean value)
Settings
withMigrationAutoValidation(Boolean value)
Settings
withMigrationListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredMigrationListener
s.Settings
withMigrationListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredMigrationListener
s.Settings
withMigrationRevertUntracked(Boolean value)
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
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 tokenSettings
withParseIgnoreCommentStop(String value)
[#8325] The ignore comment stop tokenSettings
withParseLocale(Locale value)
The Locale to be used with any parser locale dependent logic, defaulting togetLocale()
.Settings
withParseNameCase(ParseNameCase value)
[#7337] The default name case for parsed identifiers.Settings
withParseSearchPath(Collection<ParseSearchSchema> values)
Settings
withParseSearchPath(List<ParseSearchSchema> parseSearchPath)
Settings
withParseSearchPath(ParseSearchSchema... values)
Settings
withParseSetCommands(Boolean value)
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
withRecordListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredRecordListener
s.Settings
withRecordListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredRecordListener
s.Settings
withReflectionCaching(Boolean value)
Settings
withRenderCatalog(Boolean value)
Settings
withRenderFormatted(Boolean value)
Settings
withRenderFormatting(RenderFormatting value)
All sorts of formatting flags / settings.Settings
withRenderKeywordCase(RenderKeywordCase value)
Whether the case ofKeyword
references should be modified in any way.Settings
withRenderKeywordStyle(RenderKeywordStyle value)
Deprecated.- 3.12.0 - [#5909] - UseRenderKeywordCase
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 ofName
references should be modified in any way.Settings
withRenderNamedParamPrefix(String value)
The prefix to use for named parameters.Settings
withRenderNameStyle(RenderNameStyle value)
Deprecated.- 3.12.0 - [#5909] - UseRenderQuotedNames
andRenderNameCase
instead.Settings
withRenderOptionalAsKeywordForFieldAliases(RenderOptionalKeyword value)
Whether to render the optionalAS
keyword in table aliases, if it is optional in the output dialect.Settings
withRenderOptionalAsKeywordForTableAliases(RenderOptionalKeyword value)
Whether to render the optionalAS
keyword in table aliases, if it is optional in the output dialect.Settings
withRenderOptionalInnerKeyword(RenderOptionalKeyword value)
Whether to render the optionalINNER
keyword inINNER JOIN
, if it is optional in the output dialect.Settings
withRenderOptionalOuterKeyword(RenderOptionalKeyword value)
Whether to render the optionalOUTER
keyword inOUTER 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 propagatedSettings
withTransactionListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredTransactionListener
s.Settings
withTransactionListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredTransactionListener
s.Settings
withTransformAnsiJoinToTableLists(Boolean value)
Settings
withTransformTableListsToAnsiJoin(Boolean value)
Settings
withUpdatablePrimaryKeys(Boolean value)
Settings
withUpdateRecordTimestamp(Boolean value)
Settings
withUpdateRecordVersion(Boolean value)
Settings
withVisitListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredVisitListener
s.Settings
withVisitListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredVisitListener
s.
-
-
-
Field Detail
-
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
-
renderScalarSubqueriesForStoredFunctions
protected Boolean renderScalarSubqueriesForStoredFunctions
-
renderOrderByRownumberForEmulatedPagination
protected Boolean renderOrderByRownumberForEmulatedPagination
-
renderOutputForSQLServerReturningClause
protected Boolean renderOutputForSQLServerReturningClause
-
renderParenthesisAroundSetOperationQueries
protected Boolean renderParenthesisAroundSetOperationQueries
-
fetchTriggerValuesAfterSQLServerOutput
protected Boolean fetchTriggerValuesAfterSQLServerOutput
-
transformAnsiJoinToTableLists
protected Boolean transformAnsiJoinToTableLists
-
transformTableListsToAnsiJoin
protected Boolean transformTableListsToAnsiJoin
-
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
-
updatablePrimaryKeys
protected Boolean updatablePrimaryKeys
-
reflectionCaching
protected Boolean reflectionCaching
-
cacheRecordMappers
protected Boolean cacheRecordMappers
-
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
-
mapConstructorParameterNames
protected Boolean mapConstructorParameterNames
-
mapConstructorParameterNamesInKotlin
protected Boolean mapConstructorParameterNamesInKotlin
-
queryPoolable
protected QueryPoolable queryPoolable
-
queryTimeout
protected Integer queryTimeout
-
maxRows
protected Integer maxRows
-
fetchSize
protected Integer fetchSize
-
debugInfoOnStackTrace
protected Boolean debugInfoOnStackTrace
-
inListPadding
protected Boolean inListPadding
-
inListPadBase
protected Integer inListPadBase
-
delimiter
protected String delimiter
-
emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly
protected Boolean emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly
-
executeUpdateWithoutWhere
protected ExecuteWithoutWhere executeUpdateWithoutWhere
-
executeDeleteWithoutWhere
protected ExecuteWithoutWhere executeDeleteWithoutWhere
-
interpreterDialect
protected SQLDialect interpreterDialect
-
interpreterNameLookupCaseSensitivity
protected InterpreterNameLookupCaseSensitivity interpreterNameLookupCaseSensitivity
-
interpreterLocale
protected Locale interpreterLocale
-
interpreterDelayForeignKeyDeclarations
protected Boolean interpreterDelayForeignKeyDeclarations
-
migrationAllowsUndo
protected Boolean migrationAllowsUndo
-
migrationRevertUntracked
protected Boolean migrationRevertUntracked
-
migrationAutoValidation
protected Boolean migrationAutoValidation
-
locale
protected Locale locale
-
parseDialect
protected SQLDialect parseDialect
-
parseLocale
protected Locale parseLocale
-
parseNameCase
protected ParseNameCase parseNameCase
-
parseWithMetaLookups
protected ParseWithMetaLookups parseWithMetaLookups
-
parseSetCommands
protected Boolean parseSetCommands
-
parseUnsupportedSyntax
protected ParseUnsupportedSyntax parseUnsupportedSyntax
-
parseUnknownFunctions
protected ParseUnknownFunctions parseUnknownFunctions
-
parseIgnoreComments
protected Boolean parseIgnoreComments
-
parseIgnoreCommentStart
protected String parseIgnoreCommentStart
-
parseIgnoreCommentStop
protected String parseIgnoreCommentStop
-
applyWorkaroundFor7962
protected Boolean applyWorkaroundFor7962
-
interpreterSearchPath
protected List<InterpreterSearchSchema> interpreterSearchPath
-
parseSearchPath
protected List<ParseSearchSchema> parseSearchPath
-
-
Method Detail
-
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 isBoolean
-
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 isBoolean
-
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), notDSL.quotedName(String)
orDSL.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), notDSL.quotedName(String)
orDSL.unquotedName(String)
, whose behaviour cannot be overridden.This setting does not affect any plain SQL usage.
-
getRenderNameCase
public RenderNameCase getRenderNameCase()
Whether the case ofName
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 ofName
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] - UseRenderQuotedNames
andRenderNameCase
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] - UseRenderQuotedNames
andRenderNameCase
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.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
."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.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
."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 ofKeyword
references should be modified in any way.
-
setRenderKeywordCase
public void setRenderKeywordCase(RenderKeywordCase value)
Whether the case ofKeyword
references should be modified in any way.
-
getRenderKeywordStyle
@Deprecated public RenderKeywordStyle getRenderKeywordStyle()
Deprecated.- 3.12.0 - [#5909] - UseRenderKeywordCase
instead.Whether the case ofKeyword
references should be modified in any way.
-
setRenderKeywordStyle
@Deprecated public void setRenderKeywordStyle(RenderKeywordStyle value)
Deprecated.- 3.12.0 - [#5909] - UseRenderKeywordCase
instead.Whether the case ofKeyword
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 togetLocale()
.
-
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 togetLocale()
.
-
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 isBoolean
-
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 optionalAS
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 optionalAS
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 optionalAS
keyword in table aliases, if it is optional in the output dialect.
-
setRenderOptionalAsKeywordForFieldAliases
public void setRenderOptionalAsKeywordForFieldAliases(RenderOptionalKeyword value)
Whether to render the optionalAS
keyword in table aliases, if it is optional in the output dialect.
-
getRenderOptionalInnerKeyword
public RenderOptionalKeyword getRenderOptionalInnerKeyword()
Whether to render the optionalINNER
keyword inINNER JOIN
, if it is optional in the output dialect.
-
setRenderOptionalInnerKeyword
public void setRenderOptionalInnerKeyword(RenderOptionalKeyword value)
Whether to render the optionalINNER
keyword inINNER JOIN
, if it is optional in the output dialect.
-
getRenderOptionalOuterKeyword
public RenderOptionalKeyword getRenderOptionalOuterKeyword()
Whether to render the optionalOUTER
keyword inOUTER JOIN
, if it is optional in the output dialect.
-
setRenderOptionalOuterKeyword
public void setRenderOptionalOuterKeyword(RenderOptionalKeyword value)
Whether to render the optionalOUTER
keyword inOUTER JOIN
, if it is optional in the output dialect.
-
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 isBoolean
-
isRenderOrderByRownumberForEmulatedPagination
public Boolean isRenderOrderByRownumberForEmulatedPagination()
Whether an additionalORDER 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) orROW_NUMBER()
(e.g. DB2, SQL Server, etc.) filtering. While these subqueries are ordered, the ordering is not guaranteed to be stable in the outer most queries. It may be stable (and e.g. in Oracle, it mostly is, if queries are not parallel, or joined to other queries, etc.), so the excessORDER BY
clause may add some additional performance overhead. This setting forces jOOQ to not generate the additionalORDER 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 isBoolean
-
isRenderOutputForSQLServerReturningClause
public Boolean isRenderOutputForSQLServerReturningClause()
Whether the jOOQRETURNING
clause should map to SQL Server'sOUTPUT
clause.SQL Server supports an
OUTPUT
clause in most DML statements, whose behaviour is almost identical toRETURNING
in Firebird, Oracle, PostgreSQL. Users who want to prevent jOOQ from rendering thisOUTPUT
clause can deactivate this flag to revert to jOOQ callingjava.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 isBoolean
-
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 isBoolean
-
isFetchTriggerValuesAfterSQLServerOutput
public Boolean isFetchTriggerValuesAfterSQLServerOutput()
Fetch trigger values after SQL ServerOUTPUT
clause.SQL Server
OUTPUT
statements do not support fetching trigger generated values. This is a limitation of therenderOutputForSQLServerReturningClause
. An additionalMERGE
statement can run a second query if (and only if) the primary key has been included in theOUTPUT
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 isBoolean
-
isTransformAnsiJoinToTableLists
public Boolean isTransformAnsiJoinToTableLists()
Transform ANSI join to table lists if possibleHistorically, 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 isBoolean
-
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 flag has not been implemented yet!
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 isBoolean
-
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 where0
uses the dialect defaults:SQLDialect.ACCESS
: 768SQLDialect.ASE
: 2000SQLDialect.INGRES
: 1024SQLDialect.ORACLE
: 32767SQLDialect.POSTGRES
: 32767SQLDialect.SQLITE
: 999SQLDialect.SQLSERVER
: 2100
-
setInlineThreshold
public void setInlineThreshold(Integer value)
The maximum number of allowed bind variables before inlining all values where0
uses the dialect defaults:SQLDialect.ACCESS
: 768SQLDialect.ASE
: 2000SQLDialect.INGRES
: 1024SQLDialect.ORACLE
: 32767SQLDialect.POSTGRES
: 32767SQLDialect.SQLITE
: 999SQLDialect.SQLSERVER
: 2100
-
getTransactionListenerStartInvocationOrder
public InvocationOrder getTransactionListenerStartInvocationOrder()
The order of invocation for [action]start() methods registeredTransactionListener
s.
-
setTransactionListenerStartInvocationOrder
public void setTransactionListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredTransactionListener
s.
-
getTransactionListenerEndInvocationOrder
public InvocationOrder getTransactionListenerEndInvocationOrder()
The order of invocation for [action]end() methods registeredTransactionListener
s.
-
setTransactionListenerEndInvocationOrder
public void setTransactionListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredTransactionListener
s.
-
getMigrationListenerStartInvocationOrder
public InvocationOrder getMigrationListenerStartInvocationOrder()
The order of invocation for [action]start() methods registeredMigrationListener
s.
-
setMigrationListenerStartInvocationOrder
public void setMigrationListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredMigrationListener
s.
-
getMigrationListenerEndInvocationOrder
public InvocationOrder getMigrationListenerEndInvocationOrder()
The order of invocation for [action]end() methods registeredMigrationListener
s.
-
setMigrationListenerEndInvocationOrder
public void setMigrationListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredMigrationListener
s.
-
getVisitListenerStartInvocationOrder
public InvocationOrder getVisitListenerStartInvocationOrder()
The order of invocation for [action]start() methods registeredVisitListener
s.
-
setVisitListenerStartInvocationOrder
public void setVisitListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredVisitListener
s.
-
getVisitListenerEndInvocationOrder
public InvocationOrder getVisitListenerEndInvocationOrder()
The order of invocation for [action]end() methods registeredVisitListener
s.
-
setVisitListenerEndInvocationOrder
public void setVisitListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredVisitListener
s.
-
getRecordListenerStartInvocationOrder
public InvocationOrder getRecordListenerStartInvocationOrder()
The order of invocation for [action]start() methods registeredRecordListener
s.
-
setRecordListenerStartInvocationOrder
public void setRecordListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredRecordListener
s.
-
getRecordListenerEndInvocationOrder
public InvocationOrder getRecordListenerEndInvocationOrder()
The order of invocation for [action]end() methods registeredRecordListener
s.
-
setRecordListenerEndInvocationOrder
public void setRecordListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredRecordListener
s.
-
getExecuteListenerStartInvocationOrder
public InvocationOrder getExecuteListenerStartInvocationOrder()
The order of invocation for [action]start() methods registeredExecuteListener
s.
-
setExecuteListenerStartInvocationOrder
public void setExecuteListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredExecuteListener
s.
-
getExecuteListenerEndInvocationOrder
public InvocationOrder getExecuteListenerEndInvocationOrder()
The order of invocation for [action]end() methods registeredExecuteListener
s.
-
setExecuteListenerEndInvocationOrder
public void setExecuteListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredExecuteListener
s.
-
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 isBoolean
-
isUpdateRecordVersion
public Boolean isUpdateRecordVersion()
Whether store(), insert(), and update() methods should update the record version prior to the operation, for use withexecuteWithOptimisticLocking
.- Returns:
- possible object is
Boolean
-
setUpdateRecordVersion
public void setUpdateRecordVersion(Boolean value)
Sets the value of the updateRecordVersion property.- Parameters:
value
- allowed object isBoolean
-
isUpdateRecordTimestamp
public Boolean isUpdateRecordTimestamp()
Whether store(), insert(), and update() methods should update the record timestamp prior to the operation, for use withexecuteWithOptimisticLocking
.- Returns:
- possible object is
Boolean
-
setUpdateRecordTimestamp
public void setUpdateRecordTimestamp(Boolean value)
Sets the value of the updateRecordTimestamp property.- Parameters:
value
- allowed object isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 ifis 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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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.
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 togetLocale()
.
-
setInterpreterLocale
public void setInterpreterLocale(Locale value)
The Locale to be used with any interpreter locale dependent logic, defaulting togetLocale()
.
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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 isBoolean
-
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()
, orgetInterpreterLocale()
.
-
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()
, orgetInterpreterLocale()
.
-
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 togetLocale()
.
-
setParseLocale
public void setParseLocale(Locale value)
The Locale to be used with any parser locale dependent logic, defaulting togetLocale()
.
-
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.
-
isParseSetCommands
public Boolean isParseSetCommands()
[#9780] Whether commands of the typeSET 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 isBoolean
-
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 isBoolean
-
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
-
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 isBoolean
-
getInterpreterSearchPath
public List<InterpreterSearchSchema> getInterpreterSearchPath()
-
setInterpreterSearchPath
public void setInterpreterSearchPath(List<InterpreterSearchSchema> interpreterSearchPath)
-
getParseSearchPath
public List<ParseSearchSchema> getParseSearchPath()
-
setParseSearchPath
public void setParseSearchPath(List<ParseSearchSchema> parseSearchPath)
-
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), notDSL.quotedName(String)
orDSL.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 ofName
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] - UseRenderQuotedNames
andRenderNameCase
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.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
."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 ofKeyword
references should be modified in any way.
-
withRenderKeywordStyle
@Deprecated public Settings withRenderKeywordStyle(RenderKeywordStyle value)
Deprecated.- 3.12.0 - [#5909] - UseRenderKeywordCase
instead.Whether the case ofKeyword
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 togetLocale()
.
-
withRenderFormatting
public Settings withRenderFormatting(RenderFormatting value)
All sorts of formatting flags / settings.
-
withRenderOptionalAsKeywordForTableAliases
public Settings withRenderOptionalAsKeywordForTableAliases(RenderOptionalKeyword value)
Whether to render the optionalAS
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 optionalAS
keyword in table aliases, if it is optional in the output dialect.
-
withRenderOptionalInnerKeyword
public Settings withRenderOptionalInnerKeyword(RenderOptionalKeyword value)
Whether to render the optionalINNER
keyword inINNER JOIN
, if it is optional in the output dialect.
-
withRenderOptionalOuterKeyword
public Settings withRenderOptionalOuterKeyword(RenderOptionalKeyword value)
Whether to render the optionalOUTER
keyword inOUTER JOIN
, if it is optional in the output dialect.
-
withRenderScalarSubqueriesForStoredFunctions
public Settings withRenderScalarSubqueriesForStoredFunctions(Boolean value)
-
withRenderOrderByRownumberForEmulatedPagination
public Settings withRenderOrderByRownumberForEmulatedPagination(Boolean value)
-
withRenderOutputForSQLServerReturningClause
public Settings withRenderOutputForSQLServerReturningClause(Boolean value)
-
withRenderParenthesisAroundSetOperationQueries
public Settings withRenderParenthesisAroundSetOperationQueries(Boolean value)
-
withFetchTriggerValuesAfterSQLServerOutput
public Settings withFetchTriggerValuesAfterSQLServerOutput(Boolean value)
-
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 where0
uses the dialect defaults:SQLDialect.ACCESS
: 768SQLDialect.ASE
: 2000SQLDialect.INGRES
: 1024SQLDialect.ORACLE
: 32767SQLDialect.POSTGRES
: 32767SQLDialect.SQLITE
: 999SQLDialect.SQLSERVER
: 2100
-
withTransactionListenerStartInvocationOrder
public Settings withTransactionListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredTransactionListener
s.
-
withTransactionListenerEndInvocationOrder
public Settings withTransactionListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredTransactionListener
s.
-
withMigrationListenerStartInvocationOrder
public Settings withMigrationListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredMigrationListener
s.
-
withMigrationListenerEndInvocationOrder
public Settings withMigrationListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredMigrationListener
s.
-
withVisitListenerStartInvocationOrder
public Settings withVisitListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredVisitListener
s.
-
withVisitListenerEndInvocationOrder
public Settings withVisitListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredVisitListener
s.
-
withRecordListenerStartInvocationOrder
public Settings withRecordListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredRecordListener
s.
-
withRecordListenerEndInvocationOrder
public Settings withRecordListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredRecordListener
s.
-
withExecuteListenerStartInvocationOrder
public Settings withExecuteListenerStartInvocationOrder(InvocationOrder value)
The order of invocation for [action]start() methods registeredExecuteListener
s.
-
withExecuteListenerEndInvocationOrder
public Settings withExecuteListenerEndInvocationOrder(InvocationOrder value)
The order of invocation for [action]end() methods registeredExecuteListener
s.
-
withExecuteWithOptimisticLockingExcludeUnversioned
public Settings withExecuteWithOptimisticLockingExcludeUnversioned(Boolean value)
-
withThrowExceptions
public Settings withThrowExceptions(ThrowExceptions value)
A strategy defining how exceptions from the database / JDBC driver should be propagated
-
withFetchServerOutputSize
public Settings withFetchServerOutputSize(Integer value)
Whether server output should be fetched after each query execution.
-
withReturnIdentityOnUpdatableRecord
public Settings withReturnIdentityOnUpdatableRecord(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.
-
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)
-
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 togetLocale()
.
-
withInterpreterDelayForeignKeyDeclarations
public Settings withInterpreterDelayForeignKeyDeclarations(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()
, orgetInterpreterLocale()
.
-
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 togetLocale()
.
-
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.
-
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.
-
withParseIgnoreCommentStart
public Settings withParseIgnoreCommentStart(String value)
[#8325] The ignore comment start token
-
withParseIgnoreCommentStop
public Settings withParseIgnoreCommentStop(String value)
[#8325] The ignore comment stop token
-
withInterpreterSearchPath
public Settings withInterpreterSearchPath(InterpreterSearchSchema... values)
-
withInterpreterSearchPath
public Settings withInterpreterSearchPath(Collection<InterpreterSearchSchema> values)
-
withInterpreterSearchPath
public Settings withInterpreterSearchPath(List<InterpreterSearchSchema> interpreterSearchPath)
-
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 interfaceXMLAppendable
-
-