Service |
Description |
CalculateColumn |
Usage:
Database_Ser=
vices('CalculateColumn') Comments: Called =
directly from within a calculation column. The name of the table and column=
is derived from the call stack and the associated table commuter, if it ex=
ists, is called with the appropriate arguments. Returns:
The result of the calculated column. |
ClearTableHandle |
Usage:
Databa=
se_Services('ClearTableHandle', TableName) Comments: Clears the table handle array array from cac=
he. This will force the GetTableHandle service to call the Open st=
atement again. Returns:
N/A |
DeleteDataRow |
Usage:
Databa=
se_Services('DeleteDataRow', TableName, KeyID, IgnoreSelfLock, Ignor=
eMFSRoutines) Comments: Deletes a data row=
for the indicated Key ID and database table. Returns:
N/A |
GetKeyIDLock |
Usage:
Database_Ser=
vices('GetKeyIDLock', TableName, KeyID, IgnoreSelfLock) Comments: Attempts to perform a semaphore lock on the indicat=
ed tablename and Key ID. Returns:
A Boolean flag indicating if the lock request was successfully performed.<=
/p> |
GetTableCommuter |
Usage:
Database_Ser=
vices('GetTableCommuter', TableName) Comments: Returns the name of the indicated table's commuter module if it exists=
. If it does not exist then an empty string will be returned. Returns:
See comments. |
GetTableHandle |
Usage:
Databa=
se_Services('GetTableHandle', TableName) <=
strong>Comments: Returns an @FM list of currently attached Open=
Insight database tables.
Returns:
The handle array created by the Open statement. |
GetTableNames |
Usage:
Databa=
se_Services('GetTableNames', ApplicationTablesOnly, ExcludeDic=
tionaries, ExcludeIndexes) Comments: Returns an array of information related to the database table being passe=
d in. Returns:
See comments. |
GetTableProperties
|
Usage:
Databa=
se_Services('GetTableProperties', TableName) Co=
mments: Returns an array of information related to the database=
table being passed in. Returns:
An @FM delimited array of table information:
Attribute |
Description |
<=
1> |
Database ID |
<=
2> |
MFS/BFS list |
<=
3> |
Volume Label (if available) |
<=
4> |
Volume Path (if available) |
<=
5> |
BFS (if available) |
|
GetUserLocks |
Usage:
Database_Ser=
vices('GetUserLocks') Comments: Note, this=
can only be done with the UD 5. This can also cause instability with the c=
urrent session and may require the Task Manager to close the session. Returns: Returns a dynamic array of user lock in=
formation. |
IsKeyIDLocked |
Usage:
Database_Ser=
vices('IsKeyIDLocked', TableName, KeyID, IgnoreSelfLock) Comments: Returns a Boolean flag of the lock status for the =
indicated table and Key ID. Returns:
See comments. |
IsKeyIDSelfLocked |
Usage:
Database_Ser=
vices('IsKeyIDSelfLocked', TableName, KeyID) Comments:=
Returns a Boolean flag of the self-lock status for the indicat=
ed table and Key ID. Returns:
See comments |
ReadDataRow |
Usage:
Databa=
se_Services('ReadDataRow', KeyID, NotExpired, ExpirationDuration, Ig=
noreMFSRoutines) Comments: Reads a data ro=
w for the indicated Key ID and database table. Returns: =
strong>The requested data row. |
ReleaseKeyIDLock |
Usage:
Database_Ser=
vices('ReleaseKeyIDLock', TableName, KeyID) Comments:<=
br>Attempts to release a semaphore lock on the indicated tablename=
and Key ID. Returns: A Boolean flag indica=
ting if the lock release was successfully performed. |
SearchIndex |
Usage:
Database_Ser=
vices('SearchIndex', TableName, ColumnName, SearchValue, UpdateIndex) Comments: Returns an @FM delimited list of Key =
IDs that match the search value. Returns:
See comments |
SetTableAlias |
Usage:
Database_Ser=
vices('SetTableAlias', TableName, AliasName, Volume, DatabaseID) =
Comments: Attempts to create an alias for the indica=
ted table, volume, and database. It returns a True$ if successful or a Fals=
e$ if unsuccessful. Returns: A Boolean flag=
indicating if the alias request was successfully performed. |
UnlockKeyID |
Usage:
Database_Ser=
vices('UnlockKeyID', TableName, KeyID) Co=
mments: Attempts to unlock the indicated Key ID from the indica=
ted Table Name. Note, this can only be done with the UD 5. Re=
turns: A Boolean flag indicating if the unlock request wa=
s successfully performed. |
VerifyLH
|
Usage:
Databa=
se_Services('VerifyLH', Tablenames, SaveList) Comments: Performs a health check against the indic=
ated tables and returns back any issues. Note: This uses the Verify_LH subroutine to check=
for GFEs. All results are stored in the SYSLHVERIFY table with a KeyID of =
VolumeLabel*DatabaseID*TableName. Returns the li=
st of groups that have GFEs or returns an empty string if there are none. T=
he list of GFEs or empty strings will themselves be @FM delimited to corres=
pond with the tables passed into this service. Returns:
An @FM delimited array of table names and associated GFE information. <=
/td>
|
VerifyLHAll
|
Usage:
Database_Ser=
vices('VerifyLHAll') Comments: Performs a =
health check against all attached tables and returns back any issues. Returns: Returns two lists which are delimited b=
y an @RM. The first list is an @FM list of attached tables. The second list=
is an @FM list of results (groups that have GFEs or an empty string if the=
re are none). Items in each list correspond which each other based on their=
list position. |
WriteDataRow |
Usage:
Databa=
se_Services('WriteDataRow', TableName, KeyID, DataRow, IgnoreSelfLoc=
k, IgnoreMFSRoutines, IgnoreAllLocks) Comments: Writes a data row for the indicated Key ID and database table. =
Returns:
N/A |