DataTable
DataColumnCount | Number of data columns |
ID | Unique identifier (primary key) of the object |
LocalDataCacheFlag | Whether to store locally bitstrings for categorized attributes based on this matrix |
Name | Unique name of this object. Cannot be empty. |
Note | Text comment to this object (up to 255 characters) |
RecordCount | Number of data rows |
RowCount | Number of data rows (an alias for RecordCount) |
canDel () | Returns true if the object could be deleted (is not used) |
clearLocalDataCache () | Clears local data cache for attributes based on columns of this database table |
findDataColumn () | Tries to look-up a DataColumn with a unique property given as parameter. Just one parameter has to be specified. Returns nil if DataColumn with this property doesn't exists. |
getDataColumnCount () | Returns number of data columns in the table, the value of DataColumnCount property |
getDataTableSubTypeCode () | Returns code of sub-type of this database table, see DataTableSubType codes |
getDataTableSubTypeKey () | Returns unique string key of sub-type of this database table |
getDataTableSubTypeName () | Returns string representation of sub-type of this database table |
getID () | Returns unique identifier (primary key) of the object |
getName () | Returns the value of Name property, name of this object |
getNote () | Returns the value of Note property |
getRecordCount () | Returns number of rows in the table, the value of RecordCount property |
getRowCount () | Returns number of rows in the table, the value of RecordCount property |
checkPrimaryKey () | Checks the primary key and returns true if it is properly set and truelly unique |
init () | Initializes the table (computes number of rows and columns-statistics). If an error occurs, the script execution is stopped. |
isInitialized () | Returns true when the table is properly initialized and categorized attributes could be created based on it |
isLocalDataCacheFlag () | Returns the value of LocalDataCacheFlag property |
isPrimaryKeyDefined () | Returns true whe the primary keys is defined |
isReady () | Returns true when table is physically present in the analyzed database |
markPrimaryKey () | Marks a column to serve as the primary key for this table |
onAdd () | Store the newly created object into metabase |
onDel () | Delete the object from metabase (fails if canDel returns false) |
onUpdate () | Save changes made to the object into metabase |
prepareDataColumnArray () | Returns array of DataColumns (columns in this table) |
setLocalDataCacheFlag () | Sets the value of LocalDataCacheFlag property |
setName () | Sets the value of Name property, name of this object (must be unique) |
setNote () | Sets the value of Note property |
unpackMultiColumnFields () | Unpacks contents of all multi-columns into derived DataColumn based on meta-data information from import. For datasets with more than 255 columns. |
DataColumnCount
(read-only) : integerID
(read-only) : integerLocalDataCacheFlag
: booleanName
: stringNote
: stringRecordCount
(read-only) : integerRowCount
(read-only) : integercanDel() : boolean
boolean
clearLocalDataCache()
findDataColumn() : DataColumn
nil
if DataColumn with this property doesn't exists.
luaTable
- to store named parameters
nID
: integer
- an ID of the table column to look-up
name
: string
- a name of the table column to look-up
DataColumn
- or nil
getDataColumnCount() : integer
integer
getDataTableSubTypeCode() : integer
integer
getDataTableSubTypeKey() : string
string
getDataTableSubTypeName() : string
string
getID() : integer
integer
getName() : string
string
getNote() : string
string
getRecordCount() : integer
integer
getRowCount() : integer
integer
checkPrimaryKey() : boolean
boolean
init()
isInitialized() : boolean
boolean
isLocalDataCacheFlag() : boolean
boolean
isPrimaryKeyDefined() : boolean
boolean
isReady() : boolean
boolean
markPrimaryKey()
luaTable
- to store named parameters
pDataColumn
: DataColumn
- table column to set-up as the primary key
columnName
: string
- a name of the table column to set-up as the primary key
onAdd()
onDel()
onUpdate()
prepareDataColumnArray() : luaTable
luaTable
setLocalDataCacheFlag( boolean )
boolean
setName( string )
string
- cannot be emptysetNote( string )
string
unpackMultiColumnFields()
luaTable
- to store named parameters
pathNameSrc
: string
- path to source file
cColumnSeparator
: char
- column delimiter character
pathNameSrcMetadata
: string
- path to meta-data description file (first line= alternative columns names, second line= forced data types, third line= disabled columns (any of 'no', 'disabled', 'skip' will cause a column to be ommited from import)