DataBase Object

Description

The DataBase object enables connectivity to Database Management Systems (DBMS). The Open Database Connectivity (ODBC) application program interface (API) is used as the connection mechanism. User-supplied Structured Query Language (SQL) statements specify the DBMS actions to be performed. See the Databases Guide for more information.

Inheritance Hierarchy: Object->DataBase

Available In Editions:

Mission

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Name	Description	Attributes
CommitMode	The database attribute that determines whether the commit mode for the database is set to auto-commit or manual commit. Not all database types that are run through ODBC support manual commit mode. This property must be set while the database is unopened.	Type: Variable Access: Read/Write
DataBaseLogFile	The file name for the database message log file. This file will contain messages resulting from database activity. Of specific interest will be the error messages.	Type: String Access: Read/Write
DataSourceName	Specifies the name used by ODBC to connect to a specified database through a specified driver.	Type: String Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
IsOpen	Returns a 0/1 flag indicating whether the DataBase object is opened or not.	Type: Variable Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Password	The password associated with the UserName for login.	Type: String Access: Read/Write
ResultArrayLimit	Maximum array limit when retrieving data from a SQL Call	Type: Variable Access: Read/Write
Timeout	The database attribute that determines how long in seconds a transaction will wait to perform its command before returning a timeout error. Not all database types that are run through ODBC support non-zero timeouts, and oftentimes will not report an error when they do not support it, but will instead automatically reset the timeout to 0. A value of 0 implies no time limit.	Type: Variable Access: Read/Write
UserName	The user name to be used for database login.	Type: String Access: Read/Write