Reader Directives

The suffixes shown are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the CouchDB reader is COUCHDB.

DATASET

Required/Optional

Required

The value for this keyword is the URL for the CouchDB dataset as specified in the reader overview.

Example:

COUCHDB_DATASET “http://127.0.0.1:5984”

Workbench Parameter

Source CouchDB Server URL(s)

USERNAME

Required/Optional

Optional

The value for this keyword specifies the user name with which to log into the CouchDB server, if left unspecified only public database tables will be available to read.

Example:

USERNAME “admin”

Workbench Parameter

User Name

PASSWORD

Required/Optional

Optional

The value for this keyword specifies the password with which to log into the CouchDB server, if left unspecified only public database tables will be available to read.

Example:

PASSWORD “secret”

Workbench Parameter

Password

RAW_JSON

Required/Optional

Required

The value for this keyword specifies whether or not output features will have the couchdb_raw_json format attribute populated with the serialized representation of the JSON document. If set to Yes, the couchdb_raw_json format attribute will automatically be exposed, and there will be no user attributes on the schema.

Parameter Options: Yes, No

Default Value: No

Workbench Parameter

Read Raw JSON

PAGE_SIZE

Required/Optional

Required

The value for this keyword specifies the maximum number of JSON documents to retrieve from the server per request. The default value is 500.

Example:

PAGE_SIZE 750

Workbench Parameter

Number of Features to Read at a Time