Github user hegdean commented on a diff in the pull request:
https://github.com/apache/incubator-trafodion/pull/457#discussion_r61670087
--- Diff:
docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_detail.adoc ---
@@ -0,0 +1,959 @@
+////
+/**
+ *@@@ START COPYRIGHT @@@
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * @@@ END COPYRIGHT @@@
+ */
+////
+
+[[type-4-driver-property-descriptions]]
+= Type 4 Driver Property Descriptions
+
+The properties are listed in alphabetic order with their descriptions.
+For the properties summarized in categories, see
+<<summary-of-type-4-driver-properties, Summary of Type 4 Driver
Properties>>.
+
+////
+[[blobtablename]]
+== blobTableName Property
+
+See <<lob-table-name, LOB Table Name Properties>>.
+////
+
+[[catalog]]
+== catalog Property
+
+The `catalog` property sets the default catalog used to access SQL objects
+referenced in SQL statements if the SQL objects are not fully qualified.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object. For information about how to set
+properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: String
+
+Default: none
+```
+
+*Example*
+
+Specifying the catalog Seabase:
+
+```
+catalog=Seabase
+```
+
+////
+[[clobtablename]]
+== clobTableName Property
+
+See <<lob-table-name, LOB Table Name Properties>>.
+////
+
+<<<
+[[connectiontimeout]]
+== connectionTimeout Property
+
+The `connectionTimeout` property sets the number of seconds a connection
+can be idle before the connection is physically closed by DCS.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object. For information about how to set
+properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: int
+
+Units: seconds
+
+Default: -1 (Use the ConnTimeout value set on the server-side data source.)
+
+Range: -1, 0 to 2147483647
+```
+
+* Zero (0) specifies infinity as the timeout value.
+* A non-zero positive value overrides the value set on the
+{project-name} data source, if allowed by the connectivity settings.
+* A negative value is treated as -1.
+
+*Example*
+
+Consider the following scenario.
+
+Even if a connection is not being used, it takes up resources. The
application
+abandons connections; that is, the application does not physically close a
+connection after the application finishes using the connection.
+
+However, you can configure the connection to close itself after 300
seconds by setting
+the `connectionTimeout` property. Then, when a connection is not
referenced for 300 seconds,
+the connection automatically closes itself.
+
+In this example, the specification to set the `connectionTimeout` property
is:
+
+```
+connectionTimeout=300
+```
+
+<<<
+[[fetchbuffersize]]
+== fetchBufferSize Property
+
+The `fetchBufferSize` property provides the benefits of bulk fetch.
+
+This property sets the value in kilobytes (KB) of the size of the fetch
+buffer that is used when rows are fetched from a `ResultSet` object after
+a successful `executeQuery()` operation on a statement.
+
+Set this property on a `DriverManager` object. For information about how
to set
+properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: short
+
+Default size: 4
+
+Range: 4 through 32767
+```
+
+* Zero and negative values are treated as default values.
+* The Type 4 driver guarantees that the number of rows internally
+fetched will be no less than the minimum of the row size (set using
+the `setFetchSize` method) and the number of rows that will fit in the
+memory specified by the `setFetchSize` (set using the property).
+
+*Example*
+
+```
+fetchBufferSize=32
+```
+
+<<<
+[[initialpoolsize]]
+== initialPoolSize Property
+
+The `initialPoolSize` property sets the initial connection pool size when
+connection pooling is used with the Type 4 driver.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object. For information about how to set
+properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+The driver creates _n_ connections (where _n_ is `initialPoolSize`) for
+each connection pool when the first connection is requested. For
+example, if `initialPoolSize` is set to `5` for a data source, then the
driver
+attempts to create and pool five connections the first time the
+application calls the data source's `getConnection()` method.
+
+```
+Data type: int
+
+Units: number of physical connections
+
+Default: -1 (Do not create an initial connection pool.)
+
+Range: -1 to maxPoolSize
+```
+
+* Any negative value is treated as -1.
+* Values can be less than `minPoolSize`, but must not exceed `maxPoolSize`.
+If the specified value is greater than `maxPoolSize`, the `maxPoolSize`
+property value is used.
+
+*Example*
+
+```
+initialPoolSize=10
+```
+
+<<<
+[[iso88591]]
+== ISO88591 Property
+
+The `ISO88591` character-set mapping property corresponds to the
+SQL ISO88591 character set, which is a single-byte
+8-bit character set for character data types. This property supports
+English and other Western European languages. For more information, see
+<<internationalization-support, Internationalization Support>>.
+
+Set this property on a `DataSource` object or `DriverManager` object. This
+property is ignored for connections made through the
+`ConnectionPoolDataSource` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+```
+Data type: String
+
+Default: ISO88591_1
+```
+
+The value can be any valid Java Canonical Name as listed in the
+"Canonical Name for java.io and java.lang API" column of the
+http://docs.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html[Java
documentation].
+
+For more information, see
+<<internationalization-support, Internationalization Support>>.
+
+<<<
+[[kanji]]
+== KANJI Property
+
+The `KANJI` character-set mapping property corresponds to the
+SQL KANJI character set, which is a double-byte character set widely used
on Japanese mainframes.
+This property is a subset of Shift JIS: the double character portion. The
encoding for
+this property is big endian.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: String
+
+Default: SJIS (which is shift-JIS, Japanese)
+```
+
+*Example*
+
+```
+java -Dhpt4jdbc.KANJI=SJIS
+```
+
+For more information, see
+<<internationalization-support, Internationalization Support>>.
+
+<<<
+[[ksc5601]]
+== KSC5601 Property
+
+The `KSC5601` character-set mapping property corresponds to the
+SQL KSC5601 character set, which is a double-byte
+character set.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: String
+
+Default: ECU_KR (which is KS C 5601, ECU encoding, Korean)
+```
+
+The value can be any valid Java Canonical Name as listed in the
+"Canonical Name for java.io and java.lang API" column of the
+http://docs.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html[Java
documentation].
+
+*Example*
+
+```
+java -Dhpt4jdbc.KSC5601=ECU_KR
+```
+
+For more information, see
+<<internationalization-support, Internationalization Support>>.
+
+<<<
+[[language]]
+== language Property
+
+The `language` property sets the language used for the error messages. For
+more information about using this property, see
+<<localizing-error-messages-and-status-messages, Localizing Error Messages
and Status Messages>>
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: String
+
+Default: none
+```
+
+The value can be any valid Java Canonical Name as listed in the
+"Canonical Name for java.io and java.lang API" column of the
+http://docs.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html[Java
documentation].
+
+*Example*
+
+To set the language to shift-JIS, Japanese:
+
+```
+language=SJIS
+```
+
+////
+[[lob-table-name]]
+== LOB Table Name Properties
+
+LOB tables store data for BLOB columns and CLOB columns. The properties
+that specify the LOB table for using BLOB columns or CLOB columns are:
+
+* For the binary data for BLOB columns `blobTableName`.
+* For the character data for CLOB columns `clobTableName`.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+The property value is of the form:
+
+```
+catalog_name.schema_name.lob_table_name
+```
+
+```
+Data type: String
+
+Default: none
+```
+
+*Example*
+
+```
+blobTableName=samdbcat.sales.lobvideo
+```
+////
+
+<<<
+[[logintimeout]]
+== loginTimeout Property
+
+The `loginTimeout` property sets the time limit that a connection can be
+attempted before the connection disconnects. When a connection is
+attempted for a period longer than the set value, in seconds, the
+connection disconnects.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: int
+
+Units: seconds
+
+Default: 60
+
+Range: 0 to 2147483647
+```
+
+If set to 0 (zero), no login timeout is specified.
+
+<<<
+[[maxidletime]]
+== maxIdleTime Property
+
+The `maxIdleTime` property determines the number of seconds that a
+physical connection should remain unused in the pool before the
+connection is closed. 0 (zero) indicates no limit.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: int
+
+Units: seconds
+
+Default: 0 (No timeout)
+
+Range: 0 through 2147483647
+```
+
+Any negative value is treated as 0, which indicates that no time limit
+applies.
+
+*Example*
+
+To set the maximum idle time to 5 minutes (300 seconds):
+
+```
+java -Dhpt4jdbc.maxIdleTime=300
+```
+
+<<<
+[[maxpoolsize]]
+== maxPoolSize Property
+
+The `maxPoolSize` property sets the maximum number of physical connections
+that the pool can contain. These connections include both free
+connections and connections in use. When the maximum number of physical
+connections is reached, the Type 4 driver throws an SQLException and
+sends the message, Maximum pool size is reached.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: int
+
+Units: number of physical connections
+
+Default: -1 (Disables connection pooling.)
+
+Range: -1, 0 through 2147483647, but greater than minPoolSize
+```
+
+The value determines connection-pool use as follows:
+
+* Any negative value is treated like -1.
+
+* 0 means no maximum pool size.
+
+* A value of -1 disables connection pooling.
+
+Any positive value less than `minPoolSize` is changed to the `minPoolSize`
value.
+
+<<<
+[[maxstatements]]
+== maxStatements Property
+
+The `maxStatements` property sets the total number of `PreparedStatement`
+objects that the connection pool should cache. This total includes both
+free objects and objects in use.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: int
+
+Units: number of objects
+
+Default: 0 (Disables statement pooling.)
+
+Range: 0 through 2147483647
+```
+
+The value 0 disables statement pooling. Any negative value is treated
+like 0 (zero).
+
+TIP: To improve performance, we recommend that you enable statement
pooling for
+your JDBC applications because this pooling can dramatically help the
+performance of many applications.
+
+NOTE: Statement pooling can be in effect only if connection pooling is
+enabled.
+
+*Example*
+
+To specify statement pooling, type:
+
+```
+maxStatements=10
+```
+
+<<<
+[[minpoolsize]]
+== minPoolSize Property
+
+The `minPoolSize` property limits the number of physical connections that
+can be in the free connection pool.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: int
+
+Default: -1 (The minPoolSize value is ignored.)
+
+Range: -1, 0 through n, but less than maxPoolSize
+```
+
+* Any negative value is treated like -1.
+
+* Any value greater than `maxPoolSize` is changed to the `maxPoolSize`
value.
+
+* The value of `minPoolSize` is set to -1 when `maxPoolSize` is -1. The
value determines
+connection pool use as follows:
+
+** When the number of physical connections in the free pool reaches the
+`minPoolSize` value, the Type 4 driver closes subsequent connections by
+physically closing them and not adding them to the free pool.
+
+** 0 (zero) means that the connections are not physically closed; the
+connections are always added to the free pool when the connection is
+closed.
+
+*Example*
+
+Use the following specification to set the `minPoolSize`
+value to 1, which ensures that one connection is always retained:
+
+```
+minPoolSize=1
+```
+
+<<<
+[[networktimeout]]
+== networkTimeout Property
+
+The `networkTimeout` property sets a time limit that the driver waits for
+a reply from the database server. When an operation is attempted for a
+period longer than the set value, in seconds, the driver stops waiting
+for a reply and returns an SQLException to the user application.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+CAUTION: Be careful when using this property. A network timeout causes
+the socket connection between the Type 4 driver and the connectivity
+server to timeout. If the server is engaged in a transaction or an SQL
+operation, then the server continues to perform that transaction or
+operation until the transaction or operation fails, the transaction
+manager times out, or the server realizes that the Type 4 driver client
+has gone away. A network timeout can result in an open transaction or
+operation that continues for a significant time before failing or
+rolling back. As a result of a network timeout, the connection becomes
+unavailable.
+
+```
+Data type: int
+
+Units: seconds
+
+Default: 0 (No network timeout is specified.)
+
+0 through to 2147483647
+```
+
+<<<
+[[password]]
+== password Property
+
+The `password` property sets the password value for passing to the DCS
+server. By using this property, you can also change the password. The
+password is encrypted when it is passed to the server.
+
+The format for specifying the password is:
+
+```
+password=old [, new, new ]
+```
+
+* `old` is the current password
+
+* `new` is the new password. Passwords must be 6 to 8 characters long and
+cannot contain double quotes (").
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4
Properties>>.
+
+```
+Data type: String
+
+Default: empty string
+```
+
+*Example*
+
+```
+password=eye0weU$
+```
+
+[[properties]]
+== properties Property
+
+The `properties` property specifies the location of the properties file
+that contains keyword-value pairs that specify property values for
+configuring the Type 4 driver. For more information, see
+<<creating-and-using-a-properties-file, Creating and Using a Properties
File>>.
+
+<<<
+[[reservedatalocators]]
--- End diff --
not sure if this is still valid.. let sandhya review this
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
