Data warehouse functions
DataWarehouseExecuteLoadQuery
Declaration
DataWarehouseLoadQueryResult DataWarehouseExecuteLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName)
          Description
Runs a Data Warehouse load query synchronously.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
connection | 
             Data Warehouse connection. | 
            
modelName | 
             Unique name of the model. | 
            
tableName | 
             Unique name of the table. | 
            
loadQueryName | 
             Unique name of the query. | 
            
Return Value
Instance of DataWarehouseLoadQueryResult.
DataWarehouseExecuteLoadQuery
Declaration
DataWarehouseLoadQueryResult DataWarehouseExecuteLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName, VariantDictionary parameters)
          Description
Runs a Data Warehouse load query synchronously.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
connection | 
             Data Warehouse connection. | 
            
modelName | 
             Unique name of the model. | 
            
tableName | 
             Unique name of the table. | 
            
loadQueryName | 
             Unique name of the query. | 
            
parameters | 
             Dictionary with parameter names and values. | 
            
Return Value
Instance of DataWarehouseLoadQueryResult.
DataWarehouseExecuteLoadQuery
Declaration
DataWarehouseLoadQueryResult DataWarehouseExecuteLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName, bool dropData, VariantDictionary parameters)
          Description
Runs a Data Warehouse load query synchronously.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
connection | 
             Data Warehouse connection. | 
            
modelName | 
             Unique name of the model. | 
            
tableName | 
             Unique name of the table. | 
            
loadQueryName | 
             Unique name of the query. | 
            
dropData | 
             Flag to drop data before query execution. | 
            
parameters | 
             Dictionary with parameter names and values. | 
            
Return Value
Instance of DataWarehouseLoadQueryResult.
DataWarehouseExecuteScript
Declaration
DataWarehouseScriptResult DataWarehouseExecuteScript(SQLConnection connection, string modelName, string scriptName)
          Description
Runs the Data Warehouse script synchronously.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
connection | 
             Data Warehouse connection. | 
            
modelName | 
             Unique name of the model. | 
            
scriptName | 
             Name of the script. | 
            
Return Value
Instance of DataWarehouseScriptResult.
DataWarehouseExecuteScript
Declaration
DataWarehouseScriptResult DataWarehouseExecuteScript(SQLConnection connection, string modelName, string scriptName, VariantDictionary parameters)
          Description
Runs the Data Warehouse script synchronously.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
connection | 
             Data Warehouse connection. | 
            
modelName | 
             Unique name of the model. | 
            
scriptName | 
             Name of the script. | 
            
parameters | 
             Dictionary with parameter names and values. | 
            
Return Value
Instance of DataWarehouseScriptResult.
DataWarehouseLoadQueryResultGetProgressMessage
Declaration
string DataWarehouseLoadQueryResultGetProgressMessage(DataWarehouseLoadQueryResult dataWarehouseLoadQueryResult)
          Description
Gets the progress message of the Data Warehouse load query.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
dataWarehouseLoadQueryResult | 
             Instance of DataWarehouseLoadQueryResult. | 
            
Return Value
Progress message.
DataWarehouseLoadQueryResultGetRunningTime
Declaration
int DataWarehouseLoadQueryResultGetRunningTime(DataWarehouseLoadQueryResult dataWarehouseLoadQueryResult)
          Description
Gets the running time of the Data Warehouse load query in seconds.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
dataWarehouseLoadQueryResult | 
             Instance of DataWarehouseLoadQueryResult. | 
            
Return Value
Instance of Timestamp representing the execution time.
DataWarehouseLoadQueryResultGetTotalRows
Declaration
int DataWarehouseLoadQueryResultGetTotalRows(DataWarehouseLoadQueryResult dataWarehouseLoadQueryResult)
          Description
Gets the number of rows affected by the Data Warehouse load query.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
dataWarehouseLoadQueryResult | 
             Instance of DataWarehouseLoadQueryResult. | 
            
Return Value
Number of rows.
DataWarehouseScriptResultGetRunningTime
Declaration
int DataWarehouseScriptResultGetRunningTime(DataWarehouseScriptResult dataWarehouseScriptResult)
          Description
Gets the running time of the Data Warehouse script in seconds.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
dataWarehouseScriptResult | 
             Instance of DataWarehouseScriptResult. | 
            
Return Value
Instance of Timestamp representing the execution time.
DataWarehouseStartLoadQuery
Declaration
string DataWarehouseStartLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName)
          Description
Starts a Data Warehouse load query asynchronously.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
connection | 
             Data Warehouse connection. | 
            
modelName | 
             Unique name of the model. | 
            
tableName | 
             Unique name of the table. | 
            
loadQueryName | 
             Unique name of the query. | 
            
Return Value
Identifier of asynchronously running job.
DataWarehouseStartLoadQuery
Declaration
string DataWarehouseStartLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName, VariantDictionary parameters)
          Description
Starts a Data Warehouse load query asynchronously.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
connection | 
             Data Warehouse connection. | 
            
modelName | 
             Unique name of the model. | 
            
tableName | 
             Unique name of the table. | 
            
loadQueryName | 
             Unique name of the query. | 
            
parameters | 
             Dictionary with parameter names and values. | 
            
Return Value
Identifier of asynchronously running job.
DataWarehouseStartLoadQuery
Declaration
string DataWarehouseStartLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName, bool dropData, VariantDictionary parameters)
          Description
Starts a Data Warehouse load query asynchronously.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
connection | 
             Data Warehouse connection. | 
            
modelName | 
             Unique name of the model. | 
            
tableName | 
             Unique name of the table. | 
            
loadQueryName | 
             Unique name of the query. | 
            
dropData | 
             Flag to drop data before query execution. | 
            
parameters | 
             Dictionary with parameter names and values. | 
            
Return Value
Identifier of asynchronously running job.
DataWarehouseStartScript
Declaration
string DataWarehouseStartScript(SQLConnection connection, string modelName, string scriptName)
          Description
Starts the Data Warehouse script asynchronously.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
connection | 
             Data Warehouse connection. | 
            
modelName | 
             Unique name of the model. | 
            
scriptName | 
             Name of the script. | 
            
Return Value
Identifier of asynchronously running job.
DataWarehouseStartScript
Declaration
string DataWarehouseStartScript(SQLConnection connection, string modelName, string scriptName, VariantDictionary parameters)
          Description
Starts the Data Warehouse script asynchronously.
Supported Runtime Versions
5.0
Parameters | 
             Description | 
            
|---|---|
connection | 
             Data Warehouse connection. | 
            
modelName | 
             Unique name of the model. | 
            
scriptName | 
             Name of the script. | 
            
parameters | 
             Dictionary with parameter names and values. | 
            
Return Value
Identifier of asynchronously running job.