Hello world!
struct
A0608BEC-0AEB-B46A-0E1E1EC5F3CE7C9C.0.6
object of java.net.URLClassLoader
Class Name java.net.URLClassLoader
Methods
Method Return Type
close() void
findResource(java.lang.String) java.net.URL
findResources(java.lang.String) java.util.Enumeration
getResourceAsStream(java.lang.String) java.io.InputStream
getURLs() java.net.URL[]
newInstance(java.net.URL[], java.lang.ClassLoader) java.net.URLClassLoader
newInstance(java.net.URL[]) java.net.URLClassLoader
Parent Class
object java.security.SecureClassLoader
Class Name java.security.SecureClassLoader
Parent Class
object java.lang.ClassLoader
Class Name java.lang.ClassLoader
Methods
Method Return Type
clearAssertionStatus() void
getParent() java.lang.ClassLoader
getResource(java.lang.String) java.net.URL
getResourceAsStream(java.lang.String) java.io.InputStream
getResources(java.lang.String) java.util.Enumeration
getSystemClassLoader() java.lang.ClassLoader
getSystemResource(java.lang.String) java.net.URL
getSystemResourceAsStream(java.lang.String) java.io.InputStream
getSystemResources(java.lang.String) java.util.Enumeration
loadClass(java.lang.String) java.lang.Class
setClassAssertionStatus(java.lang.String, boolean) void
setDefaultAssertionStatus(boolean) void
setPackageAssertionStatus(java.lang.String, boolean) void
CONFIGURATION
component common.model.configuration.configurationService
        extends common.model.baseService
SERVER
component common.model.configuration.serverGateway
        extends common.model.baseGateway
DAO
component common.model.datamgr.DataMgr_MSSQL
        extends common.model.datamgr.DataMgr
