github/jooq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[jOOQ/jOOQ#9977] Add more thread safety documentation around DSLContext

Browse Source 
and Configuration
This commit is contained in:
Lukas Eder 2020-03-20 10:07:37 +01:00
parent 5aee77f86c
commit d246fc2b19
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
jOOQ/src/main/java/org/jooq/Configuration.java
View File

@ -81,15 +81,6 @@ import org.jooq.tools.StopWatchListener;
* <li>by a {@link Query} or {@link Routine} object to execute themselves</li>
* </ul>
* <p>
* The simplest usage of a <code>Configuration</code> instance is to use it
* exactly for a single <code>Query</code> execution, disposing it immediately.
* This will make it very simple to implement thread-safe behaviour.
* <p>
* At the same time, jOOQ does not require <code>Configuration</code> instances
* to be that short-lived. Thread-safety will then be delegated to component
* objects, such as the {@link ConnectionProvider}, the {@link ExecuteListener}
* list, etc.
* <p>
* A <code>Configuration</code> is composed of types composing its state and of
* SPIs:
* <h3>Types composing its state:</h3>
@ -184,6 +175,25 @@ import org.jooq.tools.StopWatchListener;
* </ul>
* </li>
* </ul>
* <p>
* <h3>Thread safety</h3>
* <p>
* The simplest usage of a <code>Configuration</code> instance is to use it
* exactly for a single <code>Query</code> execution, disposing it immediately.
* This will make it very simple to implement thread-safe behaviour, but
* reflection caches will not be used optimally, e.g. when using
* {@link DefaultRecordMapper}.
* <p>
* At the same time, jOOQ does not require <code>Configuration</code> instances
* to be that short-lived. Thread-safety will then be delegated to component
* objects, such as the {@link ConnectionProvider}, the {@link ExecuteListener}
* list, etc.
* <p>
* For a {@link Configuration} to be used in a thread safe way, all
* <code>set()</code> methods must be avoided post initialisation, and
* {@link #settings()} must not be modified either. If you wish to create a
* derived configuration for local usage, with some configuration parts changed,
* use the various <code>derive()</code> methods, instead.
*
* @author Lukas Eder
*/