Fortnox Attributes
Advanced
swagger-specification-url
The Swagger URL such as https://example.org/rest/swagger.json.
- Set from: connection string, set statement, provider file, log on
swagger-specification-file
The Swagger file path, such as C:\temp\swagger.json.
- Set from: connection string, set statement, provider file, log on
ignore-values-unknown-path
Whether to ignore values outside of processed paths. An error will be generated when a value occurs outside a path otherwise.
- Default:
True - Set from: connection string, set statement, provider file, log on
ignore-unknown-path-type
Whether to ignore path types not yet supported. An error will be generated when an unsupported type occurs.
- Default:
True - Set from: connection string, set statement, provider file, log on
max-discovered-column-count
Maximum number of discovered columns. An error will be generated when the column exceeds this value.
- Default:
250 - Set from: connection string, set statement, provider file, log on
duplicate-row-mode
Configure behaviour when multiple rows are discovered during a limited search based upon a fingerprint generated from the primary key value, or all column values when no primary key is known.
The following values can be used: "error" to raise error on duplicate fingerprint values in an API-page of rows, "keep" to ignore duplicate fingerprint values silently, "skip" like "keep" but with logging to trace of duplicate values or "null" for default behaviour (typically "error")..
- Set from: connection string, set statement, provider file, log on
swagger-specification-allow-fallback
Whether to allow fallback in case of an Internet connection issue on a possibly bundled Swagger specification.
- Default:
True - Set from: connection string, provider file, log on
api-client-id
The client ID is a unique identifier of your application. It is generated by registering an application.
Needed only where the platform requires the customer to register an app of their own instead of using the app registered by Invantive. That is typically the case on a production licence, and the message raised then names both this attribute and the redirect URL. A client ID is registered per country or region of the platform, so a subscription in several countries needs one registration per country.
- Set from: connection string, provider file, log on
- Defined by: OData
api-client-secret
The client secret is to be kept confidential. Such as a password for a logon code, the client secret is the confidential part of an app identified by a client ID. It is needed during the OAuth2 Code Grant Flow together with the refresh token to get access.
- Set from: connection string, provider file, log on
- Defined by: OData
api-access-token
Access Token is a security token for multiple OAuth2 Flows. With an Access Token you can access protected resources. An Access Token must be stored securely since once compromised allows access to your protected resources.
- Set from: connection string, set statement, provider file, log on
- Defined by: OData
api-refresh-token
Refresh Token is a security token for the OAuth2 Code Grant Flow. With a Refresh Token and client secret you can retrieve a renewed access token to access protected resources. A Refresh Token and client secret must be stored securely since once compromised allows access to your protected resources.
Supplied only for a pre-authenticated connection, where no interactive log on is possible; an ordinary log on obtains and renews the token by itself. A refresh token is consumed on use and replaced by a new one, so the same token cannot be used from two places at once: a second connection with the same token invalidates the first. Store it as securely as a password.
- Set from: connection string, provider file, log on
- Defined by: OData
api-redirect-url
The redirect URI is the website a browser session is redirected to after the OAuth2 authentication process has been completed.
The redirect URL must match the one entered when the app was registered. An on-premises product uses 'https://clientredirect.invantive.eu' or a redirect URL of your own over HTTPS; the redirect URL of Invantive Cloud belongs to Invantive Cloud alone. Sharing one app registration between Invantive Cloud and an on-premises product breaks the chain of refresh tokens on Invantive Cloud. Use a separate app for each.
- Set from: connection string, provider file, log on
- Defined by: OData
totp-secret
Shared secret key to generate one-time password using TOTP RFC 6238. For improved security, manually enter the one-time password asked during login.
- Set from: connection string, provider file, log on
- Defined by: OData
Authentication
api-pre-expiry-refresh-sec
The number of seconds before the token expires to acquire a new token.
- Set from: connection string, set statement, provider file
- Defined by: OData
api-scope
The authorization scope(s) to request an OAuth token for.
- Set from: connection string, provider file
- Defined by: OData
api-token-url
The token URI is the OAuth2 endpoint to exchange tokens with.
- Set from: connection string, provider file
- Defined by: OData
oauth-unauthorized-max-tries
Maximum number of tries when an OAuth exception occurs.
- Default:
2 - Set from: connection string, set statement, provider file
oauth-unauthorized-sleep-initial-ms
Initial sleep in milliseconds between OAuth reauthentication tries when the OAuth authentication fails.
- Default:
10000 - Set from: connection string, set statement, provider file
oauth-unauthorized-sleep-max-ms
Maximum sleep in milliseconds between OAuth reauthentication tries when the OAuth authentication fails.
- Default:
1000 - Set from: connection string, set statement, provider file
oauth-unauthorized-sleep-multiplicator
Multiplication factor for sleep between OAuth reauthentication tries when the OAuth authentication fails.
- Default:
2 - Set from: connection string, set statement, provider file
Behaviour
add-odata-mandatory-filters
Whether to automatically add OData filters deemed necessary by the platform.
- Default:
False - Set from: connection string, set statement, provider file
- Defined by: OData
empty-answer-is-error-on-read
Whether an empty answer to a read, with a success status, is asked for again and then refused instead of giving no rows.
- Default:
True - Set from: connection string, set statement, provider file
filter-in-operator
Whether the platform accepts the 'in' operator of OData 4.01 in a filter. When it does, a choice between values of one column is sent as one 'in' rather than as equalities combined with 'or', which shortens the URL and counts as one filter element instead of one per value. Leave it off for a platform that answers such a filter with a syntax error.
- Default:
False - Set from: connection string, set statement, provider file
- Defined by: OData
force-case-sensitive-identifiers
Consider identifiers as case-sensitive independent of the platform capabilities.
- Default:
False - Set from: connection string, set statement, provider file
- Defined by: Shared
forced-casing-identifiers
Forced casing of identifiers. Choose from: Unset, Lower, Upper and Mixed.
- Set from: connection string, set statement, provider file
- Defined by: Shared
group-by-pushdown-max-groups
Maximum number of groups a data container may answer to a pushed group by before the rows are read instead. Zero switches the push off.
- Default:
1000 - Set from: connection string, set statement, provider file
- Defined by: Shared
invalid-json-on-post-max-tries
Maximum number of tries when the JSON received on POST is invalid.
- Default:
3 - Set from: connection string, set statement, provider file
invalid-json-on-post-sleep-initial-ms
Initial sleep in milliseconds between retries when the JSON received on POST is invalid.
- Default:
1000 - Set from: connection string, set statement, provider file
invalid-json-on-post-sleep-max-ms
Maximum sleep in milliseconds between retries when the JSON received on POST is invalid.
- Default:
10000 - Set from: connection string, set statement, provider file
invalid-json-on-post-sleep-multiplicator
Multiplication factor for sleep between retries when the JSON received on POST is invalid.
- Default:
2 - Set from: connection string, set statement, provider file
invantive-sql-compress-sparse-arrays
Whether to compress sparse arrays in result sets during compression.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
invantive-sql-correct-invalid-date
Whether to correct dates considered invalid since they are before 01-01-1753. When nullable, they are removed. Otherwise they are replaced by 01-01-1753.
- Default:
False - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
invantive-sql-forward-child-exists-filters-to-data-containers
A filter on the existence of a related row is evaluated by the data container where reasonably possible, so that rows are left out before they are transferred.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
invantive-sql-forward-filters-to-data-containers
Whether to forward filters to data containers.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
invantive-sql-forward-projections-to-data-containers
Only the columns a statement actually uses are requested from the data container where reasonably possible, which reduces the volume transferred.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
invantive-sql-forward-projections-to-synchronize-target
The table a synchronize writes is read for the columns it compares only, which are the columns present on both sides, instead of for all of them.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
invantive-sql-share-byte-arrays
Whether to share the memory used by identical byte arrays in result sets during compression.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
invantive-sql-share-strings
Whether to share the memory used by identical strings in result sets during compression.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
invantive-sql-shuffle-fetch-results-data-containers
Whether to shuffle results fetched from data containers.
- Default:
False - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
join-set-points-per-request
Maximum number of values in a request when executing a join set.
- Default:
60 - Set from: connection string, set statement, provider file
- Defined by: OData
limit-partition-calls-left
Minimum number of remaining API calls on a partition towards a hard limit. When below, an error is raised.
- Default:
500 - Set from: connection string, set statement, provider file
- Defined by: OData
max-length-identifiers
Non-default maximum length in characters of identifier names.
- Set from: connection string, set statement, provider file
- Defined by: Shared
max-odata-filters
Maximum number of OData filter elements.
- Default:
100 - Set from: connection string, set statement, provider file
- Defined by: OData
max-odata-rewrite-in-count
Maximum number of values in an OData in-clause before the filter is rewritten into separate requests.
- Default:
500 - Set from: connection string, set statement, provider file
- Defined by: OData
max-url-length-accepted
The maximum accepted URL length before raising an error.
- Default:
8000 - Set from: connection string, set statement, provider file
max-url-length-desired
The maximum desired URL length.
- Default:
8000 - Set from: connection string, set statement, provider file
partition-slot-based-rate-limit-length-ms
Total length in milliseconds across all slots of a partition-based rate limit.
- Default:
60000 - Set from: connection string, provider file
- Defined by: Shared
partition-slot-based-rate-limit-slots
Number of slots per partition-based rate limit. Null means no slot-based rate limit.
- Set from: connection string, provider file
- Defined by: Shared
pre-request-delay-ms
Pre-request delay in milliseconds per request.
- Default:
0 - Set from: connection string, set statement, provider file
- Defined by: Shared
requested-maximum-usable-partitions
Requested Maximum Usable Partitions
- Set from: connection string, set statement, provider file
- Defined by: Shared
slot-based-rate-limit-length-ms
Total length in milliseconds across all slots of a slot-based rate limit.
- Default:
5000 - Set from: connection string, provider file
- Defined by: Shared
slot-based-rate-limit-slots
Number of slots of a slot-based rate limit. Null means no slot-based rate limit.
- Default:
25 - Set from: connection string, provider file
- Defined by: Shared
standardize-identifiers
Rewrite all identifiers to the preferred standards as configured by standardize-identifiers-casing and maximum-length-identifiers.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: Shared
standardize-identifiers-casing
Rewrite all identifiers to the recommended standard platform-specific casing when changing a data model on a case-dependent platform.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: Shared
swagger-specification-download-tries
Specification Download Tries
- Default:
5 - Set from: connection string, set statement, provider file
Caching
http-disk-cache-compression-level
Compression level for the HTTP disk cache, ranging from 1 (little) to 9 (intense). Default is 5.
- Default:
5 - Set from: connection string, set statement, provider file
http-disk-cache-directory
Directory where HTTP cache is stored.
- Default:
C:\Users\guido\Invantive\Cache\http\guido\shared - Set from: connection string, set statement, provider file
http-disk-cache-ignore-write-errors
Whether to ignore write errors to disk cache.
- Default:
False - Set from: connection string, set statement, provider file
http-disk-cache-max-age-sec
Maximum acceptable age in seconds for use of data in the HTTP disk cache.
- Default:
2592000 - Set from: connection string, set statement, provider file
http-memory-cache-compression-level
Compression level for the HTTP memory cache, ranging from 1 (little) to 9 (intense). Default is 5.
- Default:
5 - Set from: connection string, set statement, provider file
http-memory-cache-max-age-sec
Maximum acceptable age in seconds for use of data in the HTTP memory cache.
- Default:
14400 - Set from: connection string, set statement, provider file
http-public-disk-cache-directory
Directory where the HTTP cache of publicly available data is stored.
- Default:
C:\Users\guido\Invantive\Cache\public - Set from: connection string, set statement, provider file
invantive-use-cache
Whether to cache the results of a query.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
metadata-cache-max-age-sec
Maximum acceptable age in seconds for re-use of metadata.
- Set from: connection string, set statement, provider file
- Defined by: OData
swagger-specification-http-disk-cache-max-age-sec
Maximum acceptable age in seconds for use of Swagger specification data in the HTTP disk cache.
- Default:
86400 - Set from: connection string, set statement, provider file
use-http-disk-cache
Combination of use-http-disk-cache-read and use-http-disk-cache-write.
- Set from: connection string, set statement, provider file
use-http-disk-cache-read
Whether to use HTTP responses from previous queries stored on disk to answer the current query.
- Default:
False - Set from: connection string, set statement, provider file
use-http-disk-cache-write
Whether to memorize HTTP responses on disk.
- Default:
False - Set from: connection string, set statement, provider file
use-http-memory-cache
Combination of use-http-memory-cache-read and use-http-memory-cache-write.
- Set from: connection string, set statement, provider file
use-http-memory-cache-read
Whether to use HTTP responses from previous queries stored in memory that can answer the current query.
- Default:
True - Set from: connection string, set statement, provider file
use-http-memory-cache-write
Whether to memorize HTTP responses from previous queries for use by future queries.
- Default:
True - Set from: connection string, set statement, provider file
Connection
api-url
URL of web service.
- Set from: connection string, provider file
- Defined by: OData
Diagnostics
analysis-enforce-row-uniqueness
Enforce rows to be unique for software analysis. A fingerprint is calculated from the whole row of data when the primary key column is unknown.
- Default:
False - Set from: connection string, set statement, provider file
- Defined by: Shared
download-error-400-bad-request-max-tries
Maximum number of tries when HTTP server reports bad format during retrieval of data.
- Default:
3 - Set from: connection string, set statement, provider file
download-error-400-bad-request-sleep-initial-ms
Initial sleep in milliseconds between retries when HTTP server reports that the API server is unavailable during retrieval of data.
- Default:
500 - Set from: connection string, set statement, provider file
download-error-400-bad-request-sleep-max-ms
Maximum sleep in milliseconds between retries when HTTP server reports that the API server is unavailable during retrieval of data.
- Default:
5000 - Set from: connection string, set statement, provider file
download-error-400-bad-request-sleep-multiplicator
Multiplication factor for sleep between retries HTTP server reports that the API server is unavailable during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-403-forbidden-max-tries
Maximum number of tries when the website reports a HTTP status 403 (Forbidden).
- Default:
2 - Set from: connection string, set statement, provider file
download-error-403-forbidden-sleep-initial-ms
Initial sleep in milliseconds between retries when the website reports a HTTP status 403 (Forbidden).
- Default:
3000 - Set from: connection string, set statement, provider file
download-error-403-forbidden-sleep-max-ms
Maximum sleep in milliseconds between retries when the website reports a HTTP status 403 (Forbidden).
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-403-forbidden-sleep-multiplicator
Multiplication factor for sleep between retries when the website reports a HTTP status 403 (Forbidden).
- Default:
2 - Set from: connection string, set statement, provider file
download-error-408-request-timeout-max-tries
Maximum number of tries when the website reports a HTTP status 408.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-408-request-timeout-sleep-initial-ms
Initial sleep in milliseconds between retries when the website reports a HTTP status 408.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-408-request-timeout-sleep-max-ms
Maximum sleep in milliseconds between retries when the website reports a HTTP status 408.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-408-request-timeout-sleep-multiplicator
Multiplication factor for sleep between retries when the website reports a HTTP status 408.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-422-bad-request-max-tries
Maximum number of tries when HTTP server reports unprocessable entity during retrieval of data.
- Default:
3 - Set from: connection string, set statement, provider file
download-error-422-bad-request-sleep-initial-ms
Initial sleep in milliseconds between retries when HTTP server reports unprocessable entity during retrieval of data.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-422-bad-request-sleep-max-ms
Maximum sleep in milliseconds between retries when HTTP server reports unprocessable entity during retrieval of data.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-422-bad-request-sleep-multiplicator
Multiplication factor for sleep between retries HTTP server reports unprocessable entity during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-429-too-many-requests-max-tries
Maximum number of tries when the website reports that too many requests have been made during a timeslot of one minute or one day.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-429-too-many-requests-sleep-initial-ms
Initial sleep in milliseconds between retries when the website reports that too many requests have been made during a timeslot of one minute or one day.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-429-too-many-requests-sleep-max-ms
Maximum sleep in milliseconds between retries when the website reports that too many requests have been made during a timeslot of one minute or one day.
- Default:
60000 - Set from: connection string, set statement, provider file
download-error-429-too-many-requests-sleep-multiplicator
Multiplication factor for sleep between retries when the website reports that too many requests have been made during a timeslot of one minute or one day.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-500-internal-server-error-max-tries
Maximum number of tries when the HTTP server reports an internal server error during retrieval of data.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-500-internal-server-error-sleep-initial-ms
Initial sleep in milliseconds between retries when the HTTP server reports an internal server error during retrieval of data.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-500-internal-server-error-sleep-max-ms
Maximum sleep in milliseconds between retries when the HTTP server reports an internal server error during retrieval of data.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-500-internal-server-error-sleep-multiplicator
Multiplication factor for sleep between retries when the HTTP server reports an internal server error during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-502-server-unavailable-max-tries
Maximum number of tries when HTTP server reports a bad gateway during retrieval of data.
- Default:
3 - Set from: connection string, set statement, provider file
download-error-502-server-unavailable-sleep-initial-ms
Initial sleep in milliseconds between retries when HTTP server reports a bad gateway during retrieval of data.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-502-server-unavailable-sleep-max-ms
Maximum sleep in milliseconds between retries when HTTP server reports that a bad gateway during retrieval of data.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-502-server-unavailable-sleep-multiplicator
Multiplication factor for sleep between retries HTTP server reports a bad gateway during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-503-server-unavailable-max-tries
Maximum number of tries when HTTP server reports that the API server is unavailable during retrieval of data.
- Default:
30 - Set from: connection string, set statement, provider file
download-error-503-server-unavailable-sleep-initial-ms
Initial sleep in milliseconds between retries when HTTP server reports that the API server is unavailable during retrieval of data.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-503-server-unavailable-sleep-max-ms
Maximum sleep in milliseconds between retries when HTTP server reports that the API server is unavailable during retrieval of data.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-503-server-unavailable-sleep-multiplicator
Multiplication factor for sleep between retries HTTP server reports that the API server is unavailable during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-504-gateway-timeout-max-tries
Maximum number of tries when the website reports a gateway timeout.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-504-gateway-timeout-sleep-initial-ms
Initial sleep in milliseconds between retries when the website reports a gateway timeout.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-504-gateway-timeout-sleep-max-ms
Maximum sleep in milliseconds between retries when the website reports a gateway timeout.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-504-gateway-timeout-sleep-multiplicator
Multiplication factor for sleep between retries when the website reports a gateway timeout.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-590-network-connect-timeout-max-tries
Maximum number of tries when the website reports a HTTP status 590.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-590-network-connect-timeout-sleep-initial-ms
Initial sleep in milliseconds between retries when the website reports a HTTP status 590.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-590-network-connect-timeout-sleep-max-ms
Maximum sleep in milliseconds between retries when the website reports a HTTP status 590.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-590-network-connect-timeout-sleep-multiplicator
Multiplication factor for sleep between retries when the website reports a HTTP status 590.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-599-network-connect-timeout-max-tries
Maximum number of tries when the website reports a HTTP status 599.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-599-network-connect-timeout-sleep-initial-ms
Initial sleep in milliseconds between retries when the website reports a HTTP status 599.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-599-network-connect-timeout-sleep-max-ms
Maximum sleep in milliseconds between retries when the website reports a HTTP status 599.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-599-network-connect-timeout-sleep-multiplicator
Multiplication factor for sleep between retries when the website reports a HTTP status 599.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-argument-exception-max-tries
Maximum number of tries when an argument exception is returned when downloading a blob.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-argument-exception-sleep-initial-ms
Initial sleep in milliseconds between retries when an argument exception is returned when downloading a blob.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-argument-exception-sleep-max-ms
Maximum sleep in milliseconds between retries when an argument exception is returned when downloading a blob.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-argument-exception-sleep-multiplicator
Multiplication factor for sleep between retries when an argument exception is returned when downloading a blob.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-internet-down-max-tries
Maximum number of tries when the Internet connection seems down during retrieval of data.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-internet-down-sleep-initial-ms
Initial sleep in milliseconds between retries when the Internet connection seems down during retrieval of data.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-internet-down-sleep-max-ms
Maximum sleep in milliseconds between retries when the Internet connection seems down during retrieval of data.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-internet-down-sleep-multiplicator
Multiplication factor for sleep between retries when the Internet connection seems down during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-io-exception-max-tries
Maximum number of tries when a network I/O connection failure occurs during retrieval of data.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-io-exception-sleep-initial-ms
Initial sleep in milliseconds between retries when a network I/O connection failure occurs during retrieval of data.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-io-exception-sleep-max-ms
Maximum sleep in milliseconds between retries when a network I/O connection failure occurs during retrieval of data.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-io-exception-sleep-multiplicator
Multiplication factor for sleep between retries when a network I/O connection failure occurs during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-json-exception-max-tries
Maximum number of tries when an invalid JSON body is returned.
- Default:
3 - Set from: connection string, set statement, provider file
download-error-json-exception-sleep-initial-ms
Initial sleep in milliseconds between retries when an invalid JSON body is returned.
- Default:
1000 - Set from: connection string, set statement, provider file
download-error-json-exception-sleep-max-ms
Maximum sleep in milliseconds between retries when an invalid JSON body is returned.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-json-exception-sleep-multiplicator
Multiplication factor for sleep between retries when an invalid JSON body is returned.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-name-resolution-failure-max-tries
Maximum number of tries when the host name could not be resolved during retrieval of data.
- Default:
5 - Set from: connection string, set statement, provider file
download-error-name-resolution-failure-sleep-initial-ms
Initial sleep in milliseconds between retries when the host name could not be resolved during retrieval of data.
- Default:
5000 - Set from: connection string, set statement, provider file
download-error-name-resolution-failure-sleep-max-ms
Maximum sleep in milliseconds between retries when the host name could not be resolved during retrieval of data.
- Default:
5000 - Set from: connection string, set statement, provider file
download-error-name-resolution-failure-sleep-multiplicator
Multiplication factor for sleep between retries when the host name could not be resolved during retrieval of data.
- Default:
1 - Set from: connection string, set statement, provider file
download-error-other-exception-max-tries
Maximum number of tries when an unqualified error occurs during retrieval of data.
- Default:
3 - Set from: connection string, set statement, provider file
download-error-other-exception-sleep-initial-ms
Initial sleep in milliseconds between retries when an unqualified error ocurrs during retrieval of data.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-other-exception-sleep-max-ms
Maximum sleep in milliseconds between retries when an unqualified error ocurrs during retrieval of data.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-other-exception-sleep-multiplicator
Multiplication factor for sleep between retries when an unqualified error ocurrs during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-socket-exception-max-tries
Maximum number of tries when the network connection is forcible dropped during retrieval of data.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-socket-exception-sleep-initial-ms
Initial sleep in milliseconds between retries when the network connection is forcible dropped during retrieval of data.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-socket-exception-sleep-max-ms
Maximum sleep in milliseconds between retries when the network connection is forcible dropped during retrieval of data.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-socket-exception-sleep-multiplicator
Multiplication factor for sleep between retries when the network connection is forcible dropped during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-web-exception-max-tries
Maximum number of tries when a web connection failure occurs during retrieval of data.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-web-exception-sleep-initial-ms
Initial sleep in milliseconds between retries when a web connection failure occurs during retrieval of data.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-web-exception-sleep-max-ms
Maximum sleep in milliseconds between retries when a web connection failure occurs during retrieval of data.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-web-exception-sleep-multiplicator
Multiplication factor for sleep between retries when a web connection failure occurs during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-web-not-found-max-tries
Maximum number of tries when the HTTP server reports that the resource was not found during retrieval of data.
- Default:
1 - Set from: connection string, set statement, provider file
download-error-web-not-found-sleep-initial-ms
Initial sleep in milliseconds between retries when the HTTP server reports that the resource was not found during retrieval of data.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-web-not-found-sleep-max-ms
Maximum sleep in milliseconds between retries when the HTTP server reports that the resource was not found during retrieval of data.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-web-not-found-sleep-multiplicator
Multiplication factor for sleep between retries when the HTTP server reports that the resource was not found during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-web-not-implemented-max-tries
Maximum number of tries when the connection reports not implemented.
- Default:
1 - Set from: connection string, set statement, provider file
download-error-web-not-implemented-sleep-initial-ms
Initial sleep in milliseconds between retries when the connection reports not implemented.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-web-not-implemented-sleep-max-ms
Maximum sleep in milliseconds between retries when the connection reports not implemented.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-web-not-implemented-sleep-multiplicator
Multiplication factor for sleep between retries when the connection reports not implemented.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-web-timeout-max-tries
Maximum number of tries when the connection reports a timeout.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-web-timeout-sleep-initial-ms
Initial sleep in milliseconds between retries when the connection reports a timeout.
- Default:
1000 - Set from: connection string, set statement, provider file
download-error-web-timeout-sleep-max-ms
Maximum sleep in milliseconds between retries when the connection reports a timeout.
- Default:
30000 - Set from: connection string, set statement, provider file
download-error-web-timeout-sleep-multiplicator
Multiplication factor for sleep between retries when the connection reports a timeout.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-web-unauthorized-max-tries
Maximum number of tries when the connection reports an unauthorized error.
- Default:
1 - Set from: connection string, set statement, provider file
download-error-web-unauthorized-sleep-initial-ms
Initial sleep in milliseconds between retries when the connection reports an unauthorized error.
- Default:
10000 - Set from: connection string, set statement, provider file
download-error-web-unauthorized-sleep-max-ms
Maximum sleep in milliseconds between retries when the connection reports an unauthorized error.
- Default:
300000 - Set from: connection string, set statement, provider file
download-error-web-unauthorized-sleep-multiplicator
Multiplication factor for sleep between retries when the connection reports an unauthorized error.
- Default:
2 - Set from: connection string, set statement, provider file
download-error-web-unknown-max-tries
Maximum number of tries when the HTTP server returns an error which could not be classified during retrieval of data.
- Default:
10 - Set from: connection string, set statement, provider file
download-error-web-unknown-sleep-initial-ms
Initial sleep in milliseconds between retries when the HTTP server returns an error which could not be classified during retrieval of data.
- Default:
5000 - Set from: connection string, set statement, provider file
download-error-web-unknown-sleep-max-ms
Maximum sleep in milliseconds between retries when the HTTP server returns an error which could not be classified during retrieval of data.
- Default:
30000 - Set from: connection string, set statement, provider file
download-error-web-unknown-sleep-multiplicator
Multiplication factor for sleep between retries when the HTTP server returns an error which could not be classified during retrieval of data.
- Default:
2 - Set from: connection string, set statement, provider file
ignore-http-400-errors
Ignore HTTP 400 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
ignore-http-401-errors
Ignore HTTP 401 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
ignore-http-402-errors
Ignore HTTP 402 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
ignore-http-403-errors
Ignore HTTP 403 errors when exchanging results with the HTTP endpoint.
- Default:
True - Set from: connection string, set statement, provider file
ignore-http-404-errors
Ignore HTTP 404 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
ignore-http-422-errors
Ignore HTTP 422 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
ignore-http-429-errors
Ignore HTTP 429 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
ignore-http-500-errors
Ignore HTTP 500 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
ignore-http-502-errors
Ignore HTTP 502 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
ignore-http-503-errors
Ignore HTTP 503 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
invalid-json-on-get-max-tries
Maximum number of tries when the JSON received on GET is invalid.
- Default:
3 - Set from: connection string, set statement, provider file
invalid-json-on-get-sleep-initial-ms
Initial sleep in milliseconds between retries when the JSON received on GET is invalid.
- Default:
1000 - Set from: connection string, set statement, provider file
invalid-json-on-get-sleep-max-ms
Maximum sleep in milliseconds between retries when the JSON received on GET is invalid.
- Default:
10000 - Set from: connection string, set statement, provider file
invalid-json-on-get-sleep-multiplicator
Multiplication factor for sleep between retries when the JSON received on GET is invalid.
- Default:
2 - Set from: connection string, set statement, provider file
invantive-sql-execution-profile-disk-file-name
Name of the file to write the execution profile of statements to.
- Default:
profile-{date}-{applicationname}-{currentprocessid}-{sessionid}.ndjson - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
invantive-sql-execution-profile-disk-path
Folder to write the execution profile of statements to.
- Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
invantive-sql-execution-profile-to-disk
Whether to write the execution profile of statements to disk.
- Default:
False - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
log-native-calls-to-disk-max-events
Maximum number of call events to register from last activation.
- Set from: connection string, set statement, provider file
- Defined by: Shared
log-native-calls-to-disk-max-sec
Maximum number of seconds to register calls from last activation.
- Set from: connection string, set statement, provider file
- Defined by: Shared
log-native-calls-to-disk-on-error
Registers native calls to data container backend as disk files when the call raised an error.
- Default:
False - Set from: connection string, set statement, provider file
- Defined by: Shared
log-native-calls-to-disk-on-success
Registers native calls to data container backend as disk files when the call raised no error.
- Default:
False - Set from: connection string, set statement, provider file
- Defined by: Shared
log-native-calls-to-trace
Log native calls to data container backend on the trace.
- Default:
False - Set from: connection string, set statement, provider file
- Defined by: Shared
simulate-http-400-errors
Simulate HTTP 400 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-400-errors-percentage
Percentage of simulated HTTP 400 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-401-errors
Simulate HTTP 401 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-401-errors-percentage
Percentage of simulated HTTP 401 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-403-errors
Simulate HTTP 403 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-403-errors-percentage
Percentage of simulated HTTP 403 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-408-errors
Simulate HTTP 408 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-408-errors-percentage
Percentage of simulated HTTP 408 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-429-errors
Simulate HTTP 429 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-429-errors-percentage
Percentage of simulated HTTP 429 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-500-errors
Simulate HTTP 500 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-500-errors-percentage
Percentage of simulated HTTP 500 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-502-errors
Simulate HTTP 502 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-502-errors-percentage
Percentage of simulated HTTP 502 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-503-errors
Simulate HTTP 503 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-503-errors-percentage
Percentage of simulated HTTP 503 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-504-errors
Simulate HTTP 504 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-504-errors-percentage
Percentage of simulated HTTP 504 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-522-errors
Simulate HTTP 522 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-522-errors-percentage
Percentage of simulated HTTP 522 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-524-errors
Simulate HTTP 524 errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-524-errors-percentage
Percentage of simulated HTTP 524 errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-protocol-errors
Simulate HTTP protocol errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-protocol-errors-percentage
Percentage of simulated HTTP protocol errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
simulate-http-timeout-errors
Simulate HTTP timeout errors when exchanging results with the HTTP endpoint.
- Default:
False - Set from: connection string, set statement, provider file
simulate-http-timeout-errors-percentage
Percentage of simulated HTTP timeout errors when exchanging results with the HTTP endpoint.
- Default:
0 - Set from: connection string, set statement, provider file
Performance
bulk-delete-page-size-rows
Number of rows to delete per batch when bulk deleting.
- Default:
10000 - Set from: connection string, set statement, provider file
- Defined by: Shared
bulk-insert-page-size-bytes
Approximate maximum size in bytes of batch when bulk inserting.
- Default:
10000000 - Set from: connection string, set statement, provider file
- Defined by: Shared
bulk-insert-page-size-rows
Number of rows to insert per batch when bulk inserting.
- Default:
250 - Set from: connection string, set statement, provider file
- Defined by: Shared
http-body-read-timeout-ms
Number of milliseconds the body of an answer may stay silent before the read is ended and tried again.
- Default:
300000 - Set from: connection string, set statement, provider file
http-get-timeout-max-ms
HTTP GET maximum timeout on retry (ms).
- Default:
24000 - Set from: connection string, set statement, provider file
http-get-timeout-ms
HTTP GET timeout (ms).
- Default:
56000 - Set from: connection string, set statement, provider file
http-post-timeout-max-ms
HTTP POST maximum timeout on retry (ms).
- Default:
58000 - Set from: connection string, set statement, provider file
http-post-timeout-ms
HTTP POST timeout (ms).
- Default:
57000 - Set from: connection string, set statement, provider file
invantive-sql-psql-max-parallel
Maximum degree of the PSQL parallel constructs: session default and cap for every parallel statement or loop without an explicit degree. The value 1 runs every parallel construct sequentially with unchanged semantics.
- Default:
48 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading
Whether data which the session is expected to ask for shortly may be fetched while the session is idle. What that may cost is governed by the settings below, and it stops the moment the session asks for something itself.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-blobs-per-minute
Number of file contents, such as document attachments, which may be fetched ahead per minute. Most platforms do not count these against their request rate, so they pace themselves.
- Default:
20 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-daily-reserve-fraction
Part of the daily allowance of a platform which is never spent on fetching ahead, so that a session keeps room for the rest of its day.
- Default:
0,4 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-disk-budget-mb
Number of megabytes which fetching ahead may write to the local caches of this user.
- Default:
8192 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-first-use-rows
Number of rows fetched of each table in a session for which no history of earlier questions is available. A first look at a table shows a few hundred rows, and having those ready is what makes it feel instant.
- Default:
1000 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-horizon-min
Number of minutes ahead over which the expectation of a table being asked for is weighed.
- Default:
60 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-idle-scope-data-container
Whether only the traffic of the same data container counts as the session being busy, rather than all traffic of the session. Suits a script, which is nearly always busy on one platform while its next step reads another.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-idle-sec
Number of seconds a session must have been idle before data is fetched ahead, and before fetching resumes after the session asked for something.
- Default:
5 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-journal
Whether the history of earlier questions of this user is used to decide what to fetch ahead. Switched off, only what the drivers propose and what is announced is used.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-linger-sec
Number of seconds a host keeps a session after its user has left, for as long as fetching ahead has work which the allowances permit.
- Default:
900 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-max-parallel
Number of tables which may be fetched ahead at the same time on one connection.
- Default:
4 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-max-unattended-sec
Number of seconds without any question from the session after which fetching ahead stops until the session asks something again.
- Default:
7200 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-node-max-parallel
Number of tables which may be fetched ahead at the same time by this installation, over all the sessions it serves.
- Default:
4 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-partitions
Codes of the partitions, separated by commas, on which fetching ahead may work. Left empty, it works on every partition the session has selected.
- Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-rate-fraction
Part of the minutely request rate of a platform, per partition, which may be spent on fetching ahead. The remainder stays free for what the session asks itself.
- Default:
0,75 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-serve-stale-max-age-sec
Age in seconds up to which a question about a table which is held locally is answered from what is held, without asking the platform for the changes since. The local copy is brought up to date behind the answer, so the next question sees them. Empty, which is the default, always asks.
- Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-superset
Whether a question with a filter may be answered from a table which this session already fetched whole, instead of asking the platform to apply the filter.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
preemptive-loading-superset-max-rows
Number of rows up to which a question with a filter is answered from a set which this session already fetched whole, instead of asking the platform to apply the filter. Above it the platform is asked, since walking a large set locally costs more than a call which returns a fraction of it.
- Default:
250000 - Set from: connection string, set statement, provider file
- Defined by: SQL Engine V1
requested-page-size
Preferred number of rows to exchange per round trip; only effective on limited platforms such as AFAS Online.
- Set from: connection string, set statement, provider file
- Defined by: Shared
requests-parallel-max
Maximum number of parallel data requests from individual partitions on the data container.
- Default:
32 - Set from: connection string, set statement, provider file
- Defined by: Shared
use-batch-insert
Whether to use batch insert.
- Default:
True - Set from: connection string, set statement, provider file
- Defined by: OData
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver:
Changes of Attributes, 26.0 to 27.0
Attribute max-discovered-column-count is added
Can be set from connection string, SET statement, provider file, log-on. Default 250.
- importance 3
Engine-wide connection attributes change
28 attributes added, 3 removed and 5 settings of attributes changed. These attributes belong to the SQL engine and exist for every driver; the Query Tool notes describe them.
- importance 2