public class CTDatabase extends CTBase
Constructor and Description |
---|
CTDatabase(CTSession Handle)
Constructor for a given Session handle.
|
Modifier and Type | Method and Description |
---|---|
void |
AddTable(java.lang.String Name,
java.lang.String Path)
Adds an existing table to the current database.
|
void |
AddTableXtd(java.lang.String Name,
java.lang.String PhysicName,
java.lang.String Path)
Adds an existing table to the current database.
|
void |
CloseAll()
Closes all active tables for the current database.
|
void |
Connect(java.lang.String Name)
Connects to a database.
|
void |
Create(java.lang.String Name,
java.lang.String Path)
Creates a new database.
|
void |
DeleteTable(java.lang.String Name,
java.lang.String Password)
Drops a table from a database and deletes the table data and index files
from disk.
|
void |
Disconnect()
Disconnects a database.
|
void |
DropTable(java.lang.String Name)
Drops a table from a database, but does not delete the table data and index
files from disk.
|
void |
finalize()
Destroys an allocated CTDatabase object.
|
CTTable |
FindActiveTable(java.lang.String TableName)
Finds an active table by name in the current database.
|
boolean |
FindTable(int uid,
java.lang.StringBuffer Name,
java.lang.StringBuffer Path)
Locates a table in a database by name.
|
boolean |
FindTable(java.lang.String Name,
java.lang.StringBuffer Path)
Locates a table in a database by name.
|
boolean |
FirstTable(java.lang.StringBuffer Name,
java.lang.StringBuffer Path)
Locates the first table in a database.
|
java.lang.String |
GetDefaultSqlTableOwner()
Retrieves the current default SQL table owner.
|
java.lang.String |
GetName()
Retrieves the database name.
|
java.lang.String |
GetPath()
Retrieves the database path.
|
int |
GetTableCount()
Retrieves the number of tables in the database dictionary.
|
int |
GetTableUID(java.lang.String Name)
Retrieves the table UID.
|
boolean |
IsActive()
Checks whether the database is connected or disconnected.
|
boolean |
IsExclusive()
Retrieves the current database exclusive flag value.
|
boolean |
IsSQL()
Checks if the database is SQL (i.e., checks if the database contains the SQL
system tables).
|
boolean |
NextTable(java.lang.StringBuffer Name,
java.lang.StringBuffer Path)
Locates the next table in a database.
|
void |
RenameTable(java.lang.String OldName,
java.lang.String NewName)
Assigns a new name to an existing table.
|
void |
SetDefaultSqlTableOwner(java.lang.String Owner)
Sets the default SQL table owner name.
|
void |
SetExclusive(boolean Flag)
Sets or clears the database exclusive flag.
|
Abort, Begin, ClearSavePoint, Commit, GetAutoCommit, GetHandle, GetKeepLock, GetLockMode, GetOperation, GetTransactionMode, IsLockActive, IsTransActive, IsUnicodeLib, Lock, PrepareCommit, RestoreSavePoint, SetAutoCommit, SetHandle, SetKeepLock, SetOperation, SetSavePoint, SetTransactionMode, Unlock
public CTDatabase(CTSession Handle) throws CTException
Handle
- CTSession
object.CTException
- in case of errorfinalize()
public void finalize()
finalize
in class java.lang.Object
CTDatabase(FairCom.CtreeDb.CTSession)
public void Connect(java.lang.String Name) throws CTException
Name
- Database name to be connected.CTException
- in case of errorDisconnect()
public void Disconnect() throws CTException
CTException
- in case of errorCTException
- in case of errorConnect(java.lang.String)
public void Create(java.lang.String Name, java.lang.String Path) throws CTException
Name
- Name to assign to the database.Path
- Path where the database will be created.CTException
- in case of errorConnect(java.lang.String)
public boolean FirstTable(java.lang.StringBuffer Name, java.lang.StringBuffer Path) throws CTException
Name
- Table name (Output)Path
- Table path (Output)CTException
- in case of errorNextTable(java.lang.StringBuffer, java.lang.StringBuffer)
,
FindTable(java.lang.String, java.lang.StringBuffer)
public boolean NextTable(java.lang.StringBuffer Name, java.lang.StringBuffer Path) throws CTException
Name
- Table name (Output).Path
- Table path (Output).CTException
- in case of errorFirstTable(java.lang.StringBuffer, java.lang.StringBuffer)
,
FindTable(java.lang.String, java.lang.StringBuffer)
public boolean FindTable(java.lang.String Name, java.lang.StringBuffer Path) throws CTException
Name
- Table name to be found.Path
- Table path (Output).CTException
- in case of errorFirstTable(java.lang.StringBuffer, java.lang.StringBuffer)
,
NextTable(java.lang.StringBuffer, java.lang.StringBuffer)
,
FindActiveTable(java.lang.String)
public boolean FindTable(int uid, java.lang.StringBuffer Name, java.lang.StringBuffer Path) throws CTException
uid
- Table ID to be found. This is an internal unique table identification.Name
- Table name (Output)Path
- Table path (Output)CTException
- in case of errorFirstTable(java.lang.StringBuffer, java.lang.StringBuffer)
,
NextTable(java.lang.StringBuffer, java.lang.StringBuffer)
,
FindActiveTable(java.lang.String)
public void AddTable(java.lang.String Name, java.lang.String Path) throws CTException
Name
- Table name.Path
- Table path.CTException
- in case of errorAddTableXtd(java.lang.String, java.lang.String, java.lang.String)
,
DeleteTable(java.lang.String, java.lang.String)
,
DropTable(java.lang.String)
,
RenameTable(java.lang.String, java.lang.String)
public void AddTableXtd(java.lang.String Name, java.lang.String PhysicName, java.lang.String Path) throws CTException
Name
- Table name used inside the database.PhysicName
- Physical table file name.Path
- Table path.CTException
- in case of errorAddTable(java.lang.String, java.lang.String)
,
DeleteTable(java.lang.String, java.lang.String)
,
DropTable(java.lang.String)
,
RenameTable(java.lang.String, java.lang.String)
public void DeleteTable(java.lang.String Name, java.lang.String Password) throws CTException
Name
- Table name to be deleted.Password
- Optional table password.CTException
- in case of errorAddTable(java.lang.String, java.lang.String)
,
AddTableXtd(java.lang.String, java.lang.String, java.lang.String)
,
DropTable(java.lang.String)
,
RenameTable(java.lang.String, java.lang.String)
public void DropTable(java.lang.String Name) throws CTException
Name
- Table name to be droped.CTException
- in case of errorAddTable(java.lang.String, java.lang.String)
,
AddTableXtd(java.lang.String, java.lang.String, java.lang.String)
,
DeleteTable(java.lang.String, java.lang.String)
,
RenameTable(java.lang.String, java.lang.String)
public int GetTableUID(java.lang.String Name) throws CTException
Name
- Table name.CTException
- in case of errorGetName()
,
GetPath()
public boolean IsActive()
Connect(java.lang.String)
,
Disconnect()
public java.lang.String GetPath()
GetName()
,
IsActive()
public java.lang.String GetName()
GetPath()
,
IsActive()
public void CloseAll() throws CTException
CTException
- in case of errorGetTableUID(java.lang.String)
public int GetTableCount()
FirstTable(java.lang.StringBuffer, java.lang.StringBuffer)
,
NextTable(java.lang.StringBuffer, java.lang.StringBuffer)
,
AddTable(java.lang.String, java.lang.String)
,
DeleteTable(java.lang.String, java.lang.String)
,
DropTable(java.lang.String)
public java.lang.String GetDefaultSqlTableOwner()
SetDefaultSqlTableOwner(java.lang.String)
,
IsSQL()
public void SetDefaultSqlTableOwner(java.lang.String Owner) throws CTException
Owner
- New default SQL table owner name.CTException
- in case of errorGetDefaultSqlTableOwner()
,
IsSQL()
public boolean IsSQL()
GetDefaultSqlTableOwner()
,
SetDefaultSqlTableOwner(java.lang.String)
public void SetExclusive(boolean Flag) throws CTException
Flag
- True will set the exclusive flag, while false will clear the exclusive flag.CTException
- in case of errorIsExclusive()
,
Connect(java.lang.String)
public boolean IsExclusive()
IsExclusive()
,
SetExclusive(boolean)
public void RenameTable(java.lang.String OldName, java.lang.String NewName) throws CTException
OldName
- Current table name.NewName
- New table name to be set.CTException
- in case of errorGetName()
,
AddTable(java.lang.String, java.lang.String)
,
AddTableXtd(java.lang.String, java.lang.String, java.lang.String)
,
DeleteTable(java.lang.String, java.lang.String)
,
DropTable(java.lang.String)
public CTTable FindActiveTable(java.lang.String TableName) throws CTException
TableName
- Table name to be found.CTTable
object.CTException
- in case of errorFirstTable(java.lang.StringBuffer, java.lang.StringBuffer)
,
NextTable(java.lang.StringBuffer, java.lang.StringBuffer)
,
FindTable(java.lang.String, java.lang.StringBuffer)
,
IsActive()