METHODS
ADDCOLUMN
function addColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 50
Default Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I add a column to the given table (deprecated in favor of setColumn).
Description:  
ADDENGINEENHANCEMENTS
function addEngineEnhancements
Arguments:none
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ADDTABLE
function addTable
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required array  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I add a table to the Data Manager.
Description:  
ADJUSTCOLUMNARGS
function adjustColumnArgs
Arguments:
Name Required Type Default
args Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
CHECKLENGTH
function checkLength
Arguments:
Name Required Type Default
field Required struct  
data Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check the length of incoming data to see if it can fit in the designated field (making for a more developer-friendly error messages).
Description:  
CHECKTABLE
function checkTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table exists in the Datamgr.
Description:  
CHECKTABLEPK
function checkTablePK
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table has a primary key.
Description:  
CLEAN
function clean
Arguments:
Name Required Type Default
Struct Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a clean version (stripped of MS-Word characters) of the given structure.
Description:  
CLEANSQLARRAY
function cleanSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I take a potentially nested SQL array and return a flat SQL array.
Description:  
CONCAT
function concat
Arguments:
Name Required Type Default
fields Required string  
delimeter Optional string [empty string]
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL to concatenate the given fields with the given delimeter.
Description:  
CONCATFIELDS
function concatFields
Arguments:
Name Required Type Default
tablename Required string  
fields Required string  
delimeter Optional string ,
tablealias Optional string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL to concatenate the given fields with the given delimeter.
Description:  
CREATETABLE
function createTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I take a table (for which the structure has been loaded) and create the table in the database.
Description:  
CREATETABLES
function CreateTables
Arguments:
Name Required Type Default
tables Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I create any tables that I know should exist in the database but don't.
Description:  
DELETERECORD
function deleteRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the record with the given Primary Key(s).
Description:  
DELETERECORDS
function deleteRecords
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the records with the given data.
Description:  
DMDUPLICATE
function DMDuplicate
Arguments:
Name Required Type Default
var Required any  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
DMPRESERVESINGLEQUOTES
function DMPreserveSingleQuotes
Arguments:
Name Required Type Default
sql Required any  
ReturnType: string
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
ESCAPE
function escape
Arguments:
Name Required Type Default
name Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an escaped value for a table or field.
Description:  
EXPANDRELATIONSTRUCT
function expandRelationStruct
Arguments:
Name Required Type Default
Relation Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
FILLOUTJOINTABLERELATIONS
function fillOutJoinTableRelations
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETBOOLEANSQLVALUE
function getBooleanSqlValue
Arguments:
Name Required Type Default
value Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETCFDATATYPE
function getCFDataType
Arguments:
Name Required Type Default
type Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the cfqueryparam datatype from the database datatype.
Description:  
GETCONNECTION
function getConnection
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Returns a java.sql.Connection (taken from Transfer with permission).
Description:  
GETCREATESQL
function getCreateSQL
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL to create the given table.
Description:  
GETDATABASE
function getDatabase
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the database platform being used (Access,MS SQL,MySQL etc).
Description:  
GETDATABASEDRIVER
function getDatabaseDriver
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASEPROPERTIES
function getDatabaseProperties
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return some properties about this database
Description:  
GETDATABASESHORTSTRING
function getDatabaseShortString
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASETABLES
function getDatabaseTables
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a list of all tables in the current database.
Description:  
GETDATABASEXML
function getDatabaseXml
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all tables in the database.
Description:  
GETDATASOURCE
function getDatasource
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the datasource used by this Data Manager.
Description:  
GETDBDATATYPE
function getDBDataType
Arguments:
Name Required Type Default
CF_Datatype Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the database datatype from the cfqueryparam datatype.
Description:  
GETDBFIELDLIST
function getDBFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of fields in the database for the given table.
Description:  
GETDBTABLEINDEXES
function getDBTableIndexes
Arguments:
Name Required Type Default
tablename Required string  
indexname Optional string  
ReturnType: query
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETDBTABLESTRUCT
function getDBTableStruct
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the structure of the given table in the database.
Description:  
GETDEFAULTVALUES
function getDefaultValues
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETEFFECTIVEDATATYPE
function getEffectiveDataType
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETFIELD
function getField
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I the field of the given name.
Description:  
GETFIELDLENGTHS
function getFieldLengths
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a structure of the field lengths for fields where this is relevant.
Description:  
GETFIELDLIST
function getFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a list of fields in DataMgr for the given table.
Description:  
GETFIELDS
function getFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of all real fields in the given table in DataMgr.
Description:  
GETFIELDSELECTSQL
function getFieldSelectSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
useFieldAlias Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_HAS
function getFieldSQL_Has
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_MATH
function getFieldSQL_Math
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDWHERESQL
function getFieldWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
value Required string  
tablealias Optional string  
operator Optional string =
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETGENERICTYPE
function getGenericType
Arguments:
Name Required Type Default
CF_Datatype Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETHASFIELDSQL
function getHasFieldSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETINSERTEDIDENTITY
function getInsertedIdentity
Arguments:
Name Required Type Default
tablename Required string  
identfield Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the value of the identity field that was just inserted into the given table.
Description:  
GETINSERTRECORDSSQL
function getInsertRecordsSQL
Arguments:
Name Required Type Default
tablename Required string  
data_set Required struct  
data_where Optional struct  
filters Optional array [runtime expression]
ReturnType: array
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETMAXROWSPREFIX
function getMaxRowsPrefix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL before the field list in the select statement to limit the number of rows.
Description:  
GETMAXROWSSUFFIX
function getMaxRowsSuffix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL after the query to limit the number of rows.
Description:  
GETMAXROWSWHERE
function getMaxRowsWhere
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL in the where statement to limit the number of rows.
Description:  
GETNEWSORTNUM
function getNewSortNum
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
ReturnType: numeric
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the value an increment higher than the highest value in the given field to put a record at the end of the sort order.
Description:  
GETNOWSQL
function getNowSQL
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL for the current date/time.
Description:  
GETPKFIELDS
function getPKFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETPKFROMDATA
function getPKFromData
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the primary key of the record matching the given data.
Description:  
GETPRESEEDRECORDS
function getPreSeedRecords
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: query
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETPRIMARYKEYFIELD
function getPrimaryKeyField
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPRIMARYKEYFIELDNAME
function getPrimaryKeyFieldName
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPROPS
function getProps
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: no
Description:  
GETRECORD
function getRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the primary key value(s) given.
Description:  
GETRECORDS
function getRecords
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the data given.
Description:  
GETRECORDSSQL
function getRecordsSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
function Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL to get a recordset based on the data given.
Description:  
GETRELATIONFIELDS
function getRelationFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETRELATIONTYPES
function getRelationTypes
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETRELATIONVALUES
function getRelationValues
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETSTRINGTYPES
function getStringTypes
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of datypes that hold strings / character values.
Description:  
GETSUPPORTEDDATABASES
function getSupportedDatabases
Arguments:none
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the databases supported by this installation of DataMgr.
Description:  
GETTABLEDATA
function getTableData
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return information about all of the tables currently loaded into this instance of Data Manager.
Description:  
GETTABLEPROPS
function getTableProps
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
GETTYPEOFCFTYPE
function getTypeOfCFType
Arguments:
Name Required Type Default
CF_DataType Required string  
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
GETUPDATEABLEFIELDS
function getUpdateableFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of fields that can be updated.
Description:  
GETVERSION
function getVersion
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETWHERESQL
function getWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETXML
function getXML
Arguments:
Name Required Type Default
tablename Optional string  
indexes Optional boolean false
showroot Optional boolean true
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all loaded tables if none given.
Description:  
HASINDEX
function hasIndex
Arguments:
Name Required Type Default
tablename Required string  
indexname Required string  
ReturnType: boolean
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
INIT
function init
Arguments:
Name Required Type Default
datasource Required string  
database Optional string  
username Optional string  
password Optional string  
SmartCache Optional boolean false
ReturnType: DataMgr
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I instantiate and return this object.
Description:  
INSERTRECORD
function insertRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert a record into the given table with the provided data and do my best to return the primary key of the inserted record.
Description:  
INSERTRECORD2
function insertRecord2
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert a record into the given table with the provided data and do my best to return the primary key of the inserted record.
Description:  
ISBLANKVALUE
function isBlankValue
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I see if the given field is passed in as blank and is a nullable field.
Description:  
ISIDENTITYFIELD
function isIdentityField
Arguments:
Name Required Type Default
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ISLOGGING
function isLogging
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
ISOFTYPE
function isOfType
Arguments:
Name Required Type Default
value Required any  
CF_DataType Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check if the given value is of the given data type.
Description:  
ISSTRINGTYPE
function isStringType
Arguments:
Name Required Type Default
type Optional string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I indicate if the given datatype is valid for string data.
Description:  
ISVALIDDATE
function isValidDate
Arguments:
Name Required Type Default
value Required string  
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
LOADTABLE
function loadTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I load a table from the database into DataMgr.
Description:  
LOADXML
function loadXML
Arguments:
Name Required Type Default
xmldata Required string  
docreate Optional boolean false
addcolumns Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I add tables from XML and optionally create tables/columns as needed (I can also load data to a table upon its creation).
Description:  
LOGACTION
function logAction
Arguments:
Name Required Type Default
tablename Required string  
pkval Optional string  
action Required string  
data Optional struct  
sql Optional any  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I log an action in the database.
Description:  
MAKEDEFAULTVALUE
function makeDefaultValue
Arguments:
Name Required Type Default
value Required string  
CF_DataType Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return the value of the default for the given datatype and raw value.
Description:  
QUERYPARAM
function queryparam
Arguments:
Name Required Type Default
cfsqltype Optional string  
value Required any  
maxLength Optional string  
scale Optional string 0
null Optional boolean no
list Optional boolean no
separator Optional string ,
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
QUERYROWTOSTRUCT
function queryRowToStruct
Arguments:
Name Required Type Default
query Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Makes a row of a query into a structure.
Description:  
READABLESQL
function readableSQL
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return human-readable SQL from a SQL array (not to be sent to the database).
Description:  
READYTABLE
function readyTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
REMOVECOLUMN
function removeColumn
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a column from a table.
Description:  
REMOVETABLE
function removeTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a table.
Description:  
RUNSQL
function runSQL
Arguments:
Name Required Type Default
sql Required string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
RUNSQLARRAY
function runSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given array representing SQL code (structures in the array represent params).
Description:  
SAVERECORD
function saveRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert or update a record in the given table (update if a matching record is found) with the provided data and return the primary key of the updated record.
Description:  
SAVERELATIONLIST
function saveRelationList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save a many-to-many relationship.
Description:  
SAVERELATIONS
function saveRelations
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
pkfield Required struct  
pkval Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SAVESORTORDER
function saveSortOrder
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
sortlist Required string  
PrecedingRecords Optional numeric 0
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save the sort order of records - putting them in the same order as the list of primary key values.
Description:  
SEEDDATA
function seedData
Arguments:
Name Required Type Default
xmldata Required any  
CreatedTables Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEX
function seedIndex
Arguments:
Name Required Type Default
indexname Required string  
tablename Required string  
fields Required string  
unique Optional boolean false
clustered Optional boolean false
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEXES
function seedIndexes
Arguments:
Name Required Type Default
xmldata Required any  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDRECORD
function seedRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
checkFields Optional string [empty string]
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCACHEDATE
function setCacheDate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMN
function setColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 0
Default Optional string  
Special Optional string  
Relation Optional struct  
PrimaryKey Optional boolean  
AllowNulls Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I set a column in the given table
Description:  
SETCOLUMNPRIMARYKEY
function setColumnPrimaryKey
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNRELATION
function setColumnRelation
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Relation Optional struct  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNSPECIAL
function setColumnSpecial
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Special Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SKEY
function skey
Arguments:
Name Required Type Default
name Required string  
val Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
SQLCREATECOLUMN
function sqlCreateColumn
Arguments:
Name Required Type Default
field Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
STARTLOGGING
function startLogging
Arguments:
Name Required Type Default
logtable Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn on logging.
Description:  
STOPLOGGING
function stopLogging
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn off logging.
Description:  
STRUCTFROMARGS
function StructFromArgs
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
STRUCTKEYHASLEN
function StructKeyHasLen
Arguments:
Name Required Type Default
Struct Required struct  
Key Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given key of the given structure exists and has a value with any length.
Description:  
SVAL
function sval
Arguments:
Name Required Type Default
struct Required struct  
val Required any  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
TRUNCATE
function truncate
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the structure with the values truncated to the limit of the fields in the table.
Description:  
UPDATERECORD
function updateRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I update a record in the given table with the provided data and return the primary key of the updated record.
Description:  
UPDATERECORDS
function updateRecords
Arguments:
Name Required Type Default
tablename Required string  
data_set Required struct  
data_where Optional struct  
filters Optional array [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
USEFIELD
function useField
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given field should be used in the SQL statement.
Description:  
DATASOURCE config
METHODS
ADDCOLUMN
function addColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 50
Default Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I add a column to the given table (deprecated in favor of setColumn).
Description:  
ADDENGINEENHANCEMENTS
function addEngineEnhancements
Arguments:none
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ADDTABLE
function addTable
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required array  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I add a table to the Data Manager.
Description:  
ADJUSTCOLUMNARGS
function adjustColumnArgs
Arguments:
Name Required Type Default
args Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
CHECKLENGTH
function checkLength
Arguments:
Name Required Type Default
field Required struct  
data Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check the length of incoming data to see if it can fit in the designated field (making for a more developer-friendly error messages).
Description:  
CHECKTABLE
function checkTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table exists in the Datamgr.
Description:  
CHECKTABLEPK
function checkTablePK
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table has a primary key.
Description:  
CLEAN
function clean
Arguments:
Name Required Type Default
Struct Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a clean version (stripped of MS-Word characters) of the given structure.
Description:  
CLEANSQLARRAY
function cleanSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I take a potentially nested SQL array and return a flat SQL array.
Description:  
CREATETABLE
function createTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I take a table (for which the structure has been loaded) and create the table in the database.
Description:  
CREATETABLES
function CreateTables
Arguments:
Name Required Type Default
tables Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I create any tables that I know should exist in the database but don't.
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
DELETEHOST
function deleteHost
Arguments:
Name Required Type Default
hostID Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
DELETERECORD
function deleteRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the record with the given Primary Key(s).
Description:  
DELETERECORDS
function deleteRecords
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the records with the given data.
Description:  
DMDUPLICATE
function DMDuplicate
Arguments:
Name Required Type Default
var Required any  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
DMPRESERVESINGLEQUOTES
function DMPreserveSingleQuotes
Arguments:
Name Required Type Default
sql Required any  
ReturnType: string
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
ESCAPE
function escape
Arguments:
Name Required Type Default
name Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return an escaped value for a table or field.
Description:  
EXPANDRELATIONSTRUCT
function expandRelationStruct
Arguments:
Name Required Type Default
Relation Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
FILLOUTJOINTABLERELATIONS
function fillOutJoinTableRelations
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GET
function get
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETBOOLEANSQLVALUE
function getBooleanSqlValue
Arguments:
Name Required Type Default
value Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETCONNECTION
function getConnection
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Returns a java.sql.Connection (taken from Transfer with permission).
Description:  
GETDATABASE
function getDataBase
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the database platform being used.
Description:  
GETDATABASEDRIVER
function getDatabaseDriver
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASEPROPERTIES
function getDatabaseProperties
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return some properties about this database
Description:  
GETDATABASESHORTSTRING
function getDatabaseShortString
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASEXML
function getDatabaseXml
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all tables in the database.
Description:  
GETDATASOURCE
function getDatasource
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the datasource used by this Data Manager.
Description:  
GETDBFIELDLIST
function getDBFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of fields in the database for the given table.
Description:  
GETDEFAULTVALUES
function getDefaultValues
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETEFFECTIVEDATATYPE
function getEffectiveDataType
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETFIELD
function getField
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I the field of the given name.
Description:  
GETFIELDLENGTHS
function getFieldLengths
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a structure of the field lengths for fields where this is relevant.
Description:  
GETFIELDLIST
function getFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a list of fields in DataMgr for the given table.
Description:  
GETFIELDS
function getFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of all real fields in the given table in DataMgr.
Description:  
GETFIELDSELECTSQL
function getFieldSelectSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
useFieldAlias Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_HAS
function getFieldSQL_Has
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_MATH
function getFieldSQL_Math
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDWHERESQL
function getFieldWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
value Required string  
tablealias Optional string  
operator Optional string =
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETGENERICTYPE
function getGenericType
Arguments:
Name Required Type Default
CF_Datatype Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETHASFIELDSQL
function getHasFieldSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETHOST
function getHost
Arguments:
Name Required Type Default
applicationName Optional Any  
instance Optional Any  
httpHost Optional Any  
environment Optional Any  
hostID Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETINSERTEDIDENTITY
function getInsertedIdentity
Arguments:
Name Required Type Default
tablename Required string  
identfield Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the value of the identity field that was just inserted into the given table.
Description:  
GETMAXROWSPREFIX
function getMaxRowsPrefix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL before the field list in the select statement to limit the number of rows.
Description:  
GETMAXROWSSUFFIX
function getMaxRowsSuffix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL after the query to limit the number of rows.
Description:  
GETMAXROWSWHERE
function getMaxRowsWhere
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL in the where statement to limit the number of rows.
Description:  
GETNEWSORTNUM
function getNewSortNum
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
ReturnType: numeric
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the value an increment higher than the highest value in the given field to put a record at the end of the sort order.
Description:  
GETPKFIELDS
function getPKFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETPKFROMDATA
function getPKFromData
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the primary key of the record matching the given data.
Description:  
GETPRESEEDRECORDS
function getPreSeedRecords
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: query
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETPRIMARYKEYFIELD
function getPrimaryKeyField
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPRIMARYKEYFIELDNAME
function getPrimaryKeyFieldName
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPROPS
function getProps
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: no
Description:  
GETRECORD
function getRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the primary key value(s) given.
Description:  
GETRECORDS
function getRecords
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the data given.
Description:  
GETRECORDSSQL
function getRecordsSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
function Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL to get a recordset based on the data given.
Description:  
GETRELATIONFIELDS
function getRelationFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETRELATIONTYPES
function getRelationTypes
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETRELATIONVALUES
function getRelationValues
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETSTRINGTYPES
function getStringTypes
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of datypes that hold strings / character values.
Description:  
GETSUPPORTEDDATABASES
function getSupportedDatabases
Arguments:none
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the databases supported by this installation of DataMgr.
Description:  
GETTABLEDATA
function getTableData
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return information about all of the tables currently loaded into this instance of Data Manager.
Description:  
GETTABLEPROPS
function getTableProps
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
GETTYPEOFCFTYPE
function getTypeOfCFType
Arguments:
Name Required Type Default
CF_DataType Required string  
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
GETUPDATEABLEFIELDS
function getUpdateableFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of fields that can be updated.
Description:  
GETVERSION
function getVersion
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETWHERESQL
function getWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETXML
function getXML
Arguments:
Name Required Type Default
tablename Optional string  
indexes Optional boolean false
showroot Optional boolean true
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all loaded tables if none given.
Description:  
HASINDEX
function hasIndex
Arguments:
Name Required Type Default
tablename Required string  
indexname Required string  
ReturnType: boolean
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
INIT
function init
Arguments:
Name Required Type Default
datasource Required Any  
xmlDefinition Optional string [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INSERTRECORD
function insertRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert a record into the given table with the provided data and do my best to return the primary key of the inserted record.
Description:  
ISBLANKVALUE
function isBlankValue
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I see if the given field is passed in as blank and is a nullable field.
Description:  
ISIDENTITYFIELD
function isIdentityField
Arguments:
Name Required Type Default
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ISLOGGING
function isLogging
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
ISOFTYPE
function isOfType
Arguments:
Name Required Type Default
value Required any  
CF_DataType Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check if the given value is of the given data type.
Description:  
ISVALIDDATE
function isValidDate
Arguments:
Name Required Type Default
value Required string  
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
LOADTABLE
function loadTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I load a table from the database into DataMgr.
Description:  
LOADXML
function loadXML
Arguments:
Name Required Type Default
xmldata Required string  
docreate Optional boolean false
addcolumns Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I add tables from XML and optionally create tables/columns as needed (I can also load data to a table upon its creation).
Description:  
LOGACTION
function logAction
Arguments:
Name Required Type Default
tablename Required string  
pkval Optional string  
action Required string  
data Optional struct  
sql Optional any  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I log an action in the database.
Description:  
MAKEDEFAULTVALUE
function makeDefaultValue
Arguments:
Name Required Type Default
value Required string  
CF_DataType Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return the value of the default for the given datatype and raw value.
Description:  
QUERYPARAM
function queryparam
Arguments:
Name Required Type Default
cfsqltype Optional string  
value Required any  
maxLength Optional string  
scale Optional string 0
null Optional boolean no
list Optional boolean no
separator Optional string ,
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
QUERYROWTOSTRUCT
function queryRowToStruct
Arguments:
Name Required Type Default
query Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Makes a row of a query into a structure.
Description:  
READABLESQL
function readableSQL
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return human-readable SQL from a SQL array (not to be sent to the database).
Description:  
READYTABLE
function readyTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
REMOVECOLUMN
function removeColumn
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a column from a table.
Description:  
REMOVETABLE
function removeTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a table.
Description:  
RUNSQL
function runSQL
Arguments:
Name Required Type Default
sql Required string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
RUNSQLARRAY
function runSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given array representing SQL code (structures in the array represent params).
Description:  
SAVE
function save
Arguments:
Name Required Type Default
datastruct Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVEHOST
function saveHost
Arguments:
Name Required Type Default
datastruct Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVERECORD
function saveRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert or update a record in the given table (update if a matching record is found) with the provided data and return the primary key of the updated record.
Description:  
SAVERELATIONLIST
function saveRelationList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save a many-to-many relationship.
Description:  
SAVERELATIONS
function saveRelations
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
pkfield Required struct  
pkval Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SAVESORTORDER
function saveSortOrder
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
sortlist Required string  
PrecedingRecords Optional numeric 0
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save the sort order of records - putting them in the same order as the list of primary key values.
Description:  
SEEDDATA
function seedData
Arguments:
Name Required Type Default
xmldata Required any  
CreatedTables Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEX
function seedIndex
Arguments:
Name Required Type Default
indexname Required string  
tablename Required string  
fields Required string  
unique Optional boolean false
clustered Optional boolean false
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEXES
function seedIndexes
Arguments:
Name Required Type Default
xmldata Required any  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDRECORD
function seedRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
checkFields Optional string [empty string]
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCACHEDATE
function setCacheDate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMN
function setColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 0
Default Optional string  
Special Optional string  
Relation Optional struct  
PrimaryKey Optional boolean  
AllowNulls Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I set a column in the given table
Description:  
SETCOLUMNPRIMARYKEY
function setColumnPrimaryKey
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNRELATION
function setColumnRelation
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Relation Optional struct  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNSPECIAL
function setColumnSpecial
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Special Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SKEY
function skey
Arguments:
Name Required Type Default
name Required string  
val Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
STARTLOGGING
function startLogging
Arguments:
Name Required Type Default
logtable Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn on logging.
Description:  
STOPLOGGING
function stopLogging
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn off logging.
Description:  
STRUCTFROMARGS
function StructFromArgs
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
STRUCTKEYHASLEN
function StructKeyHasLen
Arguments:
Name Required Type Default
Struct Required struct  
Key Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given key of the given structure exists and has a value with any length.
Description:  
SVAL
function sval
Arguments:
Name Required Type Default
struct Required struct  
val Required any  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
TRUNCATE
function truncate
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the structure with the values truncated to the limit of the fields in the table.
Description:  
UPDATERECORD
function updateRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I update a record in the given table with the provided data and return the primary key of the updated record.
Description:  
UPDATERECORDS
function updateRecords
Arguments:
Name Required Type Default
tablename Required string  
data_set Required struct  
data_where Optional struct  
filters Optional array [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
USEFIELD
function useField
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given field should be used in the SQL statement.
Description:  
FILETRANSFER
component common.model.fileTransfer
FTPCONNECTION eform_53502504
METHODS
ADDCOLUMN
function addColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 50
Default Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I add a column to the given table (deprecated in favor of setColumn).
Description:  
ADDENGINEENHANCEMENTS
function addEngineEnhancements
Arguments:none
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ADDTABLE
function addTable
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required array  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I add a table to the Data Manager.
Description:  
ADJUSTCOLUMNARGS
function adjustColumnArgs
Arguments:
Name Required Type Default
args Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
CHECKFILENAME
function checkFileName
Arguments:
Name Required Type Default
fileName Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CHECKLENGTH
function checkLength
Arguments:
Name Required Type Default
field Required struct  
data Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check the length of incoming data to see if it can fit in the designated field (making for a more developer-friendly error messages).
Description:  
CHECKTABLE
function checkTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table exists in the Datamgr.
Description:  
CHECKTABLEPK
function checkTablePK
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table has a primary key.
Description:  
CLEAN
function clean
Arguments:
Name Required Type Default
Struct Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a clean version (stripped of MS-Word characters) of the given structure.
Description:  
CLEANSQLARRAY
function cleanSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I take a potentially nested SQL array and return a flat SQL array.
Description:  
CLOSEFTP
function closeFTP
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
COPYFTP
function copyFTP
Arguments:
Name Required Type Default
tempPath Optional Any  
sourcePath Optional Any  
destPath Optional Any  
sourceFileName Optional Any  
destFileName Optional Any  
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
COPYLOCAL
function copyLocal
Arguments:
Name Required Type Default
source Optional Any  
destination Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CREATEFILE
function createFile
Arguments:
Name Required Type Default
filePath Optional Any  
formData Optional Any  
revision Optional Any 1
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CREATELOCALDIRECTORYIFNOTEXISTS
function createLocalDirectoryIfNotExists
Arguments:
Name Required Type Default
LocalPath Optional Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CREATEREMOTEDIRECTORYIFNOTEXISTS
function createRemoteDirectoryIfNotExists
Arguments:
Name Required Type Default
filedirectory Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CREATETABLE
function createTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I take a table (for which the structure has been loaded) and create the table in the database.
Description:  
CREATETABLES
function CreateTables
Arguments:
Name Required Type Default
tables Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I create any tables that I know should exist in the database but don't.
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic delete functionality of the abstract gateway. I allow for very simple syntax to perform databse DELETE statements.
Description:  
DELETELOCAL
function deleteLocal
Arguments:
Name Required Type Default
LocalPath Optional Any  
FileName Optional Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
DELETERECORD
function deleteRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the record with the given Primary Key(s).
Description:  
DELETERECORDS
function deleteRecords
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the records with the given data.
Description:  
DELETEREMOTE
function deleteRemote
Arguments:
Name Required Type Default
ftpPath Optional Any  
fileName Optional Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
DIRECTORYLIST
function directoryList
Arguments:
Name Required Type Default
path Optional Any [runtime expression]
filter Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
DMDUPLICATE
function DMDuplicate
Arguments:
Name Required Type Default
var Required any  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
DMPRESERVESINGLEQUOTES
function DMPreserveSingleQuotes
Arguments:
Name Required Type Default
sql Required any  
ReturnType: string
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
DOGETDOCUMENTSOURCE
function doGetDocumentSource
Arguments:
Name Required Type Default
localPath Optional Any  
remotePath Optional Any  
fileName Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ESCAPE
function escape
Arguments:
Name Required Type Default
name Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return an escaped value for a table or field.
Description:  
EXPANDRELATIONSTRUCT
function expandRelationStruct
Arguments:
Name Required Type Default
Relation Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
FILLOUTJOINTABLERELATIONS
function fillOutJoinTableRelations
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GET
function get
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct [runtime expression]
orderBy Optional string [empty string]
limit Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic select functionality of the abstract gateway. I allow for very simple syntax to perform database SELECT statements.
Description:  
GETBOOLEANSQLVALUE
function getBooleanSqlValue
Arguments:
Name Required Type Default
value Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETCONNECTION
function getConnection
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Returns a java.sql.Connection (taken from Transfer with permission).
Description:  
GETDATABASE
function getDataBase
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the database platform being used.
Description:  
GETDATABASEDRIVER
function getDatabaseDriver
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASEPROPERTIES
function getDatabaseProperties
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return some properties about this database
Description:  
GETDATABASESHORTSTRING
function getDatabaseShortString
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASEXML
function getDatabaseXml
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all tables in the database.
Description:  
GETDATASOURCE
function getDatasource
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the datasource used by this Data Manager.
Description:  
GETDBFIELDLIST
function getDBFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of fields in the database for the given table.
Description:  
GETDEFAULTVALUES
function getDefaultValues
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETDOCUMENTSOURCE
function getDocumentSource
Arguments:
Name Required Type Default
localPath Optional Any  
remotePath Optional Any  
fileName Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETEFFECTIVEDATATYPE
function getEffectiveDataType
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETFIELD
function getField
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I the field of the given name.
Description:  
GETFIELDLENGTHS
function getFieldLengths
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a structure of the field lengths for fields where this is relevant.
Description:  
GETFIELDLIST
function getFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a list of fields in DataMgr for the given table.
Description:  
GETFIELDS
function getFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of all real fields in the given table in DataMgr.
Description:  
GETFIELDSELECTSQL
function getFieldSelectSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
useFieldAlias Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_HAS
function getFieldSQL_Has
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_MATH
function getFieldSQL_Math
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDWHERESQL
function getFieldWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
value Required string  
tablealias Optional string  
operator Optional string =
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETGENERICTYPE
function getGenericType
Arguments:
Name Required Type Default
CF_Datatype Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETHASFIELDSQL
function getHasFieldSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETINSERTEDIDENTITY
function getInsertedIdentity
Arguments:
Name Required Type Default
tablename Required string  
identfield Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the value of the identity field that was just inserted into the given table.
Description:  
GETMAXROWSPREFIX
function getMaxRowsPrefix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL before the field list in the select statement to limit the number of rows.
Description:  
GETMAXROWSSUFFIX
function getMaxRowsSuffix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL after the query to limit the number of rows.
Description:  
GETMAXROWSWHERE
function getMaxRowsWhere
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL in the where statement to limit the number of rows.
Description:  
GETNEWSORTNUM
function getNewSortNum
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
ReturnType: numeric
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the value an increment higher than the highest value in the given field to put a record at the end of the sort order.
Description:  
GETPKFIELDS
function getPKFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETPKFROMDATA
function getPKFromData
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the primary key of the record matching the given data.
Description:  
GETPRESEEDRECORDS
function getPreSeedRecords
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: query
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETPRIMARYKEYFIELD
function getPrimaryKeyField
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPRIMARYKEYFIELDNAME
function getPrimaryKeyFieldName
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPROPS
function getProps
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: no
Description:  
GETRECORD
function getRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the primary key value(s) given.
Description:  
GETRECORDS
function getRecords
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the data given.
Description:  
GETRECORDSSQL
function getRecordsSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
function Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL to get a recordset based on the data given.
Description:  
GETRELATIONFIELDS
function getRelationFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETRELATIONTYPES
function getRelationTypes
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETRELATIONVALUES
function getRelationValues
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETSTRINGTYPES
function getStringTypes
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of datypes that hold strings / character values.
Description:  
GETSUPPORTEDDATABASES
function getSupportedDatabases
Arguments:none
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the databases supported by this installation of DataMgr.
Description:  
GETTABLEDATA
function getTableData
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return information about all of the tables currently loaded into this instance of Data Manager.
Description:  
GETTABLEPROPS
function getTableProps
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
GETTYPEOFCFTYPE
function getTypeOfCFType
Arguments:
Name Required Type Default
CF_DataType Required string  
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
GETUPDATEABLEFIELDS
function getUpdateableFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of fields that can be updated.
Description:  
GETVERSION
function getVersion
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETWHERESQL
function getWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETXML
function getXML
Arguments:
Name Required Type Default
tablename Optional string  
indexes Optional boolean false
showroot Optional boolean true
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all loaded tables if none given.
Description:  
HASINDEX
function hasIndex
Arguments:
Name Required Type Default
tablename Required string  
indexname Required string  
ReturnType: boolean
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
INIT
function init
Arguments:
Name Required Type Default
connectionName Optional Any eform
connectionIdentifier Optional Any [runtime expression]
ReturnType: fileTransfer
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INSERTRECORD
function insertRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert a record into the given table with the provided data and do my best to return the primary key of the inserted record.
Description:  
ISBLANKVALUE
function isBlankValue
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I see if the given field is passed in as blank and is a nullable field.
Description:  
ISIDENTITYFIELD
function isIdentityField
Arguments:
Name Required Type Default
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ISLOGGING
function isLogging
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
ISOFTYPE
function isOfType
Arguments:
Name Required Type Default
value Required any  
CF_DataType Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check if the given value is of the given data type.
Description:  
ISVALIDDATE
function isValidDate
Arguments:
Name Required Type Default
value Required string  
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
LOADTABLE
function loadTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I load a table from the database into DataMgr.
Description:  
LOADXML
function loadXML
Arguments:
Name Required Type Default
xmldata Required string  
docreate Optional boolean false
addcolumns Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I add tables from XML and optionally create tables/columns as needed (I can also load data to a table upon its creation).
Description:  
LOGACTION
function logAction
Arguments:
Name Required Type Default
tablename Required string  
pkval Optional string  
action Required string  
data Optional struct  
sql Optional any  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I log an action in the database.
Description:  
MAKEDEFAULTVALUE
function makeDefaultValue
Arguments:
Name Required Type Default
value Required string  
CF_DataType Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return the value of the default for the given datatype and raw value.
Description:  
OPENFTP
function openFTP
Arguments:
Name Required Type Default
ftpServer Optional Any [runtime expression]
ftpPort Optional Any [runtime expression]
ftpUser Optional Any [runtime expression]
ftpPass Optional Any [runtime expression]
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
QUERYPARAM
function queryparam
Arguments:
Name Required Type Default
cfsqltype Optional string  
value Required any  
maxLength Optional string  
scale Optional string 0
null Optional boolean no
list Optional boolean no
separator Optional string ,
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
QUERYROWTOSTRUCT
function queryRowToStruct
Arguments:
Name Required Type Default
query Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Makes a row of a query into a structure.
Description:  
READABLESQL
function readableSQL
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return human-readable SQL from a SQL array (not to be sent to the database).
Description:  
READLOCAL
function readLocal
Arguments:
Name Required Type Default
file Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
READLOCALBINARY
function readLocalBinary
Arguments:
Name Required Type Default
file Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
READYTABLE
function readyTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
REMOVECOLUMN
function removeColumn
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a column from a table.
Description:  
REMOVETABLE
function removeTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a table.
Description:  
RUNSQL
function runSQL
Arguments:
Name Required Type Default
sql Required string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
RUNSQLARRAY
function runSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given array representing SQL code (structures in the array represent params).
Description:  
SAVE
function save
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct  
onExists Optional Any update
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic save functionality of the abstract gateway. I allow for very simple syntax to perform database INSERT / UPDATE statements. If I receive a Primary Key value, I know that I must UPDATE, otherwise, I INSERT
Description:  
SAVEFILE
function saveFile
Arguments:
Name Required Type Default
remotePath Optional Any  
localPath Optional Any  
fileName Optional Any  
formData Optional Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVEFILELOCAL
function saveFileLocal
Arguments:
Name Required Type Default
localPath Optional Any  
fileName Optional Any  
formData Optional Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVERECORD
function saveRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert or update a record in the given table (update if a matching record is found) with the provided data and return the primary key of the updated record.
Description:  
SAVERELATIONLIST
function saveRelationList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save a many-to-many relationship.
Description:  
SAVERELATIONS
function saveRelations
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
pkfield Required struct  
pkval Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SAVESORTORDER
function saveSortOrder
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
sortlist Required string  
PrecedingRecords Optional numeric 0
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save the sort order of records - putting them in the same order as the list of primary key values.
Description:  
SEEDDATA
function seedData
Arguments:
Name Required Type Default
xmldata Required any  
CreatedTables Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEX
function seedIndex
Arguments:
Name Required Type Default
indexname Required string  
tablename Required string  
fields Required string  
unique Optional boolean false
clustered Optional boolean false
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEXES
function seedIndexes
Arguments:
Name Required Type Default
xmldata Required any  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDRECORD
function seedRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
checkFields Optional string [empty string]
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCACHEDATE
function setCacheDate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMN
function setColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 0
Default Optional string  
Special Optional string  
Relation Optional struct  
PrimaryKey Optional boolean  
AllowNulls Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I set a column in the given table
Description:  
SETCOLUMNPRIMARYKEY
function setColumnPrimaryKey
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNRELATION
function setColumnRelation
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Relation Optional struct  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNSPECIAL
function setColumnSpecial
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Special Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SKEY
function skey
Arguments:
Name Required Type Default
name Required string  
val Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
STARTLOGGING
function startLogging
Arguments:
Name Required Type Default
logtable Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn on logging.
Description:  
STOPLOGGING
function stopLogging
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn off logging.
Description:  
STRUCTFROMARGS
function StructFromArgs
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
STRUCTKEYHASLEN
function StructKeyHasLen
Arguments:
Name Required Type Default
Struct Required struct  
Key Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given key of the given structure exists and has a value with any length.
Description:  
SVAL
function sval
Arguments:
Name Required Type Default
struct Required struct  
val Required any  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
TRUNCATE
function truncate
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the structure with the values truncated to the limit of the fields in the table.
Description:  
UPDATERECORD
function updateRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I update a record in the given table with the provided data and return the primary key of the updated record.
Description:  
UPDATERECORDS
function updateRecords
Arguments:
Name Required Type Default
tablename Required string  
data_set Required struct  
data_where Optional struct  
filters Optional array [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
UPLOADFTP
function uploadFTP
Arguments:
Name Required Type Default
LocalPath Optional Any  
FileName Optional Any  
FilePrefix Optional Any  
FileDirectory Optional Any  
remoteFileName Optional Any [runtime expression]
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
UPLOADLOCAL
function uploadLocal
Arguments:
Name Required Type Default
FormField Optional Any  
LocalPath Optional Any  
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
USEFIELD
function useField
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given field should be used in the SQL statement.
Description:  
SETTINGS
component common.model.configuration.settingsGateway
        extends common.model.baseGateway
DATASOURCE config
DAO
component common.model.datamgr.DataMgr_MSSQL
        extends common.model.datamgr.DataMgr
METHODS
ADDCOLUMN
function addColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 50
Default Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I add a column to the given table (deprecated in favor of setColumn).
Description:  
ADDENGINEENHANCEMENTS
function addEngineEnhancements
Arguments:none
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ADDTABLE
function addTable
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required array  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I add a table to the Data Manager.
Description:  
ADJUSTCOLUMNARGS
function adjustColumnArgs
Arguments:
Name Required Type Default
args Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
CHECKLENGTH
function checkLength
Arguments:
Name Required Type Default
field Required struct  
data Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check the length of incoming data to see if it can fit in the designated field (making for a more developer-friendly error messages).
Description:  
CHECKTABLE
function checkTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table exists in the Datamgr.
Description:  
CHECKTABLEPK
function checkTablePK
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table has a primary key.
Description:  
CLEAN
function clean
Arguments:
Name Required Type Default
Struct Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a clean version (stripped of MS-Word characters) of the given structure.
Description:  
CLEANSQLARRAY
function cleanSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I take a potentially nested SQL array and return a flat SQL array.
Description:  
CONCAT
function concat
Arguments:
Name Required Type Default
fields Required string  
delimeter Optional string [empty string]
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL to concatenate the given fields with the given delimeter.
Description:  
CONCATFIELDS
function concatFields
Arguments:
Name Required Type Default
tablename Required string  
fields Required string  
delimeter Optional string ,
tablealias Optional string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL to concatenate the given fields with the given delimeter.
Description:  
CREATETABLE
function createTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I take a table (for which the structure has been loaded) and create the table in the database.
Description:  
CREATETABLES
function CreateTables
Arguments:
Name Required Type Default
tables Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I create any tables that I know should exist in the database but don't.
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic delete functionality of the abstract gateway. I allow for very simple syntax to perform databse DELETE statements.
Description:  
DELETERECORD
function deleteRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the record with the given Primary Key(s).
Description:  
DELETERECORDS
function deleteRecords
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the records with the given data.
Description:  
DMDUPLICATE
function DMDuplicate
Arguments:
Name Required Type Default
var Required any  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
DMPRESERVESINGLEQUOTES
function DMPreserveSingleQuotes
Arguments:
Name Required Type Default
sql Required any  
ReturnType: string
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
ESCAPE
function escape
Arguments:
Name Required Type Default
name Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an escaped value for a table or field.
Description:  
EXPANDRELATIONSTRUCT
function expandRelationStruct
Arguments:
Name Required Type Default
Relation Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
FILLOUTJOINTABLERELATIONS
function fillOutJoinTableRelations
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GET
function get
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct [runtime expression]
orderBy Optional string [empty string]
limit Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic select functionality of the abstract gateway. I allow for very simple syntax to perform database SELECT statements.
Description:  
GETBOOLEANSQLVALUE
function getBooleanSqlValue
Arguments:
Name Required Type Default
value Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETCFDATATYPE
function getCFDataType
Arguments:
Name Required Type Default
type Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the cfqueryparam datatype from the database datatype.
Description:  
GETCONNECTION
function getConnection
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Returns a java.sql.Connection (taken from Transfer with permission).
Description:  
GETCREATESQL
function getCreateSQL
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL to create the given table.
Description:  
GETDATABASE
function getDatabase
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the database platform being used (Access,MS SQL,MySQL etc).
Description:  
GETDATABASEDRIVER
function getDatabaseDriver
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASEPROPERTIES
function getDatabaseProperties
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return some properties about this database
Description:  
GETDATABASESHORTSTRING
function getDatabaseShortString
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASETABLES
function getDatabaseTables
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a list of all tables in the current database.
Description:  
GETDATABASEXML
function getDatabaseXml
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all tables in the database.
Description:  
GETDATASOURCE
function getDatasource
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the datasource used by this Data Manager.
Description:  
GETDBDATATYPE
function getDBDataType
Arguments:
Name Required Type Default
CF_Datatype Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the database datatype from the cfqueryparam datatype.
Description:  
GETDBFIELDLIST
function getDBFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of fields in the database for the given table.
Description:  
GETDBTABLEINDEXES
function getDBTableIndexes
Arguments:
Name Required Type Default
tablename Required string  
indexname Optional string  
ReturnType: query
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETDBTABLESTRUCT
function getDBTableStruct
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the structure of the given table in the database.
Description:  
GETDEFAULTVALUES
function getDefaultValues
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETEFFECTIVEDATATYPE
function getEffectiveDataType
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETFIELD
function getField
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I the field of the given name.
Description:  
GETFIELDLENGTHS
function getFieldLengths
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a structure of the field lengths for fields where this is relevant.
Description:  
GETFIELDLIST
function getFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a list of fields in DataMgr for the given table.
Description:  
GETFIELDS
function getFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of all real fields in the given table in DataMgr.
Description:  
GETFIELDSELECTSQL
function getFieldSelectSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
useFieldAlias Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_HAS
function getFieldSQL_Has
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_MATH
function getFieldSQL_Math
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDWHERESQL
function getFieldWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
value Required string  
tablealias Optional string  
operator Optional string =
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETGENERICTYPE
function getGenericType
Arguments:
Name Required Type Default
CF_Datatype Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETHASFIELDSQL
function getHasFieldSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETINSERTEDIDENTITY
function getInsertedIdentity
Arguments:
Name Required Type Default
tablename Required string  
identfield Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the value of the identity field that was just inserted into the given table.
Description:  
GETINSERTRECORDSSQL
function getInsertRecordsSQL
Arguments:
Name Required Type Default
tablename Required string  
data_set Required struct  
data_where Optional struct  
filters Optional array [runtime expression]
ReturnType: array
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETMAXROWSPREFIX
function getMaxRowsPrefix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL before the field list in the select statement to limit the number of rows.
Description:  
GETMAXROWSSUFFIX
function getMaxRowsSuffix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL after the query to limit the number of rows.
Description:  
GETMAXROWSWHERE
function getMaxRowsWhere
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL in the where statement to limit the number of rows.
Description:  
GETNEWSORTNUM
function getNewSortNum
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
ReturnType: numeric
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the value an increment higher than the highest value in the given field to put a record at the end of the sort order.
Description:  
GETNOWSQL
function getNowSQL
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL for the current date/time.
Description:  
GETPKFIELDS
function getPKFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETPKFROMDATA
function getPKFromData
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the primary key of the record matching the given data.
Description:  
GETPRESEEDRECORDS
function getPreSeedRecords
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: query
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETPRIMARYKEYFIELD
function getPrimaryKeyField
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPRIMARYKEYFIELDNAME
function getPrimaryKeyFieldName
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPROPS
function getProps
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: no
Description:  
GETRECORD
function getRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the primary key value(s) given.
Description:  
GETRECORDS
function getRecords
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the data given.
Description:  
GETRECORDSSQL
function getRecordsSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
function Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL to get a recordset based on the data given.
Description:  
GETRELATIONFIELDS
function getRelationFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETRELATIONTYPES
function getRelationTypes
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETRELATIONVALUES
function getRelationValues
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETSTRINGTYPES
function getStringTypes
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of datypes that hold strings / character values.
Description:  
GETSUPPORTEDDATABASES
function getSupportedDatabases
Arguments:none
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the databases supported by this installation of DataMgr.
Description:  
GETTABLEDATA
function getTableData
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return information about all of the tables currently loaded into this instance of Data Manager.
Description:  
GETTABLEPROPS
function getTableProps
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
GETTYPEOFCFTYPE
function getTypeOfCFType
Arguments:
Name Required Type Default
CF_DataType Required string  
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
GETUPDATEABLEFIELDS
function getUpdateableFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of fields that can be updated.
Description:  
GETVERSION
function getVersion
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETWHERESQL
function getWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETXML
function getXML
Arguments:
Name Required Type Default
tablename Optional string  
indexes Optional boolean false
showroot Optional boolean true
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all loaded tables if none given.
Description:  
HASINDEX
function hasIndex
Arguments:
Name Required Type Default
tablename Required string  
indexname Required string  
ReturnType: boolean
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
INIT
function init
Arguments:
Name Required Type Default
datasource Required string  
database Optional string  
username Optional string  
password Optional string  
SmartCache Optional boolean false
ReturnType: DataMgr
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I instantiate and return this object.
Description:  
INSERTRECORD
function insertRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert a record into the given table with the provided data and do my best to return the primary key of the inserted record.
Description:  
INSERTRECORD2
function insertRecord2
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert a record into the given table with the provided data and do my best to return the primary key of the inserted record.
Description:  
ISBLANKVALUE
function isBlankValue
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I see if the given field is passed in as blank and is a nullable field.
Description:  
ISIDENTITYFIELD
function isIdentityField
Arguments:
Name Required Type Default
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ISLOGGING
function isLogging
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
ISOFTYPE
function isOfType
Arguments:
Name Required Type Default
value Required any  
CF_DataType Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check if the given value is of the given data type.
Description:  
ISSTRINGTYPE
function isStringType
Arguments:
Name Required Type Default
type Optional string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I indicate if the given datatype is valid for string data.
Description:  
ISVALIDDATE
function isValidDate
Arguments:
Name Required Type Default
value Required string  
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
LOADTABLE
function loadTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I load a table from the database into DataMgr.
Description:  
LOADXML
function loadXML
Arguments:
Name Required Type Default
xmldata Required string  
docreate Optional boolean false
addcolumns Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I add tables from XML and optionally create tables/columns as needed (I can also load data to a table upon its creation).
Description:  
LOGACTION
function logAction
Arguments:
Name Required Type Default
tablename Required string  
pkval Optional string  
action Required string  
data Optional struct  
sql Optional any  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I log an action in the database.
Description:  
MAKEDEFAULTVALUE
function makeDefaultValue
Arguments:
Name Required Type Default
value Required string  
CF_DataType Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return the value of the default for the given datatype and raw value.
Description:  
QUERYPARAM
function queryparam
Arguments:
Name Required Type Default
cfsqltype Optional string  
value Required any  
maxLength Optional string  
scale Optional string 0
null Optional boolean no
list Optional boolean no
separator Optional string ,
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
QUERYROWTOSTRUCT
function queryRowToStruct
Arguments:
Name Required Type Default
query Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Makes a row of a query into a structure.
Description:  
READABLESQL
function readableSQL
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return human-readable SQL from a SQL array (not to be sent to the database).
Description:  
READYTABLE
function readyTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
REMOVECOLUMN
function removeColumn
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a column from a table.
Description:  
REMOVETABLE
function removeTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a table.
Description:  
RUNSQL
function runSQL
Arguments:
Name Required Type Default
sql Required string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
RUNSQLARRAY
function runSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given array representing SQL code (structures in the array represent params).
Description:  
SAVE
function save
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct  
onExists Optional Any update
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic save functionality of the abstract gateway. I allow for very simple syntax to perform database INSERT / UPDATE statements. If I receive a Primary Key value, I know that I must UPDATE, otherwise, I INSERT
Description:  
SAVERECORD
function saveRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert or update a record in the given table (update if a matching record is found) with the provided data and return the primary key of the updated record.
Description:  
SAVERELATIONLIST
function saveRelationList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save a many-to-many relationship.
Description:  
SAVERELATIONS
function saveRelations
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
pkfield Required struct  
pkval Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SAVESORTORDER
function saveSortOrder
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
sortlist Required string  
PrecedingRecords Optional numeric 0
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save the sort order of records - putting them in the same order as the list of primary key values.
Description:  
SEEDDATA
function seedData
Arguments:
Name Required Type Default
xmldata Required any  
CreatedTables Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEX
function seedIndex
Arguments:
Name Required Type Default
indexname Required string  
tablename Required string  
fields Required string  
unique Optional boolean false
clustered Optional boolean false
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEXES
function seedIndexes
Arguments:
Name Required Type Default
xmldata Required any  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDRECORD
function seedRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
checkFields Optional string [empty string]
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCACHEDATE
function setCacheDate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMN
function setColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 0
Default Optional string  
Special Optional string  
Relation Optional struct  
PrimaryKey Optional boolean  
AllowNulls Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I set a column in the given table
Description:  
SETCOLUMNPRIMARYKEY
function setColumnPrimaryKey
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNRELATION
function setColumnRelation
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Relation Optional struct  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNSPECIAL
function setColumnSpecial
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Special Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SKEY
function skey
Arguments:
Name Required Type Default
name Required string  
val Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
SQLCREATECOLUMN
function sqlCreateColumn
Arguments:
Name Required Type Default
field Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
STARTLOGGING
function startLogging
Arguments:
Name Required Type Default
logtable Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn on logging.
Description:  
STOPLOGGING
function stopLogging
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn off logging.
Description:  
STRUCTFROMARGS
function StructFromArgs
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
STRUCTKEYHASLEN
function StructKeyHasLen
Arguments:
Name Required Type Default
Struct Required struct  
Key Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given key of the given structure exists and has a value with any length.
Description:  
SVAL
function sval
Arguments:
Name Required Type Default
struct Required struct  
val Required any  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
TRUNCATE
function truncate
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the structure with the values truncated to the limit of the fields in the table.
Description:  
UPDATERECORD
function updateRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I update a record in the given table with the provided data and return the primary key of the updated record.
Description:  
UPDATERECORDS
function updateRecords
Arguments:
Name Required Type Default
tablename Required string  
data_set Required struct  
data_where Optional struct  
filters Optional array [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
USEFIELD
function useField
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given field should be used in the SQL statement.
Description:  
METHODS
ADDCOLUMN
function addColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 50
Default Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I add a column to the given table (deprecated in favor of setColumn).
Description:  
ADDENGINEENHANCEMENTS
function addEngineEnhancements
Arguments:none
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ADDTABLE
function addTable
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required array  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I add a table to the Data Manager.
Description:  
ADJUSTCOLUMNARGS
function adjustColumnArgs
Arguments:
Name Required Type Default
args Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
CHECKLENGTH
function checkLength
Arguments:
Name Required Type Default
field Required struct  
data Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check the length of incoming data to see if it can fit in the designated field (making for a more developer-friendly error messages).
Description:  
CHECKTABLE
function checkTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table exists in the Datamgr.
Description:  
CHECKTABLEPK
function checkTablePK
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table has a primary key.
Description:  
CLEAN
function clean
Arguments:
Name Required Type Default
Struct Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a clean version (stripped of MS-Word characters) of the given structure.
Description:  
CLEANSQLARRAY
function cleanSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I take a potentially nested SQL array and return a flat SQL array.
Description:  
CREATETABLE
function createTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I take a table (for which the structure has been loaded) and create the table in the database.
Description:  
CREATETABLES
function CreateTables
Arguments:
Name Required Type Default
tables Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I create any tables that I know should exist in the database but don't.
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic delete functionality of the abstract gateway. I allow for very simple syntax to perform databse DELETE statements.
Description:  
DELETERECORD
function deleteRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the record with the given Primary Key(s).
Description:  
DELETERECORDS
function deleteRecords
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the records with the given data.
Description:  
DELETESETTING
function deleteSetting
Arguments:
Name Required Type Default
datastruct Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
DELETESETTINGLIST
function deleteSettingList
Arguments:
Name Required Type Default
settingID Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
DMDUPLICATE
function DMDuplicate
Arguments:
Name Required Type Default
var Required any  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
DMPRESERVESINGLEQUOTES
function DMPreserveSingleQuotes
Arguments:
Name Required Type Default
sql Required any  
ReturnType: string
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
ESCAPE
function escape
Arguments:
Name Required Type Default
name Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return an escaped value for a table or field.
Description:  
EXPANDRELATIONSTRUCT
function expandRelationStruct
Arguments:
Name Required Type Default
Relation Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
FILLOUTJOINTABLERELATIONS
function fillOutJoinTableRelations
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GET
function get
Arguments:
Name Required Type Default
applicationName Optional Any [empty string]
settingID Optional Any 0
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETBOOLEANSQLVALUE
function getBooleanSqlValue
Arguments:
Name Required Type Default
value Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETCONNECTION
function getConnection
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Returns a java.sql.Connection (taken from Transfer with permission).
Description:  
GETDATABASE
function getDataBase
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the database platform being used.
Description:  
GETDATABASEDRIVER
function getDatabaseDriver
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASEPROPERTIES
function getDatabaseProperties
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return some properties about this database
Description:  
GETDATABASESHORTSTRING
function getDatabaseShortString
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASEXML
function getDatabaseXml
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all tables in the database.
Description:  
GETDATASOURCE
function getDatasource
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the datasource used by this Data Manager.
Description:  
GETDBFIELDLIST
function getDBFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of fields in the database for the given table.
Description:  
GETDEFAULTVALUES
function getDefaultValues
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETEFFECTIVEDATATYPE
function getEffectiveDataType
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETFIELD
function getField
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I the field of the given name.
Description:  
GETFIELDLENGTHS
function getFieldLengths
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a structure of the field lengths for fields where this is relevant.
Description:  
GETFIELDLIST
function getFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a list of fields in DataMgr for the given table.
Description:  
GETFIELDS
function getFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of all real fields in the given table in DataMgr.
Description:  
GETFIELDSELECTSQL
function getFieldSelectSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
useFieldAlias Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_HAS
function getFieldSQL_Has
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_MATH
function getFieldSQL_Math
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDWHERESQL
function getFieldWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
value Required string  
tablealias Optional string  
operator Optional string =
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETGENERICTYPE
function getGenericType
Arguments:
Name Required Type Default
CF_Datatype Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETGROUP
function getGroup
Arguments:
Name Required Type Default
applicationName Optional Any [empty string]
groupID Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETHASFIELDSQL
function getHasFieldSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETINSERTEDIDENTITY
function getInsertedIdentity
Arguments:
Name Required Type Default
tablename Required string  
identfield Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the value of the identity field that was just inserted into the given table.
Description:  
GETMAXROWSPREFIX
function getMaxRowsPrefix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL before the field list in the select statement to limit the number of rows.
Description:  
GETMAXROWSSUFFIX
function getMaxRowsSuffix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL after the query to limit the number of rows.
Description:  
GETMAXROWSWHERE
function getMaxRowsWhere
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL in the where statement to limit the number of rows.
Description:  
GETNEWSORTNUM
function getNewSortNum
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
ReturnType: numeric
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the value an increment higher than the highest value in the given field to put a record at the end of the sort order.
Description:  
GETPKFIELDS
function getPKFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETPKFROMDATA
function getPKFromData
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the primary key of the record matching the given data.
Description:  
GETPRESEEDRECORDS
function getPreSeedRecords
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: query
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETPRIMARYKEYFIELD
function getPrimaryKeyField
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPRIMARYKEYFIELDNAME
function getPrimaryKeyFieldName
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPROPS
function getProps
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: no
Description:  
GETRECORD
function getRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the primary key value(s) given.
Description:  
GETRECORDS
function getRecords
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the data given.
Description:  
GETRECORDSSQL
function getRecordsSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
function Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL to get a recordset based on the data given.
Description:  
GETRELATIONFIELDS
function getRelationFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETRELATIONTYPES
function getRelationTypes
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETRELATIONVALUES
function getRelationValues
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETSETTINGS
function getSettings
Arguments:
Name Required Type Default
instance Optional Any [empty string]
applicationName Optional Any [empty string]
settingID Optional Any [empty string]
groupID Optional Any [empty string]
groupName Optional Any [empty string]
settingName Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETSTRINGTYPES
function getStringTypes
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of datypes that hold strings / character values.
Description:  
GETSUPPORTEDDATABASES
function getSupportedDatabases
Arguments:none
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the databases supported by this installation of DataMgr.
Description:  
GETTABLEDATA
function getTableData
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return information about all of the tables currently loaded into this instance of Data Manager.
Description:  
GETTABLEPROPS
function getTableProps
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
GETTYPEOFCFTYPE
function getTypeOfCFType
Arguments:
Name Required Type Default
CF_DataType Required string  
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
GETUPDATEABLEFIELDS
function getUpdateableFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of fields that can be updated.
Description:  
GETVERSION
function getVersion
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETWHERESQL
function getWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETXML
function getXML
Arguments:
Name Required Type Default
tablename Optional string  
indexes Optional boolean false
showroot Optional boolean true
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all loaded tables if none given.
Description:  
HASINDEX
function hasIndex
Arguments:
Name Required Type Default
tablename Required string  
indexname Required string  
ReturnType: boolean
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
INIT
function init
Arguments:
Name Required Type Default
datasource Required Any  
xmlDefinition Optional string [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INSERTRECORD
function insertRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert a record into the given table with the provided data and do my best to return the primary key of the inserted record.
Description:  
ISBLANKVALUE
function isBlankValue
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I see if the given field is passed in as blank and is a nullable field.
Description:  
ISIDENTITYFIELD
function isIdentityField
Arguments:
Name Required Type Default
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ISLOGGING
function isLogging
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
ISOFTYPE
function isOfType
Arguments:
Name Required Type Default
value Required any  
CF_DataType Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check if the given value is of the given data type.
Description:  
ISVALIDDATE
function isValidDate
Arguments:
Name Required Type Default
value Required string  
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
LOADTABLE
function loadTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I load a table from the database into DataMgr.
Description:  
LOADXML
function loadXML
Arguments:
Name Required Type Default
xmldata Required string  
docreate Optional boolean false
addcolumns Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I add tables from XML and optionally create tables/columns as needed (I can also load data to a table upon its creation).
Description:  
LOGACTION
function logAction
Arguments:
Name Required Type Default
tablename Required string  
pkval Optional string  
action Required string  
data Optional struct  
sql Optional any  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I log an action in the database.
Description:  
MAKEDEFAULTVALUE
function makeDefaultValue
Arguments:
Name Required Type Default
value Required string  
CF_DataType Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return the value of the default for the given datatype and raw value.
Description:  
QUERYPARAM
function queryparam
Arguments:
Name Required Type Default
cfsqltype Optional string  
value Required any  
maxLength Optional string  
scale Optional string 0
null Optional boolean no
list Optional boolean no
separator Optional string ,
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
QUERYROWTOSTRUCT
function queryRowToStruct
Arguments:
Name Required Type Default
query Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Makes a row of a query into a structure.
Description:  
READABLESQL
function readableSQL
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return human-readable SQL from a SQL array (not to be sent to the database).
Description:  
READYTABLE
function readyTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
REMOVECOLUMN
function removeColumn
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a column from a table.
Description:  
REMOVETABLE
function removeTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a table.
Description:  
RUNSQL
function runSQL
Arguments:
Name Required Type Default
sql Required string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
RUNSQLARRAY
function runSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given array representing SQL code (structures in the array represent params).
Description:  
SAVE
function save
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct  
onExists Optional Any update
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic save functionality of the abstract gateway. I allow for very simple syntax to perform database INSERT / UPDATE statements. If I receive a Primary Key value, I know that I must UPDATE, otherwise, I INSERT
Description:  
SAVEGROUP
function saveGroup
Arguments:
Name Required Type Default
datastruct Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVERECORD
function saveRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert or update a record in the given table (update if a matching record is found) with the provided data and return the primary key of the updated record.
Description:  
SAVERELATIONLIST
function saveRelationList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save a many-to-many relationship.
Description:  
SAVERELATIONS
function saveRelations
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
pkfield Required struct  
pkval Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SAVESETTING
function saveSetting
Arguments:
Name Required Type Default
datastruct Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVESETTINGLIST
function saveSettingList
Arguments:
Name Required Type Default
datastruct Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVESORTORDER
function saveSortOrder
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
sortlist Required string  
PrecedingRecords Optional numeric 0
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save the sort order of records - putting them in the same order as the list of primary key values.
Description:  
SEEDDATA
function seedData
Arguments:
Name Required Type Default
xmldata Required any  
CreatedTables Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEX
function seedIndex
Arguments:
Name Required Type Default
indexname Required string  
tablename Required string  
fields Required string  
unique Optional boolean false
clustered Optional boolean false
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEXES
function seedIndexes
Arguments:
Name Required Type Default
xmldata Required any  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDRECORD
function seedRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
checkFields Optional string [empty string]
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCACHEDATE
function setCacheDate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMN
function setColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 0
Default Optional string  
Special Optional string  
Relation Optional struct  
PrimaryKey Optional boolean  
AllowNulls Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I set a column in the given table
Description:  
SETCOLUMNPRIMARYKEY
function setColumnPrimaryKey
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNRELATION
function setColumnRelation
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Relation Optional struct  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNSPECIAL
function setColumnSpecial
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Special Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SKEY
function skey
Arguments:
Name Required Type Default
name Required string  
val Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
STARTLOGGING
function startLogging
Arguments:
Name Required Type Default
logtable Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn on logging.
Description:  
STOPLOGGING
function stopLogging
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn off logging.
Description:  
STRUCTFROMARGS
function StructFromArgs
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
STRUCTKEYHASLEN
function StructKeyHasLen
Arguments:
Name Required Type Default
Struct Required struct  
Key Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given key of the given structure exists and has a value with any length.
Description:  
SVAL
function sval
Arguments:
Name Required Type Default
struct Required struct  
val Required any  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
TRUNCATE
function truncate
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the structure with the values truncated to the limit of the fields in the table.
Description:  
UPDATERECORD
function updateRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I update a record in the given table with the provided data and return the primary key of the updated record.
Description:  
UPDATERECORDS
function updateRecords
Arguments:
Name Required Type Default
tablename Required string  
data_set Required struct  
data_where Optional struct  
filters Optional array [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
USEFIELD
function useField
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given field should be used in the SQL statement.
Description:  
ACCESS
component common.model.configuration.accessGateway
        extends common.model.baseGateway
DATASOURCE config
DAO
component common.model.datamgr.DataMgr_MSSQL
        extends common.model.datamgr.DataMgr
METHODS
ADDCOLUMN
function addColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 50
Default Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I add a column to the given table (deprecated in favor of setColumn).
Description:  
ADDENGINEENHANCEMENTS
function addEngineEnhancements
Arguments:none
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ADDTABLE
function addTable
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required array  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I add a table to the Data Manager.
Description:  
ADJUSTCOLUMNARGS
function adjustColumnArgs
Arguments:
Name Required Type Default
args Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
CHECKLENGTH
function checkLength
Arguments:
Name Required Type Default
field Required struct  
data Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check the length of incoming data to see if it can fit in the designated field (making for a more developer-friendly error messages).
Description:  
CHECKTABLE
function checkTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table exists in the Datamgr.
Description:  
CHECKTABLEPK
function checkTablePK
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table has a primary key.
Description:  
CLEAN
function clean
Arguments:
Name Required Type Default
Struct Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a clean version (stripped of MS-Word characters) of the given structure.
Description:  
CLEANSQLARRAY
function cleanSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I take a potentially nested SQL array and return a flat SQL array.
Description:  
CONCAT
function concat
Arguments:
Name Required Type Default
fields Required string  
delimeter Optional string [empty string]
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL to concatenate the given fields with the given delimeter.
Description:  
CONCATFIELDS
function concatFields
Arguments:
Name Required Type Default
tablename Required string  
fields Required string  
delimeter Optional string ,
tablealias Optional string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL to concatenate the given fields with the given delimeter.
Description:  
CREATETABLE
function createTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I take a table (for which the structure has been loaded) and create the table in the database.
Description:  
CREATETABLES
function CreateTables
Arguments:
Name Required Type Default
tables Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I create any tables that I know should exist in the database but don't.
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic delete functionality of the abstract gateway. I allow for very simple syntax to perform databse DELETE statements.
Description:  
DELETERECORD
function deleteRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the record with the given Primary Key(s).
Description:  
DELETERECORDS
function deleteRecords
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the records with the given data.
Description:  
DMDUPLICATE
function DMDuplicate
Arguments:
Name Required Type Default
var Required any  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
DMPRESERVESINGLEQUOTES
function DMPreserveSingleQuotes
Arguments:
Name Required Type Default
sql Required any  
ReturnType: string
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
ESCAPE
function escape
Arguments:
Name Required Type Default
name Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an escaped value for a table or field.
Description:  
EXPANDRELATIONSTRUCT
function expandRelationStruct
Arguments:
Name Required Type Default
Relation Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
FILLOUTJOINTABLERELATIONS
function fillOutJoinTableRelations
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GET
function get
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct [runtime expression]
orderBy Optional string [empty string]
limit Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic select functionality of the abstract gateway. I allow for very simple syntax to perform database SELECT statements.
Description:  
GETBOOLEANSQLVALUE
function getBooleanSqlValue
Arguments:
Name Required Type Default
value Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETCFDATATYPE
function getCFDataType
Arguments:
Name Required Type Default
type Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the cfqueryparam datatype from the database datatype.
Description:  
GETCONNECTION
function getConnection
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Returns a java.sql.Connection (taken from Transfer with permission).
Description:  
GETCREATESQL
function getCreateSQL
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL to create the given table.
Description:  
GETDATABASE
function getDatabase
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the database platform being used (Access,MS SQL,MySQL etc).
Description:  
GETDATABASEDRIVER
function getDatabaseDriver
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASEPROPERTIES
function getDatabaseProperties
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return some properties about this database
Description:  
GETDATABASESHORTSTRING
function getDatabaseShortString
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the string that can be found in the driver or JDBC URL for the database platform being used.
Description:  
GETDATABASETABLES
function getDatabaseTables
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a list of all tables in the current database.
Description:  
GETDATABASEXML
function getDatabaseXml
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all tables in the database.
Description:  
GETDATASOURCE
function getDatasource
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the datasource used by this Data Manager.
Description:  
GETDBDATATYPE
function getDBDataType
Arguments:
Name Required Type Default
CF_Datatype Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the database datatype from the cfqueryparam datatype.
Description:  
GETDBFIELDLIST
function getDBFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of fields in the database for the given table.
Description:  
GETDBTABLEINDEXES
function getDBTableIndexes
Arguments:
Name Required Type Default
tablename Required string  
indexname Optional string  
ReturnType: query
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETDBTABLESTRUCT
function getDBTableStruct
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the structure of the given table in the database.
Description:  
GETDEFAULTVALUES
function getDefaultValues
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETEFFECTIVEDATATYPE
function getEffectiveDataType
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETFIELD
function getField
Arguments:
Name Required Type Default
tablename Required string  
fieldname Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I the field of the given name.
Description:  
GETFIELDLENGTHS
function getFieldLengths
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a structure of the field lengths for fields where this is relevant.
Description:  
GETFIELDLIST
function getFieldList
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a list of fields in DataMgr for the given table.
Description:  
GETFIELDS
function getFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of all real fields in the given table in DataMgr.
Description:  
GETFIELDSELECTSQL
function getFieldSelectSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
useFieldAlias Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_HAS
function getFieldSQL_Has
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDSQL_MATH
function getFieldSQL_Math
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETFIELDWHERESQL
function getFieldWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
value Required string  
tablealias Optional string  
operator Optional string =
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETGENERICTYPE
function getGenericType
Arguments:
Name Required Type Default
CF_Datatype Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the generic ColdFusion data type for the given field.
Description:  
GETHASFIELDSQL
function getHasFieldSQL
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
tablealias Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETINSERTEDIDENTITY
function getInsertedIdentity
Arguments:
Name Required Type Default
tablename Required string  
identfield Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the value of the identity field that was just inserted into the given table.
Description:  
GETINSERTRECORDSSQL
function getInsertRecordsSQL
Arguments:
Name Required Type Default
tablename Required string  
data_set Required struct  
data_where Optional struct  
filters Optional array [runtime expression]
ReturnType: array
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETMAXROWSPREFIX
function getMaxRowsPrefix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL before the field list in the select statement to limit the number of rows.
Description:  
GETMAXROWSSUFFIX
function getMaxRowsSuffix
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL after the query to limit the number of rows.
Description:  
GETMAXROWSWHERE
function getMaxRowsWhere
Arguments:
Name Required Type Default
maxrows Required numeric  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL in the where statement to limit the number of rows.
Description:  
GETNEWSORTNUM
function getNewSortNum
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
ReturnType: numeric
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the value an increment higher than the highest value in the given field to put a record at the end of the sort order.
Description:  
GETNOWSQL
function getNowSQL
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the SQL for the current date/time.
Description:  
GETPKFIELDS
function getPKFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETPKFROMDATA
function getPKFromData
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the primary key of the record matching the given data.
Description:  
GETPRESEEDRECORDS
function getPreSeedRecords
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: query
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETPRIMARYKEYFIELD
function getPrimaryKeyField
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPRIMARYKEYFIELDNAME
function getPrimaryKeyFieldName
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return primary key field for this table.
Description:  
GETPROPS
function getProps
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: no
Description:  
GETRECORD
function getRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the primary key value(s) given.
Description:  
GETRECORDS
function getRecords
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get a recordset based on the data given.
Description:  
GETRECORDSSQL
function getRecordsSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
function Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the SQL to get a recordset based on the data given.
Description:  
GETRELATIONFIELDS
function getRelationFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return an array of primary key fields.
Description:  
GETRELATIONTYPES
function getRelationTypes
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETRELATIONVALUES
function getRelationValues
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GETSTRINGTYPES
function getStringTypes
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a list of datypes that hold strings / character values.
Description:  
GETSUPPORTEDDATABASES
function getSupportedDatabases
Arguments:none
ReturnType: query
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the databases supported by this installation of DataMgr.
Description:  
GETTABLEDATA
function getTableData
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return information about all of the tables currently loaded into this instance of Data Manager.
Description:  
GETTABLEPROPS
function getTableProps
Arguments:
Name Required Type Default
tablename Optional string  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
GETTYPEOFCFTYPE
function getTypeOfCFType
Arguments:
Name Required Type Default
CF_DataType Required string  
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
GETUPDATEABLEFIELDS
function getUpdateableFields
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: array
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return an array of fields that can be updated.
Description:  
GETVERSION
function getVersion
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETWHERESQL
function getWhereSQL
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
advsql Optional struct  
filters Optional array  
ReturnType: array
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
GETXML
function getXML
Arguments:
Name Required Type Default
tablename Optional string  
indexes Optional boolean false
showroot Optional boolean true
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the XML for the given table or for all loaded tables if none given.
Description:  
HASINDEX
function hasIndex
Arguments:
Name Required Type Default
tablename Required string  
indexname Required string  
ReturnType: boolean
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
INIT
function init
Arguments:
Name Required Type Default
datasource Required string  
database Optional string  
username Optional string  
password Optional string  
SmartCache Optional boolean false
ReturnType: DataMgr
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I instantiate and return this object.
Description:  
INSERTRECORD
function insertRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert a record into the given table with the provided data and do my best to return the primary key of the inserted record.
Description:  
INSERTRECORD2
function insertRecord2
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert a record into the given table with the provided data and do my best to return the primary key of the inserted record.
Description:  
ISBLANKVALUE
function isBlankValue
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I see if the given field is passed in as blank and is a nullable field.
Description:  
ISIDENTITYFIELD
function isIdentityField
Arguments:
Name Required Type Default
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ISLOGGING
function isLogging
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
ISOFTYPE
function isOfType
Arguments:
Name Required Type Default
value Required any  
CF_DataType Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check if the given value is of the given data type.
Description:  
ISSTRINGTYPE
function isStringType
Arguments:
Name Required Type Default
type Optional string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I indicate if the given datatype is valid for string data.
Description:  
ISVALIDDATE
function isValidDate
Arguments:
Name Required Type Default
value Required string  
ReturnType: boolean
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
LOADTABLE
function loadTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I load a table from the database into DataMgr.
Description:  
LOADXML
function loadXML
Arguments:
Name Required Type Default
xmldata Required string  
docreate Optional boolean false
addcolumns Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I add tables from XML and optionally create tables/columns as needed (I can also load data to a table upon its creation).
Description:  
LOGACTION
function logAction
Arguments:
Name Required Type Default
tablename Required string  
pkval Optional string  
action Required string  
data Optional struct  
sql Optional any  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I log an action in the database.
Description:  
MAKEDEFAULTVALUE
function makeDefaultValue
Arguments:
Name Required Type Default
value Required string  
CF_DataType Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return the value of the default for the given datatype and raw value.
Description:  
QUERYPARAM
function queryparam
Arguments:
Name Required Type Default
cfsqltype Optional string  
value Required any  
maxLength Optional string  
scale Optional string 0
null Optional boolean no
list Optional boolean no
separator Optional string ,
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
QUERYROWTOSTRUCT
function queryRowToStruct
Arguments:
Name Required Type Default
query Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Makes a row of a query into a structure.
Description:  
READABLESQL
function readableSQL
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return human-readable SQL from a SQL array (not to be sent to the database).
Description:  
READYTABLE
function readyTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I get the internal table representation ready for use by DataMgr.
Description:  
REMOVECOLUMN
function removeColumn
Arguments:
Name Required Type Default
tablename Required string  
field Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a column from a table.
Description:  
REMOVETABLE
function removeTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I remove a table.
Description:  
RUNSQL
function runSQL
Arguments:
Name Required Type Default
sql Required string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given SQL.
Description:  
RUNSQLARRAY
function runSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I run the given array representing SQL code (structures in the array represent params).
Description:  
SAVE
function save
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct  
onExists Optional Any update
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic save functionality of the abstract gateway. I allow for very simple syntax to perform database INSERT / UPDATE statements. If I receive a Primary Key value, I know that I must UPDATE, otherwise, I INSERT
Description:  
SAVERECORD
function saveRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I insert or update a record in the given table (update if a matching record is found) with the provided data and return the primary key of the updated record.
Description:  
SAVERELATIONLIST
function saveRelationList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save a many-to-many relationship.
Description:  
SAVERELATIONS
function saveRelations
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
pkfield Required struct  
pkval Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SAVESORTORDER
function saveSortOrder
Arguments:
Name Required Type Default
tablename Required string  
sortfield Required string  
sortlist Required string  
PrecedingRecords Optional numeric 0
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I save the sort order of records - putting them in the same order as the list of primary key values.
Description:  
SEEDDATA
function seedData
Arguments:
Name Required Type Default
xmldata Required any  
CreatedTables Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEX
function seedIndex
Arguments:
Name Required Type Default
indexname Required string  
tablename Required string  
fields Required string  
unique Optional boolean false
clustered Optional boolean false
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDINDEXES
function seedIndexes
Arguments:
Name Required Type Default
xmldata Required any  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SEEDRECORD
function seedRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
OnExists Optional string insert
checkFields Optional string [empty string]
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCACHEDATE
function setCacheDate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMN
function setColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 0
Default Optional string  
Special Optional string  
Relation Optional struct  
PrimaryKey Optional boolean  
AllowNulls Optional boolean true
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I set a column in the given table
Description:  
SETCOLUMNPRIMARYKEY
function setColumnPrimaryKey
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNRELATION
function setColumnRelation
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Relation Optional struct  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SETCOLUMNSPECIAL
function setColumnSpecial
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
Special Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
SKEY
function skey
Arguments:
Name Required Type Default
name Required string  
val Required string  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
SQLCREATECOLUMN
function sqlCreateColumn
Arguments:
Name Required Type Default
field Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
STARTLOGGING
function startLogging
Arguments:
Name Required Type Default
logtable Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn on logging.
Description:  
STOPLOGGING
function stopLogging
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I turn off logging.
Description:  
STRUCTFROMARGS
function StructFromArgs
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
STRUCTKEYHASLEN
function StructKeyHasLen
Arguments:
Name Required Type Default
Struct Required struct  
Key Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given key of the given structure exists and has a value with any length.
Description:  
SVAL
function sval
Arguments:
Name Required Type Default
struct Required struct  
val Required any  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return a structure for use in runSQLArray (I make a value key in the structure with the appropriate value).
Description:  
TRUNCATE
function truncate
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the structure with the values truncated to the limit of the fields in the table.
Description:  
UPDATERECORD
function updateRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I update a record in the given table with the provided data and return the primary key of the updated record.
Description:  
UPDATERECORDS
function updateRecords
Arguments:
Name Required Type Default
tablename Required string  
data_set Required struct  
data_where Optional struct  
filters Optional array [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
USEFIELD
function useField
Arguments:
Name Required Type Default
Struct Required struct  
Field Required struct  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given field should be used in the SQL statement.
Description:  
METHODS
ADDCOLUMN
function addColumn
Arguments:
Name Required Type Default
tablename Required string  
columnname Required string  
CF_Datatype Optional string  
Length Optional numeric 50
Default Optional string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I add a column to the given table (deprecated in favor of setColumn).
Description:  
ADDENGINEENHANCEMENTS
function addEngineEnhancements
Arguments:none
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
ADDTABLE
function addTable
Arguments:
Name Required Type Default
tablename Required string  
fielddata Required array  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I add a table to the Data Manager.
Description:  
ADJUSTCOLUMNARGS
function adjustColumnArgs
Arguments:
Name Required Type Default
args Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
CHECKAUTH
function checkAuth
Arguments:
Name Required Type Default
exceptions Optional Any  
ipAddress Optional Any  
application Optional Any  
instance Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CHECKHOST
function checkHost
Arguments:
Name Required Type Default
exceptions Optional Any  
httpHost Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CHECKIPADDRESS
function checkIPAddress
Arguments:
Name Required Type Default
exceptions Optional Any  
ipAddress Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CHECKLENGTH
function checkLength
Arguments:
Name Required Type Default
field Required struct  
data Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check the length of incoming data to see if it can fit in the designated field (making for a more developer-friendly error messages).
Description:  
CHECKTABLE
function checkTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: boolean
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table exists in the Datamgr.
Description:  
CHECKTABLEPK
function checkTablePK
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I check to see if the given table has a primary key.
Description:  
CLEAN
function clean
Arguments:
Name Required Type Default
Struct Required struct  
ReturnType: struct
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return a clean version (stripped of MS-Word characters) of the given structure.
Description:  
CLEANSQLARRAY
function cleanSQLArray
Arguments:
Name Required Type Default
sqlarray Required array  
ReturnType: array
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I take a potentially nested SQL array and return a flat SQL array.
Description:  
CREATETABLE
function createTable
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I take a table (for which the structure has been loaded) and create the table in the database.
Description:  
CREATETABLES
function CreateTables
Arguments:
Name Required Type Default
tables Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I create any tables that I know should exist in the database but don't.
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic delete functionality of the abstract gateway. I allow for very simple syntax to perform databse DELETE statements.
Description:  
DELETEIPEXCEPTION
function deleteIPException
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
DELETEPIDEXCEPTION
function deletePIDException
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
DELETERECORD
function deleteRecord
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the record with the given Primary Key(s).
Description:  
DELETERECORDS
function deleteRecords
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I delete the records with the given data.
Description:  
DMDUPLICATE
function DMDuplicate
Arguments:
Name Required Type Default
var Required any  
ReturnType: any
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
DMPRESERVESINGLEQUOTES
function DMPreserveSingleQuotes
Arguments:
Name Required Type Default
sql Required any  
ReturnType: string
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
ESCAPE
function escape
Arguments:
Name Required Type Default
name Required string  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: I return an escaped value for a table or field.
Description:  
EXPANDRELATIONSTRUCT
function expandRelationStruct
Arguments:
Name Required Type Default
Relation Required struct  
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
FILLOUTJOINTABLERELATIONS
function fillOutJoinTableRelations
Arguments:
Name Required Type Default
tablename Required string  
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint:  
Description:  
GET
function get
Arguments:
Name Required Type Default
table Required string  
dataStruct Required struct [runtime expression]
orderBy Optional string [empty string]
limit Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I am the generic select functionality of the abstract gateway. I allow for very simple syntax to perform database SELECT statements.
Description:  
GETBOOLEANSQLVALUE
function getBooleanSqlValue
Arguments:
Name Required Type Default
value Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint:  
Description:  
GETCONNECTION
function getConnection
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Returns a java.sql.Connection (taken from Transfer with permission).
Description:  
GETDATABASE
function getDataBase
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: I return the database platform being used.
Description:  
GETDATABASEDRIVER