Connection Properties
The connection properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection settings for this provider. Click the links for further details.
For more information on establishing a connection, see Getting Started.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Apache CouchDB. |
| URL | The URL used to connect to the Apache CouchDB. |
| User | The Apache CouchDB user account used to authenticate. |
| Password | The password used to authenticate the user. |
| PublicDatabases | Specify a comma-separated list of public databases to list as tables. |
| Property | Description |
| JWTToken | The JWT token to use for authentication. |
| JWTSubject | The user subject for which the application is requesting delegated access. |
| JWTIssuer | The issuer of the JWT token. |
| JWTAlgorithm | The encryption algorithm used for signing the JWT token. |
| JWTExpiration | How long the JWT token should remain valid, in seconds. |
| JWTKeyType | The type of the encryption key which is used for signing the JWT token. |
| JWTKey | The encryption key for signing the JWT token. |
| JWTHeaders | A collection of extra headers that should be included in the JWT header. |
| JWTClaims | A collection of extra claims that should be included in the JWT payload. |
| CredentialsLocation | The location of the settings file where the JWT token is saved. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| ListViews | Whether to list views from Apache CouchDB or not. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheProvider | The name of the provider to be used to cache data. |
| CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| DirectQueryLimit | Limits the number of rows when using the DirectQuery mode. This helps avoid performance issues at design time. |
| EnableForeignKeyDetection | Whether to detect the foreign keys in ODBC. |
| FlattenArrays | Set FlattenArrays to the number of array elements to flatten into columns. Otherwise, arrays are returned as JSON strings. |
| FlattenObjects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, embedded objects as raw JSON strings. |
| FlexibleSchema | Set FlexibleSchema to true to scan for additional metadata on the query result set. Otherwise, the metadata will remain the same. |
| MaximumColumnSize | The maximum column size. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from Apache CouchDB. |
| PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
| Readonly | You can use this property to enforce read-only access to Apache CouchDB from the provider. |
| RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
| RTK | The runtime key used for licensing. |
| SeparatorCharacter | The character or characters used to denote hierarchy. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| TypeDetectionScheme | Determines how the provider will scan the data to determine the fields and data types in each document collection. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |