Skip to Content
Last modified by christoph_lechleitner@iteg_at on 2022-06-09 01.08:27
From version 4.1
edited by christoph_lechleitner@iteg_at
on 2022-06-09 01.08:27
Change comment: Link to online javadoc
To version 1.1
edited by christoph_lechleitner@iteg_at
on 2013-07-09 04.05:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,7 +6,7 @@
6 6  
7 7  = {{id name="FulllistofJDBCProviderConfigurationKeys-Fullistoforg.clazzes.jdbc.providerdatasourceconfigurationkeys"/}}Ful list of org.clazzes.jdbc.provider datasource configuration keys =
8 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.
9 +The JDBC-Provider supplies applications with Instances of [[org.apache.commons.dbcp.BasicDataSource>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html||shape="rect"]] from Apache's commons-dbcp project, therefore most values go right into it's setters.
10 10  
11 11  |=(((
12 12  (% class="tablesorter-header-inner" %)
... ... @@ -19,74 +19,60 @@
19 19  Description
20 20  )))
21 21  )))|=(((
22 -JDBC-Provider Version
22 +Ac. BasicDataSource setter
23 23  )))
24 24  |(((
25 -{{code language="none"}}
26 26  accessToUnderlyingConnectionAllowed
27 -{{/code}}
28 28  )))|(((
29 29  Should not matter. Changes have no effect after pool initialization.
30 30  )))|(((
31 -1.x and 2.x
29 +[[setAccessToUnderlyingConnectionAllowed(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setAccessToUnderlyingConnectionAllowed(boolean)||shape="rect"]]
32 32  )))
33 33  |(((
34 -{{code language="none"}}
35 35  connectionInitSqls
36 -{{/code}}
37 37  )))|(((
38 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 39  )))|(((
40 -1.x and 2.x
36 +[[setConnectionInitSqls(Collection)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setConnectionInitSqls(java.util.Collection)||shape="rect"]]
41 41  )))
42 42  |(((
43 -{{code language="none"}}
44 44  connectionProperties
45 -{{/code}}
46 46  )))|(((
47 47  Connection properties.
48 48  )))|(((
49 -1.x and 2.x
43 +[[setConnectionProperties(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setConnectionProperties(java.lang.String)||shape="rect"]]
50 50  )))
51 51  |(((
52 -{{code language="none"}}
53 53  defaultAutoCommit
54 -{{/code}}
55 55  )))|(((
56 56  Default autocommit state. Should not matter for well-designed applications. Changes have no effect after pool initialization.
57 57  )))|(((
58 -1.x and 2.x
50 +[[setDefaultAutoCommit(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setDefaultAutoCommit(boolean)||shape="rect"]]
59 59  )))
60 60  |(((
61 -{{code language="none"}}
62 62  defaultCatalog
63 -{{/code}}
64 64  )))|(((
65 65  Default catalog name. Changes have no effect after pool initialization.
66 66  )))|(((
67 -1.x and 2.x
57 +[[setDefaultCatalog(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setDefaultCatalog(java.lang.String)||shape="rect"]]
68 68  )))
69 69  |(((
70 -{{code language="none"}}
71 71  defaultReadOnly
72 -{{/code}}
73 73  )))|(((
74 74  Changes have no effect after pool initialization.
75 75  )))|(((
76 -1.x and 2.x
64 +[[setDefaultReadOnly(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setDefaultReadOnly(boolean)||shape="rect"]]
77 77  )))
78 78  |(((
79 -{{code language="none"}}
80 80  defaultTransactionIsolation
81 -{{/code}}
82 82  )))|(((
83 83  Changes have no effect after pool initialization.
84 84  )))|(((
85 -1.x and 2.x
71 +[[setDefaultTransactionIsolation(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setDefaultTransactionIsolation(int)||shape="rect"]]
86 86  )))
87 87  |(((
88 88  {{code language="none"}}
89 -driverClassName
75 +datasource.<datasourcename>.driverClassName
90 90  {{/code}}
91 91  )))|(((
92 92  Optional for common database backends. Name of the database driver to use.
... ... @@ -96,231 +96,144 @@
96 96  The class is resolved using the(% style="line-height: 1.4285715;" %) class loader of the jdbc-provider bundle.
97 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 98  )))|(((
99 -1.x and 2.x
85 +[[setDriverClassName(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setDriverClassName(java.lang.String)||shape="rect"]]
100 100  )))
101 101  |(((
102 -{{code language="none"}}
103 103  initialSize
104 -{{/code}}
105 105  )))|(((
106 106  Initial size of the pool. Changes have no effect after pool initialization.
107 107  )))|(((
108 -1.x and 2.x
92 +[[setInitialSize(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setInitialSize(int)||shape="rect"]]
109 109  )))
110 110  |(((
111 -{{code language="none"}}
112 112  maxActive
113 -{{/code}}
114 114  )))|(((
115 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 116  )))|(((
117 -1.x
99 +[[setMaxActive(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMaxActive(int)||shape="rect"]]
118 118  )))
119 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 148  maxIdle
149 -{{/code}}
150 150  )))|(((
151 151  (% style="color: rgb(0,0,0);" %)Maximum number of connections that can remain idle in the pool.
152 152  )))|(((
153 -1.x and 2.x
106 +[[setMaxIdle(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMaxIdle(int)||shape="rect"]]
154 154  )))
155 155  |(((
156 -{{code language="none"}}
157 157  maxOpenPreparedStatement
158 -{{/code}}
159 159  )))|(((
160 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 161  )))|(((
162 -1.x and 2.x
113 +[[setMaxOpenPreparedStatements(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMaxOpenPreparedStatements(int)||shape="rect"]]
163 163  )))
164 164  |(((
165 -{{code language="none"}}
166 166  maxWait
167 -{{/code}}
168 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.
118 +(% style="color: rgb(0,0,0);" %)Use a negative value for no limit.
170 170  )))|(((
171 -1.x
120 +[[setMaxWait(long)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMaxWait(long)||shape="rect"]]
172 172  )))
173 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 184  minEvictableIdleTimeMillis
185 -{{/code}}
186 186  )))|(((
187 187  (% style="color: rgb(0,0,0);" %)Minimum amount of time an object may sit idle in the pool.
188 188  )))|(((
189 -1.x and 2.x
127 +[[setMinEvictableIdleTimeMillis(long)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMinEvictableIdleTimeMillis(long)||shape="rect"]]
190 190  )))
191 191  |(((
192 -{{code language="none"}}
193 193  minIdle
194 -{{/code}}
195 195  )))|(((
196 196  (% style="color: rgb(0,0,0);" %)Minimum number of idle connections in the pool.
197 197  )))|(((
198 -1.x and 2.x
134 +[[setMinIdle(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMinIdle(int)||shape="rect"]]
199 199  )))
200 200  |(((
201 201  {{code language="none"}}
202 -password
138 +datasource.<datasourcename>.password
203 203  {{/code}}
204 204  )))|(((
205 205  Required. JDBC Password. Changes have no effect after pool initialization.
206 206  )))|(((
207 -1.x and 2.x
143 +[[setPassword(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setPassword(java.lang.String)||shape="rect"]]
208 208  )))
209 209  |(((
210 -{{code language="none"}}
211 211  poolPreparedStatements
212 -{{/code}}
213 213  )))|(((
214 214  (% style="color: rgb(0,0,0);" %)Whether to pool statements or not. Changes have no effect after pool initialization.
215 215  )))|(((
216 -1.x and 2.x
150 +[[setPoolPreparedStatements(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setPoolPreparedStatements(boolean)||shape="rect"]]
217 217  )))
218 218  |(((
219 -{{code language="none"}}
220 220  removeAbandoned
221 -{{/code}}
222 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.
155 +-
224 224  )))|(((
225 -1.x
157 +[[setRemoveAbandoned(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setRemoveAbandoned(boolean)||shape="rect"]]
226 226  )))
227 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 243  removeAbandonedTimeout
244 -{{/code}}
245 245  )))|(((
246 -The timeout in second after which a long-running query is considered as abandoned.
162 +-
247 247  )))|(((
248 -1.x and 2.x
164 +[[setRemoveAbandonedTimeout(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setRemoveAbandonedTimeout(int)||shape="rect"]]
249 249  )))
250 250  |(((
251 -{{code language="none"}}
252 252  testOnBorrow
253 -{{/code}}
254 254  )))|(((
255 255  Wether the validation query shall be executed before each "borrow" from the pool.
256 256  )))|(((
257 -1.x and 2.x
171 +[[setTestOnBorrow(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setTestOnBorrow(boolean)||shape="rect"]]
258 258  )))
259 259  |(((
260 -{{code language="none"}}
261 261  testOnReturn
262 -{{/code}}
263 263  )))|(((
264 264  Wether the validation query shall be executed when a connection is returned to the pool.
265 265  )))|(((
266 -1.x and 2.x
178 +[[setTestOnReturn(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setTestOnReturn(boolean)||shape="rect"]]
267 267  )))
268 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 279  testWhileIdle
280 -{{/code}}
281 281  )))|(((
282 282  Wether the validation query shall be executed regularily to keep the connection alive.
283 283  )))|(((
284 -1.x and 2.x
185 +[[setTestWhileIdle(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setTestWhileIdle(boolean)||shape="rect"]]
285 285  )))
286 286  |(((
287 -{{code language="none"}}
288 288  timeBetweenEvictionRunsMillis
289 -{{/code}}
290 290  )))|(((
291 -The time in milliseconds between two runs of the IDLE evictor Runnable.
190 +-
292 292  )))|(((
293 -1.x and 2.x
192 +[[setTimeBetweenEvictionRunsMillis(long)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setTimeBetweenEvictionRunsMillis(long)||shape="rect"]]
294 294  )))
295 295  |(((
296 296  {{code language="none"}}
297 -url
196 +datasource.<datasourcename>.url
298 298  {{/code}}
299 299  )))|(((
300 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 301  )))|(((
302 -1.x and 2.x
201 +[[setUrl(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setUrl(java.lang.String)||shape="rect"]]
303 303  )))
304 304  |(((
305 305  {{code language="none"}}
306 -username
205 +datasource.<datasourcename>.username
307 307  {{/code}}
308 308  )))|(((
309 309  Required. JDBC User. Changes have no effect after pool initialization.
310 310  )))|(((
311 -1.x and 2.x
210 +[[setUsername(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setUsername(java.lang.String)||shape="rect"]]
312 312  )))
313 313  |(((
314 314  {{code language="none"}}
315 -validationQuery
214 +datasource.<datasourcename>.validationQuery
316 316  {{/code}}
317 317  )))|(((
318 318  Required. Validation query, executed to ensure the application receives a valid connection.
319 319  Common validation queries can be found in our [[doc:KH.Database Tips.JDBC Snippets.WebHome]].
320 320  )))|(((
321 -1.x and 2.x
220 +[[setValidationQuery(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setValidationQuery(java.lang.String)||shape="rect"]]
322 322  )))
323 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"]].
223 +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.
325 325  
326 326  Typical JDBC URLs and validation queries can be found in our [[doc:KH.Database Tips.JDBC Snippets.WebHome]].
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -689731
1 +689898
URL
... ... @@ -1,1 +1,1 @@
1 -https://clazzes.atlassian.net/wiki/spaces/UTIL/pages/689731/Full list of JDBC Provider Configuration Keys
1 +https://clazzes.atlassian.net/wiki/spaces/UTIL/pages/689898/Full list of JDBC Provider Configuration Keys