SQL Manager Class (clsSQLMgr)

fdmAPI.API.SQLMgr.API Call

Table 7-10 SQL Manager Class (clsSQLMgr)

API Call	Method/Property/Object Reference	Description
fImpFieldsForGroup	Method	Returns a recordset containing all of the records ("Mappings") for the Import Format name (string) passed in at runtime. Inputs: ByVal strGroupKey As String, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 strGroupKey—Name of Import group key to return field parsing instructions blnReadOnly—Optional, Flag to create a read only recordset (Type=farsSnap) blnSQLOnly—Optional, Switch for generating SQL only lngMarshalType—Optional, Value used to control how the recordset is returned.
fImpGroup	Method	Returns a recordset containing all records in TBHVIMPGROUP table for the Import Format name (string) passed in. Inputs: ByVal strGroupKey As String, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 strGroupKey—Name of Import group key to return field parsing instructions for blnReadOnly—Optional, Flag to create a read only recordset (Type=farsSnap) blnSQLOnly—Optional, Switch for generating SQL only lngMarshalType—Optional, Value used to control how the recordset is returned
fImpGroupList	Method	Returns a recordset containing all import format groups based on group type. Inputs: ByVal lngGroupType As Integer, Optional ByVal blnIncludeNone As Boolean = False, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fIntDimensionList	Method	Returns a recordset of dimensions used in the Target Application. ByVal strApplicationID As String, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fLoadDetails	Method	Return load details for specified Load ID. Inputs: ByVal strLoadID as String, Optional ByVal blnReadOnly as Boolean = False, Optional ByVal blnSQLOnly as Boolean = False, Optional ByVal lngMarshalType as Integer = 0 Output: ADODB.Recordset
fPartition	Method	Returns a recordset containing all of the properties of the location passed into the function. ByVal strLoc As String, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fPartitionList	Method	Returns a recordset containing all properties of all locations that exist. Inputs: Optional ByVal strLocNoRelatives As String = "", Optional ByVal strLocChildren As String = "", Optional ByVal blnNoParent As Boolean = False, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fPeriodKeyList	Method	Returns a recordset containing the list of period keys for the loadid passed to the function. Inputs: ByVal strLoadID As String, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.RecordsetOutput: ADODB.Recordset
fPOVDataValue	Method	Return the data value for the specified partition key. Inputs: ByVal strPartitionKey As String, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fProcessBalImpFile	Method	Return a recordset containing the name of the imported file for a given load id. For all non-file based imports, this function returns an empty string. Inputs: ByVal strLoadID As String, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fProcessLogForPOV	Method	Return a single process status record for the specified POV value/intersection. Inputs: ByVal strLoc As String, ByVal strCat As String, ByVal strPer As String, ByVal strRuleID As String, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fTrialBalanceConverted	Method	Returns a recordset containing all records pulled from: tDataSeg based on LoadID, Loc, Scenario, and Period. Inputs: ByVal strLoadID As String, ByVal strLoc As String, ByVal strCat As String, ByVal strPer As String, Optional ByVal blnExcludeIgnore As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngPageSize As Integer = 0, Optional ByVal lngPage As Integer = 0, Optional ByRef lngOPRecordCount As Object = Nothing, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fTrialBalanceLite	Method	Return a recordset listing the DataKey field from the data segment table assigned to the specified location. The data is returned based on the specified POV values and calculation types. The purpose of this recordset is to create a fast/light weight recordset that you can use to execute a looping cursor delete. nput: ByVal strLoadID As String, ByVal strLoc As String, ByVal strCat As String, ByVal strPer As String, ByVal strCalcTypes As String, Optional ByVal lngStartCalcType As Integer = 0, Optional ByVal lngEndCalcType As Integer = 0, Optional ByVal strJournalID As String = "", Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fValEntGroupList	Method	Returns a recordset containing all validation entity group records. Input: Optional ByVal blnIncludeNone As Boolean = False, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fValEntitiesForGroup	Method	Return a recordset containing validation entity specifications for the specified validation entity group. Inputs: ByVal strGroupKey As String, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False,Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fValGroup	Method	Return a recordset containing a single validation rule group. Inputs: ByVal strGroupKey As String, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset
fValGroupList	Method	Return a recordset containing all validation rule group records. Inputs: Optional ByVal blnIncludeNone As Boolean = False, Optional ByVal blnReadOnly As Boolean = False, Optional ByVal blnSQLOnly As Boolean = False, Optional ByVal lngMarshalType As Integer = 0 Output: ADODB.Recordset