Skip to Content
Last modified by christoph_lechleitner@iteg_at on 2022-06-09 01.08:27
From 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
To version 4.1
edited by christoph_lechleitner@iteg_at
on 2022-06-09 01.08:27
Change comment: Link to online javadoc

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: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.
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 10  
11 11  |=(((
12 12  (% class="tablesorter-header-inner" %)
... ... @@ -19,60 +19,74 @@
19 19  Description
20 20  )))
21 21  )))|=(((
22 -Ac. BasicDataSource setter
22 +JDBC-Provider Version
23 23  )))
24 24  |(((
25 +{{code language="none"}}
25 25  accessToUnderlyingConnectionAllowed
27 +{{/code}}
26 26  )))|(((
27 27  Should not matter. Changes have no effect after pool initialization.
28 28  )))|(((
29 -[[setAccessToUnderlyingConnectionAllowed(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setAccessToUnderlyingConnectionAllowed(boolean)||shape="rect"]]
31 +1.x and 2.x
30 30  )))
31 31  |(((
34 +{{code language="none"}}
32 32  connectionInitSqls
36 +{{/code}}
33 33  )))|(((
34 34  (% 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.
35 35  )))|(((
36 -[[setConnectionInitSqls(Collection)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setConnectionInitSqls(java.util.Collection)||shape="rect"]]
40 +1.x and 2.x
37 37  )))
38 38  |(((
43 +{{code language="none"}}
39 39  connectionProperties
45 +{{/code}}
40 40  )))|(((
41 41  Connection properties.
42 42  )))|(((
43 -[[setConnectionProperties(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setConnectionProperties(java.lang.String)||shape="rect"]]
49 +1.x and 2.x
44 44  )))
45 45  |(((
52 +{{code language="none"}}
46 46  defaultAutoCommit
54 +{{/code}}
47 47  )))|(((
48 48  Default autocommit state. Should not matter for well-designed applications. Changes have no effect after pool initialization.
49 49  )))|(((
50 -[[setDefaultAutoCommit(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setDefaultAutoCommit(boolean)||shape="rect"]]
58 +1.x and 2.x
51 51  )))
52 52  |(((
61 +{{code language="none"}}
53 53  defaultCatalog
63 +{{/code}}
54 54  )))|(((
55 55  Default catalog name. Changes have no effect after pool initialization.
56 56  )))|(((
57 -[[setDefaultCatalog(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setDefaultCatalog(java.lang.String)||shape="rect"]]
67 +1.x and 2.x
58 58  )))
59 59  |(((
70 +{{code language="none"}}
60 60  defaultReadOnly
72 +{{/code}}
61 61  )))|(((
62 62  Changes have no effect after pool initialization.
63 63  )))|(((
64 -[[setDefaultReadOnly(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setDefaultReadOnly(boolean)||shape="rect"]]
76 +1.x and 2.x
65 65  )))
66 66  |(((
79 +{{code language="none"}}
67 67  defaultTransactionIsolation
81 +{{/code}}
68 68  )))|(((
69 69  Changes have no effect after pool initialization.
70 70  )))|(((
71 -[[setDefaultTransactionIsolation(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setDefaultTransactionIsolation(int)||shape="rect"]]
85 +1.x and 2.x
72 72  )))
73 73  |(((
74 74  {{code language="none"}}
75 -datasource.<datasourcename>.driverClassName
89 +driverClassName
76 76  {{/code}}
77 77  )))|(((
78 78  Optional for common database backends. Name of the database driver to use.
... ... @@ -82,144 +82,231 @@
82 82  The class is resolved using the(% style="line-height: 1.4285715;" %) class loader of the jdbc-provider bundle.
83 83  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.
84 84  )))|(((
85 -[[setDriverClassName(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setDriverClassName(java.lang.String)||shape="rect"]]
99 +1.x and 2.x
86 86  )))
87 87  |(((
102 +{{code language="none"}}
88 88  initialSize
104 +{{/code}}
89 89  )))|(((
90 90  Initial size of the pool. Changes have no effect after pool initialization.
91 91  )))|(((
92 -[[setInitialSize(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setInitialSize(int)||shape="rect"]]
108 +1.x and 2.x
93 93  )))
94 94  |(((
111 +{{code language="none"}}
95 95  maxActive
113 +{{/code}}
96 96  )))|(((
97 97  (% 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.
98 98  )))|(((
99 -[[setMaxActive(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMaxActive(int)||shape="rect"]]
117 +1.x
100 100  )))
101 101  |(((
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"}}
102 102  maxIdle
149 +{{/code}}
103 103  )))|(((
104 104  (% style="color: rgb(0,0,0);" %)Maximum number of connections that can remain idle in the pool.
105 105  )))|(((
106 -[[setMaxIdle(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMaxIdle(int)||shape="rect"]]
153 +1.x and 2.x
107 107  )))
108 108  |(((
156 +{{code language="none"}}
109 109  maxOpenPreparedStatement
158 +{{/code}}
110 110  )))|(((
111 111  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.
112 112  )))|(((
113 -[[setMaxOpenPreparedStatements(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMaxOpenPreparedStatements(int)||shape="rect"]]
162 +1.x and 2.x
114 114  )))
115 115  |(((
165 +{{code language="none"}}
116 116  maxWait
167 +{{/code}}
117 117  )))|(((
118 -(% style="color: rgb(0,0,0);" %)Use a negative value for no limit.
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.
119 119  )))|(((
120 -[[setMaxWait(long)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMaxWait(long)||shape="rect"]]
171 +1.x
121 121  )))
122 122  |(((
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"}}
123 123  minEvictableIdleTimeMillis
185 +{{/code}}
124 124  )))|(((
125 125  (% style="color: rgb(0,0,0);" %)Minimum amount of time an object may sit idle in the pool.
126 126  )))|(((
127 -[[setMinEvictableIdleTimeMillis(long)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMinEvictableIdleTimeMillis(long)||shape="rect"]]
189 +1.x and 2.x
128 128  )))
129 129  |(((
192 +{{code language="none"}}
130 130  minIdle
194 +{{/code}}
131 131  )))|(((
132 132  (% style="color: rgb(0,0,0);" %)Minimum number of idle connections in the pool.
133 133  )))|(((
134 -[[setMinIdle(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setMinIdle(int)||shape="rect"]]
198 +1.x and 2.x
135 135  )))
136 136  |(((
137 137  {{code language="none"}}
138 -datasource.<datasourcename>.password
202 +password
139 139  {{/code}}
140 140  )))|(((
141 141  Required. JDBC Password. Changes have no effect after pool initialization.
142 142  )))|(((
143 -[[setPassword(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setPassword(java.lang.String)||shape="rect"]]
207 +1.x and 2.x
144 144  )))
145 145  |(((
210 +{{code language="none"}}
146 146  poolPreparedStatements
212 +{{/code}}
147 147  )))|(((
148 148  (% style="color: rgb(0,0,0);" %)Whether to pool statements or not. Changes have no effect after pool initialization.
149 149  )))|(((
150 -[[setPoolPreparedStatements(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setPoolPreparedStatements(boolean)||shape="rect"]]
216 +1.x and 2.x
151 151  )))
152 152  |(((
219 +{{code language="none"}}
153 153  removeAbandoned
221 +{{/code}}
154 154  )))|(((
155 --
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.
156 156  )))|(((
157 -[[setRemoveAbandoned(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setRemoveAbandoned(boolean)||shape="rect"]]
225 +1.x
158 158  )))
159 159  |(((
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"}}
160 160  removeAbandonedTimeout
244 +{{/code}}
161 161  )))|(((
162 --
246 +The timeout in second after which a long-running query is considered as abandoned.
163 163  )))|(((
164 -[[setRemoveAbandonedTimeout(int)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setRemoveAbandonedTimeout(int)||shape="rect"]]
248 +1.x and 2.x
165 165  )))
166 166  |(((
251 +{{code language="none"}}
167 167  testOnBorrow
253 +{{/code}}
168 168  )))|(((
169 169  Wether the validation query shall be executed before each "borrow" from the pool.
170 170  )))|(((
171 -[[setTestOnBorrow(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setTestOnBorrow(boolean)||shape="rect"]]
257 +1.x and 2.x
172 172  )))
173 173  |(((
260 +{{code language="none"}}
174 174  testOnReturn
262 +{{/code}}
175 175  )))|(((
176 176  Wether the validation query shall be executed when a connection is returned to the pool.
177 177  )))|(((
178 -[[setTestOnReturn(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setTestOnReturn(boolean)||shape="rect"]]
266 +1.x and 2.x
179 179  )))
180 180  |(((
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"}}
181 181  testWhileIdle
280 +{{/code}}
182 182  )))|(((
183 183  Wether the validation query shall be executed regularily to keep the connection alive.
184 184  )))|(((
185 -[[setTestWhileIdle(boolean)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setTestWhileIdle(boolean)||shape="rect"]]
284 +1.x and 2.x
186 186  )))
187 187  |(((
287 +{{code language="none"}}
188 188  timeBetweenEvictionRunsMillis
289 +{{/code}}
189 189  )))|(((
190 --
291 +The time in milliseconds between two runs of the IDLE evictor Runnable.
191 191  )))|(((
192 -[[setTimeBetweenEvictionRunsMillis(long)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setTimeBetweenEvictionRunsMillis(long)||shape="rect"]]
293 +1.x and 2.x
193 193  )))
194 194  |(((
195 195  {{code language="none"}}
196 -datasource.<datasourcename>.url
297 +url
197 197  {{/code}}
198 198  )))|(((
199 199  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.
200 200  )))|(((
201 -[[setUrl(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setUrl(java.lang.String)||shape="rect"]]
302 +1.x and 2.x
202 202  )))
203 203  |(((
204 204  {{code language="none"}}
205 -datasource.<datasourcename>.username
306 +username
206 206  {{/code}}
207 207  )))|(((
208 208  Required. JDBC User. Changes have no effect after pool initialization.
209 209  )))|(((
210 -[[setUsername(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setUsername(java.lang.String)||shape="rect"]]
311 +1.x and 2.x
211 211  )))
212 212  |(((
213 213  {{code language="none"}}
214 -datasource.<datasourcename>.validationQuery
315 +validationQuery
215 215  {{/code}}
216 216  )))|(((
217 217  Required. Validation query, executed to ensure the application receives a valid connection.
218 218  Common validation queries can be found in our [[doc:KH.Database Tips.JDBC Snippets.WebHome]].
219 219  )))|(((
220 -[[setValidationQuery(String)>>url:http://commons.apache.org/proper/commons-dbcp/apidocs/org/apache/commons/dbcp/BasicDataSource.html#setValidationQuery(java.lang.String)||shape="rect"]]
321 +1.x and 2.x
221 221  )))
222 222  
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.
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"]].
224 224  
225 225  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 -689898
1 +689731
URL
... ... @@ -1,1 +1,1 @@
1 -https://clazzes.atlassian.net/wiki/spaces/UTIL/pages/689898/Full list of JDBC Provider Configuration Keys
1 +https://clazzes.atlassian.net/wiki/spaces/UTIL/pages/689731/Full list of JDBC Provider Configuration Keys