Data source properties and option names

Data source properties can be initialized from options set in a section of a configuration or ini-file or from data source definitions in a data catalog. Within a configuration file, data source properties must be defined in a section with the data source name ([datasourceName]). Data source properties are initialized from following options:

serverName: REPLICATION_SERVER or SERVER_URL

serverPort: SERVER_PORT (6123)

connectionName: CONNECTION_ID

This variables define data source connection parameters, which are required for for object or replication server clients, only.

dictionaryPath: DICTIONARY

dictionaryType: DICTIONARY.TYPE (ODABA)

connectionConnection: DICTIONARY.CONNECTION (AUTOMATIC)

This variables define the dictionary database. This dictionary path is mandatory. The value may refer to a server variable that defines the path on the server. Server database paths are usually referred as server option variables defined in the server's file catalog. The connection type usually is determined by the system. In order to request explicit server or local database access, the connection type should be set to SERVER or LOCAL.

databasePath: DATABASE

databaseType: DATABASE.TYPE (ODABA)

databaseConnection: DATABASE.CONNECTION (AUTOMATIC)

databaseSystemUpgrade: DATABASE.SYSTEM_UPGRADE (YES)

This variables define the database to be opened. The path may refer to a server variable that defines the path on the server. Server database paths are usually referred as server option variables (%file_name%) defined in the server's file catalog. The connection type usually is determined by the system. In order to request explicit server or local database access, the connection type should be set to SERVER or LOCAL.

accessMode: ACCESS_MODE (Read)

This variable has to be defined in order to accessing a database in write mode (Write).

sharedDatabase: SHARE (NO)

When opening a data source in local or file server mode (no server defined) this option can be defined in order to share the database with other applications.

enableContext: ENABLE_CONTEXT (YES)

This option allows deactivating the database context defined for the project, i.e. disabling logical consistency or business rules defined by the application. This is useful e.g. for maintenance or reorganization processes.

onlineVersioning: ONLINE_VERSION (NO)

This option activates online versioning in order to update instances to next higher schema version, when the database schema has been changed. When not using online version feature the database has to be reorganized before a new schema version can be used.

databaseVersion: VERSION

Access version number for the object space or database, when the database or object space should be opened with an older (not the current) version. When no version number is passed, the object space or database will be opened with the current version.

schemaVersion: SCHEMA_VERSION

Schema version has to be set in order to open the database for an older schema version (not the latest version) of the dictionary. When no schema version is passed, the database will be opened with the latest schema version.

objectSpaceName: OBJECT_SPACE

The name of an object space must be specified in order to access a sub object space in the database is to be opened.

accessPath: ACCESS_PATH

An access path to a collection can be defined in order to refer to a collection instead to a database or object space.

resourceDatabase: RESOURCES

resourceDatabase: RESOURCES.TYPE (ODABA)

resourceDatabaseConnection: RESOURCES.CONNECTION (AUTOMATIC)

This variables define the file path to the resource database to be opened (optional). When resources are stored in a database different from the dictionary, those can be made available using the resource database. The path may refer to a server variable that defines the path on the server. Server database paths are usually referred to as server option variables (%file_name%) defined in the server's file catalog. The connection type usually is determined by the system. In order to request explicit server or local database access, the connection type should be set to SERVER or LOCAL.

workspacePath: WORKSPACE

When the workspace feature is enabled for the database, a workspace can be defined as active workspace for the data source by passing a workspace name or a workspace path.

typeName: DATA_TYPE

The data type name is used in some cases for performing metadata operations (e.g. copying a data type definition to another dictionary). It is has no direct influence on the data source but can be retrieved by the application.

Alternatively to the ini-file definitions that data source can be described in a data catalog. In this case one may refer to the data source name defined in the data catalog, instead defining the data source in a configuration file.

dataSourceName: DATA_SOURCE

The data source name refers to the data source to be opened. Usually this is the same name as the data source name passed to the function, but it is also possible to refer to another name in this place.

Additional options can be passed in the configuration file, which are not stored in the data source handle.

XS_NAMESPACE

Location for the xml database schema (application schema), when running ODABA as an xml database. The schema location can be local or a WEB URL.

OXS_NAMESPACE=odaba_schema_location

Location for the ODABA schema definition (system schema), which has several extensions to the xml schema definition. The schema location can be local or a WEB URL.