Java Client API 1.4 (November 2023)
 
Loading...
Searching...
No Matches
com.dbSpaces.jdb.Environment Class Reference

Inherits com.dbSpaces.jdb.Base.

Public Member Functions

 Environment ()
 
Connection createConnection () throws DatabaseException
 
String getProgramName ()
 
boolean isExceptionsEnabled ()
 
void setProgramName (String name)
 

Detailed Description

The Environment object holds environment information for the database client The Environment object is the main object in the client database API and is used to create a Connection object that allows you to connect to the database server.

A DatabaseException will be thrown if a database error occurs and exceptions are enabled. If exceptions are not enabled the following error methods can be used to get information about the error;

  • GetErrorStatus()
  • GetErrorCode()
  • GetErrorMessage()
Since
Version 1.0

Constructor & Destructor Documentation

◆ Environment()

com.dbSpaces.jdb.Environment.Environment ( )

Default constructor.

Since
Version 1.0

Member Function Documentation

◆ createConnection()

Connection com.dbSpaces.jdb.Environment.createConnection ( ) throws DatabaseException

Create a new Connection object.

Returns
The new Connection object.
Since
Version 1.0
Here is the caller graph for this function:

◆ getProgramName()

String com.dbSpaces.jdb.Environment.getProgramName ( )

Get the program name.

Returns
The Program name.
Since
Version 1.0

◆ isExceptionsEnabled()

boolean com.dbSpaces.jdb.Environment.isExceptionsEnabled ( )

Check if exceptions are enabled.

Returns
TRUE if exceptions are enabled; FALSE if otherwise.
Since
Version 1.0

◆ setProgramName()

void com.dbSpaces.jdb.Environment.setProgramName ( String  name)

Set the program name to identify the connection by in the server.

Parameters
nameThe program name.
Since
Version 1.0