Keyword

Description

CHECK_KEY=Y

Checks the data table for the existence of a unique index value as the end user attempts to input a data into a record. If a duplicate value is input by the end user into the variables constructing an index defined as Unique in Magic xpa’s Data repository, Magic xpa will issue a Duplicate Index error message and prevent further end-user processing until the input is changed. For some DBMSs, this check takes a toll in performance and it is not recommended. In such a case, the developer may decide not to use this keyword, and then the results of duplicate index value entry will depend on the DBMS behavior.

?

FORCE_INDEX=N

Forces the optimizer to use an index.

?

?

LimitLinkToSingleFetch=Y

During a Link Query operation, this keyword limits the link to fetching a single record, even if the cursor returns more than one record. This improves the operation's performance. To maintain the previous behavior of not limiting the fetch to one record, set this keyword to N. Since version: 3.2

?

MAGICKEY=N

For a data source with no unique index, adds a column that will be the unique index. Magic xpa will insert values automatically to this column. The column that is the MAGICKEY should be selected.

?

?

MSDATE=Y

If this keyword is set to N, the default attribute is changed to Alpha. The date format will be YYYY-MM-DD-HH24:MM:SS.

?

ONLINE_ARRAY_FETCHING=Y

This keyword defines whether the Array Size value will be applicable for both Online and Batch tasks; or only for Batch tasks.

If this keyword is set to Y, the Array Size value will be applicable for both; Online and Batch tasks.

If this keyword id set to N, the old behavior is retained where the Array Size value will be used only for Batch tasks. In this case, value 1 will be used for Online tasks.

Since version: 3.2d

SQL_APPLICATION_ROLE = [Role Name]

SQL_APPLICATION_ROLE_PASSWORD = [Password]

The connection to the database can be done under a specified application role using these two keywords. These keywords have no default.

Secret names can be used to define the role name and password.

?

SQL_ DATETOALPHA=N

Automatically converts the RDBMS date field to a Magic xpa Alpha Zstring field with a length of 19 characters and with the format YYYY- MM- DD HH: MM: SS.

Note: Neither Magic xpa nor the RDBMS can perform data validation on an Alpha_ Date field due to the use of the internal date format in the RDBMS. If you use the SQL_ DATETOALPHA parameter you should implement your own validity checks for Insert and Update operations. Otherwise, invalid dates can be inserted in the database.

?

SQL_PHYSICAL_LOCKING=Y

MSSQL supports physical locking at the row level as a default, when using physical transactions.

To use logical locking, add the flag: SQL_PHYSICAL_LOCKING=N

When this flag is set to Y or the flag is not set at all, Magic xpa sends the UPDLOCK table hint in the FROM clause as described below:

SELECT a,b

FROM tab1 (UPDLOCK NOWAIT)

ORDER BY a

?

SQLBLOB = size

When using the TEXT data type in a Direct SQL statement, the maximum BLOB size will be 64K. To change that size (either increasing or decreasing it) use the SQLBLOB = size keyword.

The default value is 65534 and the maximum value is 2147483647.

This keyword is relevant for:

1. Stored procedures using DSQL.

2. DSQL SELECT operations with a non-MSSQL result database.

This keyword is irrelevant for:

1. Browse tables. Instead, use the size of the BLOB before fetching the BLOB data.

2. DSQL SELECT operations with an MSSQL result database. Instead, temporarily create a table; before fetching the data, Magic xpa calculates the size of the BLOB field.

?

SQL_ALWAYS_ON=Y

In order to use the 'Always On Availability' feature, this keyword is required to be set in the Database properties. If it is set, then the gateway will use the properties required to connect to an Always On server.

Since version: 3.3c

Note: Always On feature can be used with SQLServer (Enterprise Edition) and Windows Servers (2012 and above) only.

?

DataTypeCompatibility=N

When this compatibility flag is set to 'Yes', the new MSOLEDB driver works as same as the legacy SQLOLEDB driver in terms of data handling. No use of this flag provides current behavior.

Since version: 3.3e

?