DataSourceHandle - Data source
A data source describes an ODABA data source on a certain level (Dictionary, Database, DBObjectHandle, Extent, Instance). A data source can be parametrized by means of an configuration or ini-file. The ini-file contains the names for the objects on the different levels. Not specified lower levels are not opened and have to be opened in the application (e.g. when defining only dictionary and database the extent is not opened and no instance is selected), The data source is defined as section in the ini-file starting with the [data source name] or as xml-element with that name in an configuration file.
A data source can be directed to a server. In this case the data source has to be opened with a connected ODABA client or the ini-file must contain a server specification. In the last case the data source connects to the server automatically when opening the data source. The connection is owned by the data source in this case.
A data source can be opened and closed as a whole (Open(), Close()) or separately on each definition level (Connect(), OpenDictionary(), ...).
A data source may have a connection name, which is used to cache the connection when running in client/server mode. The connection name is used to reconnect to the server using a cached connection, which is faster than reestablishing the connection from scratch.
An application may refer to any number of data sources. Usually, the first data source opened will initialize the application environment, which contains the currently set options from the configuration and from the application.
- client - Data source client property
- connection_name - CONNECTION_NAME option
- server_name - SERVER_URL option
- server_port - SERVER_PORT option
- data_source - Data source name
- repl_db - Replication database
- system_version - SYSTEM_VERSION option
- is_pif - Platform independent database access
- dict_path - DICTIONARY options
- dict_type - DICTIONARY.TYPE option
- schema_version - SCHEMA_VERSION option
- dictionary - Dictionary handle
- res_path - RESOURCES options
- res_type - RESOURCES.TYPE option
- reshandle - Database handle for resource database
- db_path - DATABASE options
- db_type - DATABASE.TYPE option
- version - VERSION option
- online_version - ONLINE_VERSION option
- netopt - SHARE option
- system_upgrade - Automatic system upgrade
- accmode - ACCESS_MODE option
- dbhandle - Database handle
- object_name - OBJECT_SPACE option
- object_handle - Object space handle
- extent_name - ACCESS_PATH option
- inst_key - ACCESS_KEY option
- struct_name - DATA_TYPE option
- extent_pi - Property handle for collection
- dict_connection - DICTIONARY.CONNECTION option
- res_connection - RESOURCES.CONNECTION option
- db_connection - DATABASE.CONNECTION option
- workspace - Workspace name
- sys_appl - ENABLE_CONTEXT handler option
- transaction - Transaction opened for data source
- client_connected - Client connected
- client_created - Client handle created
- dict_opened - Dictionary opened and owned by data source
- res_opened - Resource database opened
- base_opened - Database opened and owned by data source
- object_opened - Object space opened and owned by data source
- extent_opened - Collection handle opened and owned by data source
- BeginTransaction - Start transaction for the data source
- Close - Close DataSourceHandle
- CloseDBObject - Close DBObjectHandle
- CloseDatabase - Close the database
- CloseDictionary - Close DictionaryHandle
- CloseProperty - Close PropertyHandle
- CloseResourceDB - Closing the resource database
- CommitTransaction - Terminate transaction
- Connect - Connect DataSourceHandle to server
- DBReplication - - internal feature (not documented)
- DataSourceHandle - Constructor
- Disconnect - Disconnect from server
- GetClient - Get client handle from data source
- Initialize - Initialize DataSourceHandles
- Initialize_intern - - internal feature (not documented)
- LoadOptions - Load options when database not yet opened
- Open - Open DataSourceHandle
- OpenDBObject - Open DBObjectHandle
- OpenDBorINI - Open database file or database via ini-file
- OpenDatabase - Open database handle
- OpenDictionary - Open DictionaryHandle
- OpenDicts - - internal feature (not documented)
- OpenINI - - internal feature (not documented)
- OpenProperty - Open PropertyHandle
- OpenResourceDB - Open resource database
- OpenSection - - internal feature (not documented)
- RollBack - Rollback modifications made in the transaction
- SetConnectionName - Set name for connection cache
- SetDBObject - Set DBObjectHandle
- SetDataSource - Set data source definitions
- SetDatabase - Set database
- SetDictionary - Set DictionaryHandle
- SetResourceDB - Set resource database
- SetVariables - Initialize data source handle variables
- SetupVariables - Setup data source variables from INI-file
- ShutDown - - internal feature (not documented)
- operator= - - internal feature (not documented)
- ~DataSourceHandle - Destructor