couchdb - CouchDB (couchdb)

Configuration for a CouchDB Connector.

NameTypeDefaultDescription
idstringA unique configuration ID.
libraryRefA reference to top level library element (string).Specifies a library that contains the CouchDB Client library and its dependencies.
usernamestringThe CouchDB User ID used to log-in and access your DBs.
passwordReversably encoded password (string)Password corresponding to your Couchdb User ID.
jndiNamestringJNDI name for a CouchDB instance.
urlstringURL for the CouchDB server, which includes the host and port.
hoststringHost name for the CouchDB server.
portint5984Port number for the CouchDB server.
maxConnectionsint20The maximum number of concurrent connections to the host.
connectionTimeoutA period of time with millisecond precision30sThe timeout to establish a connection. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
socketTimeoutA period of time with millisecond precision1mThe duration to wait for a response. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
enableSSLbooleanfalseEnables SSL when connecting to CouchDB.
relaxedSSLSettingsbooleanfalseEnables relaxed SSL settings which allows the trust manager to accept any host and certificate.
cachingbooleantrueAllows loading documents from http client's cache if it exists and the revision has not changed since last access.
maxCacheEntriesint
Min: 0
1000The maximum number of cache entries for the http client.
maxObjectSizeBytesint
Min: 0
8192Sets the maximum size for a stored document.
useExpectContinuebooleantrueUse Expect Continue header in request when making requests to CouchDB.
cleanupIdleConnectionsbooleantrueCloses connections automatically when they are considered idle.

library

Specifies a library that contains the CouchDB Client library and its dependencies.

NameTypeDefaultDescription
namestringName of shared library for administrators
descriptionstringDescription of shared library for administrators
filesetRefList of references to top level fileset elements (comma-separated string).Id of referenced Fileset
apiTypeVisibilitystringspec,ibm-api,api,stableThe types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party.

library > fileset

Id of referenced Fileset

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directory${server.config.dir}The base directory to search for files.
caseSensitivebooleantrueBoolean to indicate whether or not the search should be case sensitive (default: true).
includesstring*The comma or space separated list of file name patterns to include in the search results (default: *).
excludesstringThe comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
scanIntervalA period of time with millisecond precision0Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

library > folder

Id of referenced folder

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directoryDirectory or folder to be included in the library classpath for locating resource files

library > file

Id of referenced File

NameTypeDefaultDescription
idstringA unique configuration ID.
namePath to a fileFully qualified filename