Object Summary

Show this topic in Library frames

The Distributed Tuning Objects Reference is divided into three chapters by functional grouping. The objects in each chapter are listed in this section.

Connection Object

DtoSession

The DtoSession object is the core of DTO. It is through the DtoSession object that an application connects to Pervasive.SQL servers. A DTO application creates a DtoSession object and uses the Connect method when a session is required on a specific database server.

Configuration Objects

DtoCategory

Object DtoCategory and collection DtoCategories group database engine settings and allow the user further access to the DtoSetting objects.

DtoSetting

Object DtoSetting and collection DtoSettings expose the specific settings for the database engines, the communication managers, and the local requester components and allow the user to change these settings. Each category typically exposes a collection of settings.

DtoSelectionItem

Object DtoSelectionItem and collection DtoSelectionItems contain the full range of items in a setting where selection is allowed. DtoSetting.AllPossibleSelections returns a collection of all possible values for a given setting.

DtoServices

Object DtoServices allows the user to start and stop Pervasive.SQL database services, and to query the current status of a service.

DtoLicenseMgr

Object DtoLicenseMgr (DTO2) allows for adding and removing licenses.

Monitoring Objects

DtoMonitor

Object DtoMonitor allows the user to retrieve real-time status information of the database engine and other related services.

Also exposed in DtoMonitor object is information about resource usage such as current, peak, and maximum settings for file handles, open files, and licenses. A peak value is the maximum value since the last engine restart.

DtoOpenFile

Object DtoOpenFile and collection DtoOpenFiles contain information about active files. This allows user to monitor file access by determining how many files are open, what users have them open, and other related information.

DtoFileHandle

Object DtoFileHandle and collection DtoFileHandles expose user name/agent ID, connection, task, site, network address, open mode, record lock type, wait state, and transaction state.

DtoMkdeClient

Object DtoMkdeClient and collection DtoMkdeClients expose the information about active clients. For a particular client, you can query to see if there is an active session of that client and if so, get data about that session and optionally terminate the client.

DtoMkdeClientHandle

Object DtoMkdeClientHandle and collection DtoMkdeClientHandles expose handle information, including the name and associated information for each file.

DtoMkdeVersion

Object DtoMkdeVersion (DTO2) exposes the major and minor version, build number, and target operating system of the Pervasive.SQL engine.

DtoEngineInformation

Object DtoEngineInformation (DTO2) exposes the major and minor version, DTI API version, and other server and client information.

DtoSqlClient

Object DtoSqlClient and collection DtoSqlClients expose the information about active SQL users such as count and list of active SQL users, and detail information about each client.

DtoCommStat

Object DtoCommStat exposes the communication statistics. You can query the current, peak, and maximum values where appropriate.

DtoProtocolStat

Object DtoProtocolStat and collection DtoProtocolStats expose information regarding each network protocol running on a server.

Database and Dictionary Objects

DtoDatabase

Object DtoDatabase and collection DtoDatabases are responsible for managing the database catalog information, such as database name, database flags, security, and table definitions.

DtoDSN

Object DtoDSN and collection DtoDSNs represent the Pervasive.SQL DSNs on your server. They can be used to create new DSNs and to manage existing Pervasive.SQL ODBC DSNs.

DtoDictionary (deprecated)

Object DtoDictionary is the root object for all of the operations affecting dictionary files. Use this object to open a dictionary, create a dictionary, get table information add a table or drop a table.

The preferred method of accessing the Tables collection is using the DtoDatabase object.

DtoTable

Object DtoTable and collection DtoTables are responsible for managing the table information, such as name, columns, and indexes.

DtoColumn

Object DtoColumn and collection DtoColumns are responsible for managing the information about the columns.

DtoIndex

Object DtoIndex and collection DtoIndexes expose the indexes defined for a table.

DtoSegment

Object DtoSegment and collection DtoSegments contain information on the segments of a given index for a table.