public class Settings extends Object implements Serializable, Cloneable
Constructor and Description |
---|
Settings() |
Modifier and Type | Method and Description |
---|---|
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.
|
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 |
getInListPadBase()
[#7095] The base to use to calculate the powers of when applying in list padding.
|
Integer |
getMaxRows()
The default JDBC maxRows property that should be applied to all
jOOQ queries, for which no specific maxRows value was specified.
|
ParamCastMode |
getParamCastMode()
Whether rendered bind values should be cast to their respective type.
|
ParamType |
getParamType()
Specify how bind variables are to be rendered.
|
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.
|
Integer |
getQueryTimeout()
The default JDBC queryTimeout property that should be applied to all
jOOQ queries, for which no specific queryTimeout was specified.
|
RenderFormatting |
getRenderFormatting()
All sorts of formatting flags / settings.
|
RenderKeywordStyle |
getRenderKeywordStyle()
Whether SQL keywords should be rendered with upper or lower case.
|
RenderMapping |
getRenderMapping()
Configure render mapping for runtime schema / table rewriting in
generated SQL.
|
RenderNameStyle |
getRenderNameStyle()
Whether rendered schema, table, column names, etc should be quoted
in rendered SQL, or transformed in any other way.
|
StatementType |
getStatementType()
The type of statement that is to be executed.
|
ThrowExceptions |
getThrowExceptions()
A strategy defining how exceptions from the database / JDBC driver should be propagated
|
int |
hashCode() |
Boolean |
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. on tables that do not have a version and/or timestamp column.
|
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 |
isMapConstructorParameterNames()
Whether constructor parameter names obtained via reflection in Java 8+ should be considered by the DefaultRecordMapper.
|
Boolean |
isMapJPAAnnotations()
Whether JPA annotations should be considered by the DefaultRecordMapper.
|
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 additional
ORDER BY rn clause should be rendered on emulated paginated queries. |
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 |
isReturnRecordToPojo()
Whether calls to store(), insert(), update(), and delete() that are called on an UpdatableRecord
that is created from a POJO (e.g. in a DAO) should return all Record values to the POJO, including
IDENTITY values, and if
|
Boolean |
isUpdatablePrimaryKeys()
Whether primary key values are deemed to be "updatable" in jOOQ.
|
void |
setAttachRecords(Boolean value)
Sets the value of the attachRecords property.
|
void |
setBackslashEscaping(BackslashEscaping value)
Sets the value of the backslashEscaping property.
|
void |
setCacheRecordMappers(Boolean value)
Sets the value of the cacheRecordMappers property.
|
void |
setDebugInfoOnStackTrace(Boolean value)
Sets the value of the debugInfoOnStackTrace property.
|
void |
setDelimiter(String value)
Sets the value of the delimiter property.
|
void |
setEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly(Boolean value)
Sets the value of the emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly property.
|
void |
setExecuteDeleteWithoutWhere(ExecuteWithoutWhere value)
Sets the value of the executeDeleteWithoutWhere property.
|
void |
setExecuteLogging(Boolean value)
Sets the value of the executeLogging property.
|
void |
setExecuteUpdateWithoutWhere(ExecuteWithoutWhere value)
Sets the value of the executeUpdateWithoutWhere property.
|
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)
Sets the value of the fetchServerOutputSize property.
|
void |
setFetchSize(Integer value)
Sets the value of the fetchSize property.
|
void |
setFetchWarnings(Boolean value)
Sets the value of the fetchWarnings property.
|
void |
setInListPadBase(Integer value)
Sets the value of the inListPadBase property.
|
void |
setInListPadding(Boolean value)
Sets the value of the inListPadding property.
|
void |
setMapConstructorParameterNames(Boolean value)
Sets the value of the mapConstructorParameterNames property.
|
void |
setMapJPAAnnotations(Boolean value)
Sets the value of the mapJPAAnnotations property.
|
void |
setMaxRows(Integer value)
Sets the value of the maxRows property.
|
void |
setParamCastMode(ParamCastMode value)
Sets the value of the paramCastMode property.
|
void |
setParamType(ParamType value)
Sets the value of the paramType property.
|
void |
setParseUnknownFunctions(ParseUnknownFunctions value)
Sets the value of the parseUnknownFunctions property.
|
void |
setParseUnsupportedSyntax(ParseUnsupportedSyntax value)
Sets the value of the parseUnsupportedSyntax property.
|
void |
setParseWithMetaLookups(ParseWithMetaLookups value)
Sets the value of the parseWithMetaLookups property.
|
void |
setQueryTimeout(Integer value)
Sets the value of the queryTimeout property.
|
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)
Sets the value of the renderFormatting property.
|
void |
setRenderKeywordStyle(RenderKeywordStyle value)
Sets the value of the renderKeywordStyle property.
|
void |
setRenderMapping(RenderMapping value)
Sets the value of the renderMapping property.
|
void |
setRenderNameStyle(RenderNameStyle value)
Sets the value of the renderNameStyle property.
|
void |
setRenderOrderByRownumberForEmulatedPagination(Boolean value)
Sets the value of the renderOrderByRownumberForEmulatedPagination property.
|
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 |
setReturnRecordToPojo(Boolean value)
Sets the value of the returnRecordToPojo property.
|
void |
setStatementType(StatementType value)
Sets the value of the statementType property.
|
void |
setThrowExceptions(ThrowExceptions value)
Sets the value of the throwExceptions property.
|
void |
setUpdatablePrimaryKeys(Boolean value)
Sets the value of the updatablePrimaryKeys property.
|
String |
toString() |
Settings |
withAttachRecords(Boolean value) |
Settings |
withBackslashEscaping(BackslashEscaping value) |
Settings |
withCacheRecordMappers(Boolean value) |
Settings |
withDebugInfoOnStackTrace(Boolean value) |
Settings |
withDelimiter(String value) |
Settings |
withEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly(Boolean value) |
Settings |
withExecuteDeleteWithoutWhere(ExecuteWithoutWhere value) |
Settings |
withExecuteLogging(Boolean value) |
Settings |
withExecuteUpdateWithoutWhere(ExecuteWithoutWhere value) |
Settings |
withExecuteWithOptimisticLocking(Boolean value) |
Settings |
withExecuteWithOptimisticLockingExcludeUnversioned(Boolean value) |
Settings |
withFetchServerOutputSize(Integer value) |
Settings |
withFetchSize(Integer value) |
Settings |
withFetchWarnings(Boolean value) |
Settings |
withInListPadBase(Integer value) |
Settings |
withInListPadding(Boolean value) |
Settings |
withMapConstructorParameterNames(Boolean value) |
Settings |
withMapJPAAnnotations(Boolean value) |
Settings |
withMaxRows(Integer value) |
Settings |
withParamCastMode(ParamCastMode value) |
Settings |
withParamType(ParamType value) |
Settings |
withParseUnknownFunctions(ParseUnknownFunctions value) |
Settings |
withParseUnsupportedSyntax(ParseUnsupportedSyntax value) |
Settings |
withParseWithMetaLookups(ParseWithMetaLookups value) |
Settings |
withQueryTimeout(Integer value) |
Settings |
withReflectionCaching(Boolean value) |
Settings |
withRenderCatalog(Boolean value) |
Settings |
withRenderFormatted(Boolean value) |
Settings |
withRenderFormatting(RenderFormatting value) |
Settings |
withRenderKeywordStyle(RenderKeywordStyle value) |
Settings |
withRenderMapping(RenderMapping value) |
Settings |
withRenderNameStyle(RenderNameStyle value) |
Settings |
withRenderOrderByRownumberForEmulatedPagination(Boolean value) |
Settings |
withRenderScalarSubqueriesForStoredFunctions(Boolean value) |
Settings |
withRenderSchema(Boolean value) |
Settings |
withReturnAllOnUpdatableRecord(Boolean value) |
Settings |
withReturnRecordToPojo(Boolean value) |
Settings |
withStatementType(StatementType value) |
Settings |
withThrowExceptions(ThrowExceptions value) |
Settings |
withUpdatablePrimaryKeys(Boolean value) |
protected Boolean renderCatalog
protected Boolean renderSchema
protected RenderMapping renderMapping
protected RenderNameStyle renderNameStyle
protected RenderKeywordStyle renderKeywordStyle
protected Boolean renderFormatted
protected RenderFormatting renderFormatting
protected Boolean renderScalarSubqueriesForStoredFunctions
protected Boolean renderOrderByRownumberForEmulatedPagination
protected BackslashEscaping backslashEscaping
protected ParamType paramType
protected ParamCastMode paramCastMode
protected StatementType statementType
protected Boolean executeLogging
protected Boolean executeWithOptimisticLocking
protected Boolean executeWithOptimisticLockingExcludeUnversioned
protected Boolean attachRecords
protected Boolean updatablePrimaryKeys
protected Boolean reflectionCaching
protected Boolean cacheRecordMappers
protected ThrowExceptions throwExceptions
protected Boolean fetchWarnings
protected Integer fetchServerOutputSize
protected Boolean returnAllOnUpdatableRecord
protected Boolean returnRecordToPojo
protected Boolean mapJPAAnnotations
protected Boolean mapConstructorParameterNames
protected Integer queryTimeout
protected Integer maxRows
protected Integer fetchSize
protected Boolean debugInfoOnStackTrace
protected Boolean inListPadding
protected Integer inListPadBase
protected String delimiter
protected Boolean emulateOnDuplicateKeyUpdateOnPrimaryKeyOnly
protected ExecuteWithoutWhere executeUpdateWithoutWhere
protected ExecuteWithoutWhere executeDeleteWithoutWhere
protected ParseWithMetaLookups parseWithMetaLookups
protected ParseUnsupportedSyntax parseUnsupportedSyntax
protected ParseUnknownFunctions parseUnknownFunctions
public Boolean isRenderCatalog()
Use this for single-catalog environments, or when all objects are made available using synonyms
Boolean
public void setRenderCatalog(Boolean value)
value
- allowed object is
Boolean
public Boolean isRenderSchema()
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
Boolean
public void setRenderSchema(Boolean value)
value
- allowed object is
Boolean
public RenderMapping getRenderMapping()
RenderMapping
public void setRenderMapping(RenderMapping value)
value
- allowed object is
RenderMapping
public RenderNameStyle getRenderNameStyle()
This is set to "QUOTED" by default for backwards-compatibility
RenderNameStyle
public void setRenderNameStyle(RenderNameStyle value)
value
- allowed object is
RenderNameStyle
public RenderKeywordStyle getRenderKeywordStyle()
RenderKeywordStyle
public void setRenderKeywordStyle(RenderKeywordStyle value)
value
- allowed object is
RenderKeywordStyle
public Boolean isRenderFormatted()
Boolean
public void setRenderFormatted(Boolean value)
value
- allowed object is
Boolean
public RenderFormatting getRenderFormatting()
RenderFormatting
public void setRenderFormatting(RenderFormatting value)
value
- allowed object is
RenderFormatting
public Boolean isRenderScalarSubqueriesForStoredFunctions()
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.
Boolean
public void setRenderScalarSubqueriesForStoredFunctions(Boolean value)
value
- allowed object is
Boolean
public Boolean isRenderOrderByRownumberForEmulatedPagination()
ORDER BY rn
clause should be rendered on emulated paginated queries.
Older databases did not support OFFSET .. FETCH pagination, so jOOQ emulates it using derived
tables and ROWNUM
(Oracle 11g and older) or ROW_NUMBER()
(e.g. DB2,
SQL Server, etc.) filtering. While these subqueries are ordered, the ordering is not
guaranteed to be stable in the outer most queries. It may be stable (and e.g. in Oracle,
it mostly is, if queries are not parallel, or joined to other queries, etc.), so the excess
ORDER BY
clause may add some additional performance overhead. This setting forces
jOOQ to not generate the additional ORDER BY
clause.
For details, see https://github.com/jOOQ/jOOQ/issues/7609.
Boolean
public void setRenderOrderByRownumberForEmulatedPagination(Boolean value)
value
- allowed object is
Boolean
public BackslashEscaping getBackslashEscaping()
BackslashEscaping
public void setBackslashEscaping(BackslashEscaping value)
value
- allowed object is
BackslashEscaping
public ParamType getParamType()
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
ParamType
public void setParamType(ParamType value)
value
- allowed object is
ParamType
public ParamCastMode getParamCastMode()
ParamCastMode
public void setParamCastMode(ParamCastMode value)
value
- allowed object is
ParamCastMode
public StatementType getStatementType()
StatementType
public void setStatementType(StatementType value)
value
- allowed object is
StatementType
public Boolean isExecuteLogging()
Boolean
public void setExecuteLogging(Boolean value)
value
- allowed object is
Boolean
public Boolean isExecuteWithOptimisticLocking()
Boolean
public void setExecuteWithOptimisticLocking(Boolean value)
value
- allowed object is
Boolean
public Boolean isExecuteWithOptimisticLockingExcludeUnversioned()
This flag has no effect when "executeWithOptimisticLocking" is turned off.
Boolean
public void setExecuteWithOptimisticLockingExcludeUnversioned(Boolean value)
value
- allowed object is
Boolean
public Boolean isAttachRecords()
Boolean
public void setAttachRecords(Boolean value)
value
- allowed object is
Boolean
public Boolean isUpdatablePrimaryKeys()
Setting this to "true" will allow for updating primary key values through UpdatableRecord.store() and UpdatableRecord.update().
Boolean
public void setUpdatablePrimaryKeys(Boolean value)
value
- allowed object is
Boolean
public Boolean isReflectionCaching()
Boolean
public void setReflectionCaching(Boolean value)
value
- allowed object is
Boolean
public Boolean isCacheRecordMappers()
Boolean
public void setCacheRecordMappers(Boolean value)
value
- allowed object is
Boolean
public ThrowExceptions getThrowExceptions()
ThrowExceptions
public void setThrowExceptions(ThrowExceptions value)
value
- allowed object is
ThrowExceptions
public Boolean isFetchWarnings()
Boolean
public void setFetchWarnings(Boolean value)
value
- allowed object is
Boolean
public Integer getFetchServerOutputSize()
Integer
public void setFetchServerOutputSize(Integer value)
value
- allowed object is
Integer
public Boolean isReturnAllOnUpdatableRecord()
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.
Boolean
public void setReturnAllOnUpdatableRecord(Boolean value)
value
- allowed object is
Boolean
public Boolean isReturnRecordToPojo()
Boolean
public void setReturnRecordToPojo(Boolean value)
value
- allowed object is
Boolean
public Boolean isMapJPAAnnotations()
Boolean
public void setMapJPAAnnotations(Boolean value)
value
- allowed object is
Boolean
public Boolean isMapConstructorParameterNames()
Boolean
public void setMapConstructorParameterNames(Boolean value)
value
- allowed object is
Boolean
public Integer getQueryTimeout()
Integer
public void setQueryTimeout(Integer value)
value
- allowed object is
Integer
public Integer getMaxRows()
Integer
public void setMaxRows(Integer value)
value
- allowed object is
Integer
public Integer getFetchSize()
Integer
public void setFetchSize(Integer value)
value
- allowed object is
Integer
public Boolean isDebugInfoOnStackTrace()
Boolean
public void setDebugInfoOnStackTrace(Boolean value)
value
- allowed object is
Boolean
public Boolean isInListPadding()
Boolean
public void setInListPadding(Boolean value)
value
- allowed object is
Boolean
public Integer getInListPadBase()
Integer
public void setInListPadBase(Integer value)
value
- allowed object is
Integer
public String getDelimiter()
String
public void setDelimiter(String value)
value
- allowed object is
String
public Boolean isEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly()
Boolean
public void setEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly(Boolean value)
value
- allowed object is
Boolean
public ExecuteWithoutWhere getExecuteUpdateWithoutWhere()
ExecuteWithoutWhere
public void setExecuteUpdateWithoutWhere(ExecuteWithoutWhere value)
value
- allowed object is
ExecuteWithoutWhere
public ExecuteWithoutWhere getExecuteDeleteWithoutWhere()
ExecuteWithoutWhere
public void setExecuteDeleteWithoutWhere(ExecuteWithoutWhere value)
value
- allowed object is
ExecuteWithoutWhere
public ParseWithMetaLookups getParseWithMetaLookups()
ParseWithMetaLookups
public void setParseWithMetaLookups(ParseWithMetaLookups value)
value
- allowed object is
ParseWithMetaLookups
public ParseUnsupportedSyntax getParseUnsupportedSyntax()
ParseUnsupportedSyntax
public void setParseUnsupportedSyntax(ParseUnsupportedSyntax value)
value
- allowed object is
ParseUnsupportedSyntax
public ParseUnknownFunctions getParseUnknownFunctions()
ParseUnknownFunctions
public void setParseUnknownFunctions(ParseUnknownFunctions value)
value
- allowed object is
ParseUnknownFunctions
public Settings withRenderMapping(RenderMapping value)
public Settings withRenderNameStyle(RenderNameStyle value)
public Settings withRenderKeywordStyle(RenderKeywordStyle value)
public Settings withRenderFormatting(RenderFormatting value)
public Settings withRenderScalarSubqueriesForStoredFunctions(Boolean value)
public Settings withRenderOrderByRownumberForEmulatedPagination(Boolean value)
public Settings withBackslashEscaping(BackslashEscaping value)
public Settings withParamCastMode(ParamCastMode value)
public Settings withStatementType(StatementType value)
public Settings withExecuteWithOptimisticLockingExcludeUnversioned(Boolean value)
public Settings withThrowExceptions(ThrowExceptions value)
public Settings withEmulateOnDuplicateKeyUpdateOnPrimaryKeyOnly(Boolean value)
public Settings withExecuteUpdateWithoutWhere(ExecuteWithoutWhere value)
public Settings withExecuteDeleteWithoutWhere(ExecuteWithoutWhere value)
public Settings withParseWithMetaLookups(ParseWithMetaLookups value)
public Settings withParseUnsupportedSyntax(ParseUnsupportedSyntax value)
public Settings withParseUnknownFunctions(ParseUnknownFunctions value)
Copyright © 2019. All rights reserved.