| Attribute | Description | Allowed Values / Examples |
|---|
| Name | Specify a name for the alias. | any string |
|
|---|
| user | Specify the database user. Optionally, the password can be given after a '/', however, this is recommended for development purposes only. | db_user/db_password |
| dbType | Type of the database. | Oracle, SQLServer, InterBase, SQLBase, ODBC, DB2, Informix, Sybase, MySQL, PostgreSQL, SQLite, DBTypeVariable |
| options | This attribute can hold a comma separated list of <name>=<value> pairs. These list elements are interpreted as native options. The possible name-value pairs depend on the database type. A comprehensive list can be found at https://www.sqlapi.com/ApiDoc/servers/ | SSPROP_INIT_ENCRYPT=VARIANT_TRUE |
| Anchor |
|---|
| dbTypeVariable |
|---|
| dbTypeVariable |
|---|
|
dbTypeVariable
| If the attribute dbType is set to DBTypeValue, the dbTypeVariable attribute is used to define the type of the database. The dbType then can be defined by a setting variable.
This is to handle the case, that you not want to hard code the dbType , but to configure it at runtime via the PAS integration component (Bridge).
See Bridge Guide > Using Global Setting Variables. | Info |
|---|
| Use one of the listed dbTypes in the settings variable. If you configure an unknown dbType via the PAS integration component (Bridge), the xUML Runtime will throw an error on service startup. |
| Any global setting variable from the PAS integration component (Bridge): {{my_setting_variable}} |
| Advanced |
| tableQualifier | Specify a string that prefixes tables. For example, if tableQualifier is set to TQ1, all tables accessing the current database are prefixed by "TQ1", e.g. TQ1Customers. If schema and table qualifier are both given, all tables will become: <schema>.<tableQualifier><tableName>. | Multiexcerpt |
|---|
| MultiExcerptName | table_hint |
|---|
| | Info |
|---|
| This works only if the tables are marked using the TABLE:: keyword, e.g TABLE::Customers in SQL statements. If you do not prefix the table name by TABLE::, the table name is used as it is. |
|
|
|
| schema | Specify a string that prefixes tables and stored procedures. For example, if schema is set to S1, all tables accessing the current database are prefixed by "S1.". | Multiexcerpt include |
|---|
| MultiExcerptName | table_hint |
|---|
| PageWithExcerpt | SQL |
|---|
|
|
|
| charset | Any database uses a charset to encode strings. If the database uses UNICODE charsets (like UTF-8, UTF-16, UTF-32), encoding is handled automatically. If the database is not UNICODE compliant, the xUML Runtime assumes 7-bit ASCII by default.
However, in many cases it necessary to define the charset explicitly. This is done by the attribute charset. The charset needs to be the same as defined in the database settings. All possible charset definitions are listed in section Charset Definitions. | UTF-8 See Charset Definitions for a list of possible values. |
| timezone | Specify a valid time zone or the value local, which uses the time zone of the xUML service. See Time Zones for a list of possible values. If timezone does not contain any content (is NULL), UTC is used. | local (default) "Australia/Melbourne", "CET", "Etc/GMT+10" |
| dbConnectionString | Specify the database connection string. The format depends on the type of the database. For more details see Database Server-Specific Notes for SQL Adapters. |
|
| transactionIsolationLevel | Specify here the required transaction isolation level of the SQL connection according to SQL-92 standard. Refer to Wikipedia for a detailed description of the available isolation levels. | Info |
|---|
| Please note: - that not all databases support all levels. In this case a database-specific mapping will occur.
- that for persistent state databases no other than <UNSPECIFIED> and DBMS default are allowed.
|
| DBMS default | Use the default isolation level of the connected database system (default). |
| Read uncommitted | Lowest isolation level. Dirty reads allowed, SQL adapter may fetch not-yet-committed changes of other transactions. |
| Read committed | Lock-based concurrency control. |
| Repeatable read | Lock-based concurrency control. |
| Serializable | Highest isolation level. Lock-based concurrency control. |
| unicodeMode | Specify the encoding for database access. | Platform default | Use the platform default mode (default). This is - Unicode: for Windows systems
- non-Unicode: for all others
This option is backwards compatible to older Runtimes. |
| Unicode | Force Unicode mode. |
| non-Unicode | Force non-Unicode mode. |
Pooling
|
|---|
maxConnectionAge | | Multiexcerpt |
|---|
| MultiExcerptName | maxConnectionAge |
|---|
| Specify a maximum connection age in minutes. After this period of time, the connection will be closed and removed from the pool. |
| an integer value |
15 | Keep the connection for 15 minutes (default). |
-1 | Keep the connection forever. |
maxConnectionIdleTime
| | Multiexcerpt |
|---|
| MultiExcerptName | maxConnectionIdleTime |
|---|
| Specify a maximum idle time in minutes. Connections not used for the time specified will be closed and removed from the pool.
This is useful for connections going through firewalls because such connections might be cut off after some time. |
| an integer value |
| 60 | Close the connection after 60 minutes of idle time. |
maxConnectionReuse | | Multiexcerpt |
|---|
| MultiExcerptName | maxConnectionReuse |
|---|
| This attribute controls how often a connection can be reused. After the connection has been reused the number of times specified with maxConnectionReuse, it will be closed and not put back into the pool.
This feature has been introduced because some databases might have problems if one connection is reused too often. Value -1 means the connection will be reused forever. In this case you should define reasonable values for maxConnectionAge or maxConnectionIdleTime (see above). |
| Multiexcerpt |
|---|
| MultiExcerptName | maxConnectionReuse_2 |
|---|
| | Info |
|---|
| Note that a pooling defined with connectionPooling (see below) is implicitly switched off, if maxConnectionReuse is set to 0. |
|
| an integer value | The number of connections to be pooled. |
| 1000 | Allow for a pool size of 1000 connections (default). |
0 | Pooling is implicitly switched off. |
| -1 | Connections are pooled forever. |
| connectionPooling | | Multiexcerpt |
|---|
| MultiExcerptName | connectionPooling |
|---|
| This attribute controls the connection pooling. If true, each connection is put into a pool after use. If an SQL adapter requires a connection, it is taken from the pool. If no connection is available, a new connection is being created and put into the pool after use. The time the connection is kept in the pool depends on the other pooling parameters. |
| true | Database connections are pooled (default). |
| false | Database connections are not pooled. |