3. System Classes : ButtonField Class : DBSessionObject Class
 
Share this page                  
DBSessionObject Class
DBSessionObject Attributes
Attribute
Data Type
Description
Inherited
From
ClassName
varchar(32)
Gives the name of an object's actual type (as opposed to its declared type) (R)
Object
ClientData
Object
Provides a way to associate data with an object (RW)
Object
Database
varchar(256)
Contains the name of the database accessed by the database session (R)
Defined
DBMSError
integer
Contains the local error number associated with the most recently executed SQL statement in the session (R)
Defined
ErrorNumber
integer
Contains the generic error number associated with the most recently executed SQL statement in the session (R)
Defined
Flags
varchar(256)
Contains the flag settings specified when the session was opened (R)
Defined
Ingres
smallint
Applicable only if the ServerType attribute has a value of DS_INGRES_DBMS; is TRUE if the database session is connected to an Ingres DBMS or to an Ingres gateway that supports all Ingres capabilities (R)
Defined
InstanceIdentifier
integer
Contains a value that uniquely identifies an instance of an allocated object (R)
Object
InstanceReferences
integer
Contains the current number of references to the object (R)
Object
PreFetchRows
integer
Lets you set and inquire about the number of rows buffered when fetching data using cursors in readonly mode (RW)
Defined
RowCount
integer
Contains the number of rows affected by the previous SQL statement executed in the session (R)
Defined
ServerClass
integer
Returns the class of DBMS server for the given DBSsessionObject (R)
Defined
ServerType
integer
Stores the type of server to which OpenROAD is connected (R)
Defined
SessionID
integer
Contains the session ID of the session (R)
Defined
State
integer
Contains the connection state of the session (R)
Defined
 
DBSessionObject Methods
Method
Return
Value
Description
Inherited From
CommitWork()
integer
Issues a commit statement in the database session
Defined
Connect
(database =
varchar (256),
[flags = varchar(256)])
integer
Opens a new database connection for the application
Defined
Disconnect()
integer
Closes a database connection
Defined
Duplicate()
DBSessionObject
Makes a duplicate of the object, placing a reference to the new object in a reference variable
Object
GetAttribute
(
attributename = byref(variable)
{,attributename = byref(variable)})
integer
Gets the values of any number of attributes for the object
Object
IsA(class = classname)
integer
Returns TRUE if the object is of the same class as, or one of the subclasses of, the class specified by classname
Object
NewDBComponent
(appname
= varchar(32),
 compname = varchar(32),
 comptype = componentclass,
 remark = varchar(60))
compsource
Creates a new OpenROAD component in an OpenROAD database
Defined
OpenNewConnection()
DBSessionObject
Opens a new connection to the same database as an existing connection
Defined
RaiseDBEvent
(eventname
= varchar(256)
 [, eventtext = varchar(256)]
 [, share = integer])
integer
Raises a database event in the current database session
Defined
RegisterDBEvent
(eventname
=
 varchar(256))
integer
Used to register for a specific activation by name
Defined
RemoveDBEvent
(eventname
= varchar(256))
integer
Used to remove a registration for a database event
Defined
RollBackWork()
integer
Issues a rollback statement in the database session
Defined
SequenceValue
(table_name =
varchar(256),  column_name = varchar(256)
 
[,increment = integer,
 ,start_value = integer])
integer
Given a database table and an integer table column, returns a positive integer that is the new sequence value for the column
Defined
SetAttribute
(
attributename = value
{,attributename = value})
integer
Sets any number of attributes for the object
Object
SetAutoCommit
(state=
integer)
integer
Sets the autocommit status of the database session
Defined
WriteDBComponent
(component
= compsource)
integer
Writes a component to an OpenROAD database
Defined