LISp-Miner Control Language Reference, version: 27.15.01 of 27 Oct 2017

Namespace lm.metabase

LM Metabase related functions

Classes List

No class defined.

Properties List

No preperties defined.

Functions List

associateWithDataMDB () Associaties an existing metabase (in a MDB file) with analyzed data (also in a MDB file). Not supported in 64-bit version.
associateWithDataODBC () Associaties an existing metabase (available through an ODBC DSN) with analyzed data (also available through an ODBC DSN)
backupMDB () Makes a backup copy of the metabase MDB file. Not supported in 64-bit version.
clearLocalDataCache () Completely clears local data cache for this metabase
close () Closes metabase
createAndAssociateWithDataMDB () Creates a new metabase (as a MDB file) and associates it with analyzed data (also in a MDB file). Not supported in 64-bit version.
exportXML () Exports preprocessing, task definitions and/or results to a XML/PMML file using a given template
getDSN () Returns ODBC Data Source Name of the currently opened metabase
importXML () Imports preprocessing and/or task definitions from a XML/PMML files
isOpen () Returns true if a metabase was already opened using the lm.metabase.open
markChanged () Sets metabase 'changed' flag informing other modules they should reload metabase upon activation.
open () Opens a metabase using the given ODBC Data Source Name
reload () Reloads the whole metabase
reloadResults () Partially reloads the metabase with results to preserve other objects (tasks, prepro) already used in the Lua script
restoreMDB () Replaces the metabase MDB with a backup copy. Not supported in 64-bit version.
setAutoSaveFlag () Sets auto-save flag for metabase-stored object. If true (default) the onAdd and onUpdate functions are called automatically after a object has been constructed or a change has been made to it. Returns the previous value of the flag.
updateMetadata () Updates metadata information (needs to be called after a change has been made to analyzed data)
updateMostRecentlyUsedList () Adds currently opened metabase into the most recently used list of DSN that is provided upon launch of any LM module. Reorders the list if neccessary.

Properties

Functions

associateWithDataMDB()
Associaties an existing metabase (in a MDB file) with analyzed data (also in a MDB file). Not supported in 64-bit version.

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pathNameMetabase : string - path to an existing metabase MDB file
  • pathNameData : string - path to an existing analyzed data MDB file
  • dsnBase : string - Base middle-part of the ODBC Data Source Name (a prefix 'LM' will be added for both data and metabase and the suffix 'MB' for metabase)
associateWithDataODBC()
Associaties an existing metabase (available through an ODBC DSN) with analyzed data (also available through an ODBC DSN)

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • dsnMetabase : string - ODBC Data Source Name to an existing metabase
  • dsnData : string - ODBC Data Source Name to an existing analyzed data
backupMDB()
Makes a backup copy of the metabase MDB file. Not supported in 64-bit version.

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pathNameSrc : string - path to the MDB metabase file to be archived
  • pathNameDest : string - destination path to make backup
clearLocalDataCache()
Completely clears local data cache for this metabase
close()
Closes metabase
createAndAssociateWithDataMDB()
Creates a new metabase (as a MDB file) and associates it with analyzed data (also in a MDB file). Not supported in 64-bit version.

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pathNameMetabase : string - path to metabase MDB file to be created
  • pathNameData : string - path to an existing analyzed data MDB file
  • dsn : string - Middle-part of the ODBC Data Source Name (a prefix 'LM' will be added for both data and metabase and the suffix 'MB' for metabase)
exportXML()
Exports preprocessing, task definitions and/or results to a XML/PMML file using a given template

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pathNameTemplate : string - path to a template file
  • pathNameDest : string - destination file

Optional named parameters

  • pathNameAlias : string - path to the file with tags translation table
getDSN() : string
Returns ODBC Data Source Name of the currently opened metabase

Returns

  • string
importXML()
Imports preprocessing and/or task definitions from a XML/PMML files

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pathNameSrc : string - path to source XML file

Optional named parameters

  • pathNameAlias : string - path to the file with tags translation table
  • bCheckPrimaryKeyUnique : boolean - if the primary key column should be checked for duplicities
isOpen() : boolean
Returns true if a metabase was already opened using the lm.metabase.open

Returns

  • boolean
markChanged()
Sets metabase 'changed' flag informing other modules they should reload metabase upon activation.
open()
Opens a metabase using the given ODBC Data Source Name

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • dataSourceName : string - ODBC Data Source Name for metabase to open
reload()
Reloads the whole metabase
reloadResults()
Partially reloads the metabase with results to preserve other objects (tasks, prepro) already used in the Lua script
restoreMDB()
Replaces the metabase MDB with a backup copy. Not supported in 64-bit version.

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pathNameSrc : string - path to the MDB metabase backup file
  • pathNameDest : string - destination path to make restore
setAutoSaveFlag( boolean )
Sets auto-save flag for metabase-stored object. If true (default) the onAdd and onUpdate functions are called automatically after a object has been constructed or a change has been made to it. Returns the previous value of the flag.

Parameters

  • boolean
updateMetadata()
Updates metadata information (needs to be called after a change has been made to analyzed data)
updateMostRecentlyUsedList()
Adds currently opened metabase into the most recently used list of DSN that is provided upon launch of any LM module. Reorders the list if neccessary.