Writer Directives
The suffixes shown are prefixed by the current <WriterKeyword> in a mapping file. By default, the <WriterKeyword> for the CouchDB writer is COUCHDB.
DATASET
Required/Optional
Required
The value for this keyword is the URL for the CouchDB dataset as specified in the writer overview.
Workbench Parameter
Source CouchDB Server URL(s)
Example:
COUCHDB_DATASET “http://127.0.0.1:5984”
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”
PASSWORD
Required/Optional
Optional
The value for this keyword specifies the password with which to log into the CouchDB server.
If username is not specified this directive will have no effect.
Workbench Parameter
Password
Example:
PASSWORD “secret”
TABLE_PERMISSIONS
Required/Optional
Required
The value for this keyword specifies the permissions to be used for newly created tables.
Workbench Parameter
New Table Permissions
USE_GEOJSON
Required/Optional
Required
The value for this keyword determines whether or not newly created tables will be interpreted as containing valid GeoJSON, if the new table is intended to contain other data aside from GeoJSON this should be set to No. This directive will be ignored if using the RAW_JSON directive.
Parameter Options: Yes, No
Default Value:
Yes
Workbench Parameter
Use GeoJSON Specification
RAW_JSON
Required/Optional
Required
If the value of this keyword is Yes, the CouchDB Writer will only read the couchdb_raw_json format attribute of incoming features, and treat its value as the JSON document to write to CouchDB. User attributes will not be accepted, and the USE_GEOJSON directive will be ignored. The CouchDB writer will not validate the JSON.
Workbench Parameter
Write Raw JSON
OVERWRITE_TABLES
The value for this keyword determines whether or not a table will be deleted before writing to it. If no features are written to the corresponding feature type then the table will not be deleted.
When the table is deleted it cannot be recovered, all data is lost.
Before setting this option to “Yes” ensure that administrator credentials have been provided, only server administrators can delete tables.
Required/Optional
Required
Workbench Parameter
Drop Tables Before Write
TRANSACTION_SIZE
Required/Optional
Required
The value for this keyword determines how many features are pushed to the remote server at a time. Setting a high value for the transaction size can result in increased performance as there can be significant overhead associated with each network request.
Default Value: 1000
Workbench Parameter
Transaction Interval