Skip to content

Commit 47e366d

Browse files
authored
Cleanup PGProperty, sort values, and add some missing to docs (#1686)
* misc: Add PGProperty.getDescription() * misc: Remove variadic constructor for PGProperty values and split across multiple lines * perf: Cache PGProperty values in a map by name * misc: Add PGProperty.isRequired() * misc: Add PGProperty.isDeprecated() * docs: Correct receiveBufferSize and remove duplicate sendBufferSize * docs: Add missing binaryTransfer property to head docs * docs: Add missing databaseMetadataCacheFields and databaseMetadataCacheFieldsMiB to head docs * misc: Sort PGProperty enum values
1 parent 1191076 commit 47e366d

File tree

6 files changed

+522
-300
lines changed

6 files changed

+522
-300
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ In addition to the standard connection parameters the driver supports a number o
122122
| sslpasswordcallback | String | null | The name of a class (for use in [Class.forName(String)](https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html#forName%28java.lang.String%29)) that implements javax.security.auth.callback.CallbackHandler and can handle PasswordCallback for the ssl password. |
123123
| sslpassword | String | null | The password for the client's ssl key (ignored if sslpasswordcallback is set) |
124124
| sendBufferSize | Integer | -1 | Socket write buffer size |
125-
| recvBufferSize | Integer | -1 | Socket read buffer size |
125+
| receiveBufferSize | Integer | -1 | Socket read buffer size |
126126
| loggerLevel | String | null | Logger level of the driver using java.util.logging. Allowed values: OFF, DEBUG or TRACE. |
127127
| loggerFile | String | null | File name output of the Logger, if set, the Logger will use a FileHandler to write to a specified file. If the parameter is not set or the file can't be created the ConsoleHandler will be used instead. |
128128
| allowEncodingChanges | Boolean | false | Allow for changes in client_encoding |

docs/documentation/92/connect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ connection.
111111
* `sendBufferSize = int`
112112
Sets SO_SNDBUF on the connection stream
113113

114-
* `recvBufferSize = int`
114+
* `receiveBufferSize = int`
115115
Sets SO_RCVBUF on the connection stream
116116

117117
* `protocolVersion = String`

docs/documentation/93/connect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ connection.
111111
* `sendBufferSize = int`
112112
Sets SO_SNDBUF on the connection stream
113113

114-
* `recvBufferSize = int`
114+
* `receiveBufferSize = int`
115115
Sets SO_RCVBUF on the connection stream
116116

117117
* `protocolVersion = String`

docs/documentation/94/connect.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,14 +118,10 @@ connection.
118118

119119
Sets SO_SNDBUF on the connection stream
120120

121-
* `recvBufferSize = int`
121+
* `receiveBufferSize = int`
122122

123123
Sets SO_RCVBUF on the connection stream
124124

125-
* `receiveBufferSize = int`
126-
127-
Sets SO_RCVBUF on the connection stream
128-
129125
* `protocolVersion = String`
130126

131127
The driver supports both the V2 and V3 frontend/backend protocols. The

docs/documentation/head/connect.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -158,14 +158,6 @@ Connection conn = DriverManager.getConnection(url);
158158

159159
If provided will be used by ConsoleCallbackHandler
160160

161-
* **sendBufferSize** = int
162-
163-
Sets SO_SNDBUF on the connection stream
164-
165-
* **recvBufferSize** = int
166-
167-
Sets SO_RCVBUF on the connection stream
168-
169161
* **protocolVersion** = int
170162

171163
The driver supports the V3 frontend/backend protocols. The V3 protocol was introduced in 7.4 and
@@ -228,6 +220,12 @@ Connection conn = DriverManager.getConnection(url);
228220

229221
The default is 'false'
230222

223+
* **binaryTransfer** = boolean
224+
225+
Use binary format for sending and receiving data if possible.
226+
227+
The default is 'true'
228+
231229
* **binaryTransferEnable** = String
232230

233231
A comma separated list of types to enable binary transfer. Either OID numbers or names.
@@ -237,6 +235,20 @@ Connection conn = DriverManager.getConnection(url);
237235
A comma separated list of types to disable binary transfer. Either OID numbers or names.
238236
Overrides values in the driver default set and values set with binaryTransferEnable.
239237

238+
* **databaseMetadataCacheFields** = int
239+
240+
Specifies the maximum number of fields to be cached per connection.
241+
A value of 0 disables the cache.
242+
243+
Defaults to 65536.
244+
245+
* **databaseMetadataCacheFieldsMiB** = int
246+
247+
Specifies the maximum size (in megabytes) of fields to be cached per connection.
248+
A value of 0 disables the cache.
249+
250+
Defaults to 5.
251+
240252
* **prepareThreshold** = int
241253

242254
Determine the number of `PreparedStatement` executions required before

0 commit comments

Comments
 (0)