CouchDB (couchdb)

Configuration for a CouchDB Connector.

Name	Type	Default	Description
caching	boolean	true	Allows loading documents from http client's cache if it exists and the revision has not changed since last access.
cleanupIdleConnections	boolean	true	Closes connections automatically when they are considered idle.
connectionTimeout	A period of time with millisecond precision	30s	The 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.
enableSSL	boolean	false	Enables SSL when connecting to CouchDB.
host	string		Host name for the CouchDB server.
id	string		A unique configuration ID.
jndiName	string		JNDI name for a CouchDB instance.
libraryRef	A reference to top level library element (string).		Specifies a library that contains the CouchDB Client library and its dependencies.
maxCacheEntries	int Min: 0	1000	The maximum number of cache entries for the http client.
maxConnections	int	20	The maximum number of concurrent connections to the host.
maxObjectSizeBytes	int Min: 0	8192	Sets the maximum size for a stored document.
password	Reversably encoded password (string) Required		Password corresponding to your Couchdb User ID.
port	int	5984	Port number for the CouchDB server.
relaxedSSLSettings	boolean	false	Enables relaxed SSL settings which allows the trust manager to accept any host and certificate.
socketTimeout	A period of time with millisecond precision	1m	The 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.
url	string		URL for the CouchDB server, which includes the host and port.
useExpectContinue	boolean	true	Use Expect Continue header in request when making requests to CouchDB.
username	string Required		The CouchDB User ID used to log-in and access your DBs.

Name

Type

Default

Description

caching

boolean

true

Allows loading documents from http client's cache if it exists and the revision has not changed since last access.

cleanupIdleConnections

boolean

true

Closes connections automatically when they are considered idle.

connectionTimeout

A period of time with millisecond precision

30s

The 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.

enableSSL

boolean

false

Enables SSL when connecting to CouchDB.

host

string

Host name for the CouchDB server.

string

A unique configuration ID.

jndiName

string

JNDI name for a CouchDB instance.

libraryRef

A reference to top level library element (string).

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

maxCacheEntries

int
Min: 0

1000

The maximum number of cache entries for the http client.

maxConnections

int

The maximum number of concurrent connections to the host.

maxObjectSizeBytes

int
Min: 0

8192

Sets the maximum size for a stored document.

password

Reversably encoded password (string)
Required

Password corresponding to your Couchdb User ID.

port

int

5984

Port number for the CouchDB server.

relaxedSSLSettings

boolean

false

Enables relaxed SSL settings which allows the trust manager to accept any host and certificate.

socketTimeout

A period of time with millisecond precision

The 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.

url

string

URL for the CouchDB server, which includes the host and port.

useExpectContinue

boolean

true

Use Expect Continue header in request when making requests to CouchDB.

username

string
Required

The CouchDB User ID used to log-in and access your DBs.

couchdb > library

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

Name	Type	Default	Description
apiTypeVisibility	string	spec,ibm-api,api,stable	The 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.
description	string		Description of shared library for administrators
filesetRef	List of references to top level fileset elements (comma-separated string).		Specifies a set of JAR or ZIP files to include in the class path for this library
name	string		Name of shared library for administrators

Name

Type

Default

Description

apiTypeVisibility

string

spec,ibm-api,api,stable

The 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.

description

string

Description of shared library for administrators

filesetRef

List of references to top level fileset elements (comma-separated string).

Specifies a set of JAR or ZIP files to include in the class path for this library

name

string

Name of shared library for administrators

couchdb > library > file

Add a JAR or ZIP file to include in the class path for this library. Classes and resources that are contained in the specified JAR or ZIP are available to load for this library.

Name	Type	Default	Description
id	string		A unique configuration ID.
name	Path to a file Required		The path to a file can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.

couchdb > library > fileset

Specifies a set of JAR or ZIP files to include in the class path for this library

Name	Type	Default	Description
caseSensitive	boolean	true	Boolean to indicate whether or not the search should be case sensitive (default: true).
dir	Path to a directory	${server.config.dir}	The base directory to search for files.
excludes	string		The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
id	string		A unique configuration ID.
includes	string	*	The comma or space separated list of file name patterns to include in the search results (default: *).
scanInterval	A period of time with millisecond precision	0	The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. 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.

couchdb > library > folder

Add a folder to include in the class path for this library. Classes and resources that are contained in the specified folder and its subfolders are available to load for this library. JAR and ZIP files that are contained in the specified folder are not added to the class path for this library.

Name	Type	Default	Description
dir	Path to a directory Required		The path to a folder can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.
id	string		A unique configuration ID.

couchdb > library > path

Add a JAR file, ZIP file or folder to include in the class path for this library. If the specified path is a JAR or ZIP file, then classes and resources that are contained in the specified JAR or ZIP file are available to load for this library. If the specified path is a folder, then classes and resources that are contained in the specified folder and its subfolders are available to load for this library. JAR and ZIP files contained in the specified folder are not added to the class path for this library.