Skip to Content
Last modified by christoph_lechleitner@iteg_at on 2022-06-09 01.08:27
Show last authors
1 = {{id name="FulllistofJDBCProviderConfigurationKeys-Introduction"/}}Introduction =
2
3 In most usecases, only the required configuration keys of DataSources will be used: {{code language="none"}}url{{/code}}, {{code language="none"}}username{{/code}}, {{code language="none"}}password{{/code}}, {{code language="none"}}validationQuery{{/code}}.
4
5 The following chapter provides a full list of supported key name patterns.
6
7 = {{id name="FulllistofJDBCProviderConfigurationKeys-Fullistoforg.clazzes.jdbc.providerdatasourceconfigurationkeys"/}}Ful list of org.clazzes.jdbc.provider datasource configuration keys =
8
9 The JDBC-Provider supplies applications with Instances of [[org.apache.commons.dbcp.BasicDataSource>>url:https://commons.apache.org/proper/commons-dbcp/api-1.4/org/apache/commons/dbcp/BasicDataSource.html||shape="rect"]] from Apache's commons-dbcp project in Version 1.x, version 2.x of JDBC-Provider uses commons-dbcp2's [[org.apache.commons.dbcp2.BasicDataSource>>url:https://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp2/BasicDataSource.html||shape="rect"]], therefore most values go right into it's setters.
10
11 |=(((
12 (% class="tablesorter-header-inner" %)
13 (((
14 Key
15 )))
16 )))|=(((
17 (% class="tablesorter-header-inner" %)
18 (((
19 Description
20 )))
21 )))|=(((
22 JDBC-Provider Version
23 )))
24 |(((
25 {{code language="none"}}
26 accessToUnderlyingConnectionAllowed
27 {{/code}}
28 )))|(((
29 Should not matter. Changes have no effect after pool initialization.
30 )))|(((
31 1.x and 2.x
32 )))
33 |(((
34 {{code language="none"}}
35 connectionInitSqls
36 {{/code}}
37 )))|(((
38 (% style="color: rgb(0,0,0);" %)List of SQL Statements to be executed when a physical connection is first created. Comma separated. Changes have no effect after pool initialization.
39 )))|(((
40 1.x and 2.x
41 )))
42 |(((
43 {{code language="none"}}
44 connectionProperties
45 {{/code}}
46 )))|(((
47 Connection properties.
48 )))|(((
49 1.x and 2.x
50 )))
51 |(((
52 {{code language="none"}}
53 defaultAutoCommit
54 {{/code}}
55 )))|(((
56 Default autocommit state. Should not matter for well-designed applications. Changes have no effect after pool initialization.
57 )))|(((
58 1.x and 2.x
59 )))
60 |(((
61 {{code language="none"}}
62 defaultCatalog
63 {{/code}}
64 )))|(((
65 Default catalog name. Changes have no effect after pool initialization.
66 )))|(((
67 1.x and 2.x
68 )))
69 |(((
70 {{code language="none"}}
71 defaultReadOnly
72 {{/code}}
73 )))|(((
74 Changes have no effect after pool initialization.
75 )))|(((
76 1.x and 2.x
77 )))
78 |(((
79 {{code language="none"}}
80 defaultTransactionIsolation
81 {{/code}}
82 )))|(((
83 Changes have no effect after pool initialization.
84 )))|(((
85 1.x and 2.x
86 )))
87 |(((
88 {{code language="none"}}
89 driverClassName
90 {{/code}}
91 )))|(((
92 Optional for common database backends. Name of the database driver to use.
93
94 For MySQL, MSSQL, PostgreSQL and Oracle the driver class name is automatically deduced from the JDBC URL.
95
96 The class is resolved using the(% style="line-height: 1.4285715;" %) class loader of the jdbc-provider bundle.
97 This allows for putting JDBC driver on the boot classloader of the OSGi container or creating fragment bundles, which supply JDBC drivers to the jdbc-provider bundle.
98 )))|(((
99 1.x and 2.x
100 )))
101 |(((
102 {{code language="none"}}
103 initialSize
104 {{/code}}
105 )))|(((
106 Initial size of the pool. Changes have no effect after pool initialization.
107 )))|(((
108 1.x and 2.x
109 )))
110 |(((
111 {{code language="none"}}
112 maxActive
113 {{/code}}
114 )))|(((
115 (% style="color: rgb(0,0,0);" %)Maximum number of active connections that can be allocated at the same time. Use a negative value for no limit.
116 )))|(((
117 1.x
118 )))
119 |(((
120 {{code language="none"}}
121 maxTotal
122 {{/code}}
123 )))|(((
124 (% style="color: rgb(71,71,71);" %)Maximum number of active connections that can be allocated at the same time.
125 )))|(((
126 2.x, if this value is not set, the value of {{code language="none"}}maxActive{{/code}} will be taken for compatibility reasons.
127 )))
128 |(((
129 {{code language="none"}}
130 fastFailValidation
131 {{/code}}
132 )))|(((
133 Whether conenctions with previous SQL states indicating a server dconnect are immediately evicted.
134 )))|(((
135 2.x
136 )))
137 |(((
138 {{code language="none"}}
139 maxConnLifetimeMillis
140 {{/code}}
141 )))|(((
142 Maximal connection lifetime in milliseconds
143 )))|(((
144 2.x
145 )))
146 |(((
147 {{code language="none"}}
148 maxIdle
149 {{/code}}
150 )))|(((
151 (% style="color: rgb(0,0,0);" %)Maximum number of connections that can remain idle in the pool.
152 )))|(((
153 1.x and 2.x
154 )))
155 |(((
156 {{code language="none"}}
157 maxOpenPreparedStatement
158 {{/code}}
159 )))|(((
160 Maximum number of PreparedStatements to pool. (% style="color: rgb(0,0,0);" %)Use a negative value for no limit. (%%)Changes have no effect after pool initialization.
161 )))|(((
162 1.x and 2.x
163 )))
164 |(((
165 {{code language="none"}}
166 maxWait
167 {{/code}}
168 )))|(((
169 (% style="color: rgb(0, 0, 0); color: rgb(71, 71, 71)" %)The maximum number of milliseconds that the pool will wait for a connection to be returned before throwing an exception. (% style="color: rgb(0,0,0);" %)Use a negative value for no limit.
170 )))|(((
171 1.x
172 )))
173 |(((
174 {{code language="none"}}
175 maxWaitMillis
176 {{/code}}
177 )))|(((
178 The same value as {{code language="none"}}maxWait{{/code}}, but for Version 2.x
179 )))|(((
180 2.x, if this value is not set, the value of {{code language="none"}}maxWait{{/code}} will be taken for compatibility reasons.
181 )))
182 |(((
183 {{code language="none"}}
184 minEvictableIdleTimeMillis
185 {{/code}}
186 )))|(((
187 (% style="color: rgb(0,0,0);" %)Minimum amount of time an object may sit idle in the pool.
188 )))|(((
189 1.x and 2.x
190 )))
191 |(((
192 {{code language="none"}}
193 minIdle
194 {{/code}}
195 )))|(((
196 (% style="color: rgb(0,0,0);" %)Minimum number of idle connections in the pool.
197 )))|(((
198 1.x and 2.x
199 )))
200 |(((
201 {{code language="none"}}
202 password
203 {{/code}}
204 )))|(((
205 Required. JDBC Password. Changes have no effect after pool initialization.
206 )))|(((
207 1.x and 2.x
208 )))
209 |(((
210 {{code language="none"}}
211 poolPreparedStatements
212 {{/code}}
213 )))|(((
214 (% style="color: rgb(0,0,0);" %)Whether to pool statements or not. Changes have no effect after pool initialization.
215 )))|(((
216 1.x and 2.x
217 )))
218 |(((
219 {{code language="none"}}
220 removeAbandoned
221 {{/code}}
222 )))|(((
223 Whether abandoned (blocking) queries will be removed form the pool. This is a last-resort option, which has the potential to also evict long-running "ordinary" query.
224 )))|(((
225 1.x
226 )))
227 |(((
228 ##(% style="color: rgb(53,56,51);" %)removeAbandonedOnBorrow(%%)##
229 )))|(((
230 Whether abandoned (blocking) queries will be removed form the pool on connection borrow.
231 )))|(((
232 2.x
233 )))
234 |(((
235 ##(% style="color: rgb(53,56,51);" %)removeAbandonedOnMaintenance(%%)##
236 )))|(((
237 Whether abandoned (blocking) queries will be removed form the pool during pool maintenance.
238 )))|(((
239 2.x
240 )))
241 |(((
242 {{code language="none"}}
243 removeAbandonedTimeout
244 {{/code}}
245 )))|(((
246 The timeout in second after which a long-running query is considered as abandoned.
247 )))|(((
248 1.x and 2.x
249 )))
250 |(((
251 {{code language="none"}}
252 testOnBorrow
253 {{/code}}
254 )))|(((
255 Wether the validation query shall be executed before each "borrow" from the pool.
256 )))|(((
257 1.x and 2.x
258 )))
259 |(((
260 {{code language="none"}}
261 testOnReturn
262 {{/code}}
263 )))|(((
264 Wether the validation query shall be executed when a connection is returned to the pool.
265 )))|(((
266 1.x and 2.x
267 )))
268 |(((
269 {{code language="none"}}
270 testOnCreate
271 {{/code}}
272 )))|(((
273 Whether the validation query will be run immediately after the conenction creation.
274 )))|(((
275 2.x
276 )))
277 |(((
278 {{code language="none"}}
279 testWhileIdle
280 {{/code}}
281 )))|(((
282 Wether the validation query shall be executed regularily to keep the connection alive.
283 )))|(((
284 1.x and 2.x
285 )))
286 |(((
287 {{code language="none"}}
288 timeBetweenEvictionRunsMillis
289 {{/code}}
290 )))|(((
291 The time in milliseconds between two runs of the IDLE evictor Runnable.
292 )))|(((
293 1.x and 2.x
294 )))
295 |(((
296 {{code language="none"}}
297 url
298 {{/code}}
299 )))|(((
300 Required. JDBC URL. JDBC URL examples for common databases can be found in our [[doc:KH.Database Tips.JDBC Snippets.WebHome]]. Changes have no effect after pool initialization.
301 )))|(((
302 1.x and 2.x
303 )))
304 |(((
305 {{code language="none"}}
306 username
307 {{/code}}
308 )))|(((
309 Required. JDBC User. Changes have no effect after pool initialization.
310 )))|(((
311 1.x and 2.x
312 )))
313 |(((
314 {{code language="none"}}
315 validationQuery
316 {{/code}}
317 )))|(((
318 Required. Validation query, executed to ensure the application receives a valid connection.
319 Common validation queries can be found in our [[doc:KH.Database Tips.JDBC Snippets.WebHome]].
320 )))|(((
321 1.x and 2.x
322 )))
323
324 For more supported key patterns take a look at the JavaDoc of the [[org.clazzes.util.jdbc.provider.JdbcProvider>>url:http://svn.clazzes.org/svn/util/trunk/jdbc-provider/src/main/java/org/clazzes/util/jdbc/provider/JdbcProvider.java||shape="rect"]] class, i.e. [[JdbcProvider.html>>url:https://maven-snapshots.clazzes.org/javadoc/org.clazzes.util/jdbc-provider/apidocs/org/clazzes/util/jdbc/provider/JdbcProvider.html||shape="rect"]].
325
326 Typical JDBC URLs and validation queries can be found in our [[doc:KH.Database Tips.JDBC Snippets.WebHome]].