Please enable JavaScript to view this site.

Navigation: » No topics above this level «

Twinfield SQL Driver Attributes

Contents Previous Home Next More

The SQL driver for Twinfield has many attributes that can be finetuned to improve handling in scenarios with unreliable network connections to the API server of Twinfield or high-volumes of data. Also, many drivers have driver-specific attributes to finetune actual behaviour or handle data not matching specifications.

The Twinfield driver attributes are assigned a default value which seldom requires change. However, changes can be applied when needed on four levels, which are reflected in the table below by separate checkmarks:

Connection string: the connection string from the settings*.xml file and applied during log on.

Set SQL statement: a set SQL-statement to be executed once connection has been established.

Drivers file: the providers.xml file (obsolete starting release 17.32).

Log on: value to be specified interactively by user during log on in a user interface.

The connection string for Twinfield can be found in the settings*.xml file used for the database. Settings*.xml files are typically located in the %USERPROFILE%\invantive folder in most deployment scenarios. The reference manuals contain instructions how to relocate the settings*.xml files. Each data container of a database in the connection string can have a connectionString element specifying the name and values of attributes. Both name and value must be properly escaped according to XML-semantics. Actual application of the value is solely done during log on. A new connection must be established to change the value of a driver attribute using a connection string.

The set SQL statement can be executed after log on. The syntax is: set NAME VALUE, or for a distributed database: set NAME@ALIAS VALUE. In some scenarios you may need to enclose the driver attribute name in square brackets to escape it from parsing, for instance when a reserved SQL keyword is part of the name. The new value takes effect straight after execution of the set-statement. The set-statement can be executed as often as needed during a session.

Driver attributes that can be interactively set to a value are typically presented in the log on window. Depending on the platform and design decisions of the user interface designer, some or all of the available driver attributes can have been made available.

The Twinfield driver can be configured using the following attributes:

Code

Description

Origin

Default Value

Set from Connection String

Set from Set SQL-Statement

Set from Drivers File

Set from Log On

analysis-enforce-row-uniqueness

Use for analysis only! Enforce rows to be unique.

Shared

False

 

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.

 

 

 

api-client-id

The client ID is a unique identifier of your application. It is generated by registering an application.

 

 

 

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.

 

 

 

api-redirect-url

The redirect URI is the website a browser session is redirected to after the OAuth2 authentication process has been completed.

 

 

 

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.

 

 

 

api-scope

The scope to request an OAuth token for.

 

 

 

 

api-token-url

The token URI is the OAuth2 endpoint to exchange tokens.

 

 

 

 

bulk-delete-page-size-rows

Number of rows to delete per batch when bulk deleting

Shared

10000

 

bulk-insert-page-size-bytes

Approximate maximum size in bytes of batch when bulk inserting

Shared

10000000

 

bulk-insert-page-size-rows

Number of rows to insert per batch when bulk inserting

Shared

10000

 

environment

{res:itgen_twinfield_environment_description}

Twinfield

 

 

force-case-sensitive-identifiers

Consider identifiers as case-sensitive independent of the platform capabilities.

Shared

False

 

forced-casing-identifiers

Forced casing of identifiers. Choose from Unset, Lower, Upper and Mixed.

Shared

 

 

http-disk-cache-compression-level

Compression level for the HTTP disk cache, ranging from 1 (little) to 9 (intense). Default is 5.

Shared

5

 

http-disk-cache-directory

Directory where HTTP cache is stored.

Shared

C:\Users\gle3.WS212\Invantive\Cache\http\gle3\shared

 

http-disk-cache-ignore-write-errors

Whether to ignore write errors to disk cache.

Shared

False

 

http-disk-cache-max-age-sec

Maximum acceptable age in seconds for use of data in the HTTP disk cache.

Shared

2592000

 

http-get-timeout-ms

HTTP GET timeout (ms)

 

90000

 

http-memory-cache-compression-level

Compression level for the HTTP memory cache, ranging from 1 (little) to 9 (intense). Default is 5.

 

5

 

http-memory-cache-max-age-sec

Maximum acceptableage in seconds for use of data in the HTTP memory cache.

 

14400

 

http-post-timeout-ms

HTTP POST timeout (ms)

 

90000

 

include-inaccessible-companies

Include inaccessible companies for the current user in list of partitions, such as template companies which can not be recognized in the API currently.

Twinfield

False

 

invantive-sql-compress-sparse-arrays

Whether to compress sparse arrays in result sets during compression.

SQL Engine V1

True

 

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.

SQL Engine V1

False

 

invantive-sql-forward-filters-to-data-containers

Whether to forward filters to data containers.

SQL Engine V1

True

 

invantive-sql-share-byte-arrays

Whether to share the memory used by identical byte arrays in result sets during compression.

SQL Engine V1

True

 

invantive-sql-share-strings

Whether to share the memory used by identical strings in result sets during compression.

SQL Engine V1

True

 

invantive-sql-shuffle-fetch-results-data-containers

Whether to shuffle results fetched from data containers.

SQL Engine V1

False

 

invantive-use-cache

Whether to cache the results of a query.

SQL Engine V1

True

 

log-native-calls-to-disk-max-events

Maximum number of events to register from last activation.

Shared

 

 

log-native-calls-to-disk-max-seconds

Maximum number of seconds to register from last activation.

Shared

 

 

log-native-calls-to-disk-on-error

Registers native calls to data container backend as disk files when an error occurred.

Shared

False

 

log-native-calls-to-disk-on-success

Registers native calls to data container backend as disk files when successful.

Shared

False

 

log-native-calls-to-trace

Log native calls to data container backend on the trace.

Shared

False

 

maximum-length-identifiers

Non-default maximum length in characters of identifier names.

Shared

 

 

max-url-length-accepted

The maximum accepted URL length before raising an error.

Shared

8000

 

max-url-length-desired

The maximum desired URL length.

Shared

8000

 

minimum-length-text

Extend all text columns to this length to allow processing of XML that uses longer text values than the XSD specifies.

XML

 

 

 

partition-slot-based-rate-limit-length-ms

Total length in ms across all slots of a partition-based rate limit.

Shared

60000

 

 

partition-slot-based-rate-limit-slots

Number of slots per partition-based rate limit. Null means no slot-based rate limit

Shared

 

 

 

pre-request-delay-ms

Pre-request delay in milliseconds per request.

Shared

0

 

reauthenticate-max-tries

Maximum number of tries upon a reauthentication failure.

Twinfield

5

 

 

requested-page-size

Preferred number of rows to exchange per round trip; only effective on limited platforms such as AFAS Online

Shared

 

 

requests-parallel-max

Maximum number of parallel data requests from individual partitions on the data container.

Shared

4

 

result-set-memory-cache

Action: provide 'empty' to empty.

XML

 

 

 

 

slot-based-rate-limit-length-ms

Total length in ms across all slots of a slot-based rate limit.

Shared

60000

 

 

slot-based-rate-limit-slots

Number of slots of a slot-based rate limit. Null means no slot-based rate limit

Shared

 

 

 

standardize-identifiers

Rewrite all identifiers to the preferred standards as configured by standardize-identifiers-casing and maximum-length-identifiers.

Shared

True

 

standardize-identifiers-casing

Rewrite all identifiers to the recommended standard platform-specific casing when changing a data model on a case-dependent platform.

Shared

True

 

trace-uncompressed-xml

Send uncompressed XML response payload to trace logging.

Twinfield

False

 

 

use-http-disk-cache-read

Whether to use HTTP responses from previous queries stored on disk to answer the current query.

Shared

False

 

use-http-disk-cache-write

Whether to memorize HTTP responses on disk.

Shared

False

 

use-http-memory-cache-read

Whether to use HTTP responses from previous queries stored in memory to answer the current query

 

True

 

use-http-memory-cache-write

Whether to memorize HTTP responses in memory

 

True

 

use-metadata-memory-cache

Whether to use the metadata in memory calculated previously

Has only practical use during development on a XML provider.

XML

True

 

use-result-memory-cache

Whether to use result sets cached in memory from previous queries that can answer the current query.

XML

False

 

 

27-12-2021 11:20 Version 20.2.169-PROD+3633