Lakehouse functions

LakehouseExecuteLoadQuery

Declaration

LakehouseLoadQueryResult LakehouseExecuteLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName)

Description

Runs a Lakehouse load query synchronously.

Supported Runtime Versions

5.0

Parameters	Description
connection	Lakehouse connection.
modelName	Unique name of the model.
tableName	Unique name of the table.
loadQueryName	Unique name of the query.

Return Value

Instance of LakehouseLoadQueryResult.

LakehouseExecuteLoadQuery

Declaration

LakehouseLoadQueryResult LakehouseExecuteLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName, VariantDictionary parameters)

Description

Runs a Lakehouse load query synchronously.

Supported Runtime Versions

5.0

Parameters	Description
connection	Lakehouse 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 LakehouseLoadQueryResult.

LakehouseExecuteLoadQuery

Declaration

LakehouseLoadQueryResult LakehouseExecuteLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName, bool dropData, VariantDictionary parameters)

Description

Runs a Lakehouse load query synchronously.

Supported Runtime Versions

5.0

Parameters	Description
connection	Lakehouse 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 LakehouseLoadQueryResult.

LakehouseExecuteScript

Declaration

LakehouseScriptResult LakehouseExecuteScript(SQLConnection connection, string modelName, string scriptName)

Description

Runs the Lakehouse script synchronously.

Supported Runtime Versions

5.0

Parameters	Description
connection	Lakehouse connection.
modelName	Unique name of the model.
scriptName	Name of the script.

Return Value

Instance of LakehouseScriptResult.

LakehouseExecuteScript

Declaration

LakehouseScriptResult LakehouseExecuteScript(SQLConnection connection, string modelName, string scriptName, VariantDictionary parameters)

Description

Runs the Lakehouse script synchronously.

Supported Runtime Versions

5.0

Parameters	Description
connection	Lakehouse connection.
modelName	Unique name of the model.
scriptName	Name of the script.
parameters	Dictionary with parameter names and values.

Return Value

Instance of LakehouseScriptResult.

LakehouseLoadQueryResultGetProgressMessage

Declaration

string LakehouseLoadQueryResultGetProgressMessage(LakehouseLoadQueryResult lakehouseLoadQueryResult)

Description

Gets the progress message of the Lakehouse load query.

Supported Runtime Versions

5.0

Parameters	Description
lakehouseLoadQueryResult	Instance of LakehouseLoadQueryResult.

Return Value

Progress message.

LakehouseLoadQueryResultGetRunningTime

Declaration

int LakehouseLoadQueryResultGetRunningTime(LakehouseLoadQueryResult lakehouseLoadQueryResult)

Description

Gets the running time of the Lakehouse load query in seconds.

Supported Runtime Versions

5.0

Parameters	Description
lakehouseLoadQueryResult	Instance of LakehouseLoadQueryResult.

Return Value

Instance of Timestamp representing the execution time.

LakehouseLoadQueryResultGetTotalRows

Declaration

int LakehouseLoadQueryResultGetTotalRows(LakehouseLoadQueryResult lakehouseLoadQueryResult)

Description

Gets the number of rows affected by the Lakehouse load query.

Supported Runtime Versions

5.0

Parameters	Description
lakehouseLoadQueryResult	Instance of LakehouseLoadQueryResult.

Return Value

Number of rows.

LakehouseScriptResultGetRunningTime

Declaration

int LakehouseScriptResultGetRunningTime(LakehouseScriptResult lakehouseScriptResult)

Description

Gets the running time of the Lakehouse script in seconds.

Supported Runtime Versions

5.0

Parameters	Description
lakehouseScriptResult	Instance of LakehouseScriptResult.

Return Value

Instance of Timestamp representing the execution time.

LakehouseStartLoadQuery

Declaration

string LakehouseStartLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName)

Description

Starts a Lakehouse load query asynchronously.

Supported Runtime Versions

5.0

Parameters	Description
connection	Lakehouse 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.

LakehouseStartLoadQuery

Declaration

string LakehouseStartLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName, VariantDictionary parameters)

Description

Starts a Lakehouse load query asynchronously.

Supported Runtime Versions

5.0

Parameters	Description
connection	Lakehouse 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.

LakehouseStartLoadQuery

Declaration

string LakehouseStartLoadQuery(SQLConnection connection, string modelName, string tableName, string loadQueryName, bool dropData, VariantDictionary parameters)

Description

Starts a Lakehouse load query asynchronously.

Supported Runtime Versions

5.0

Parameters	Description
connection	Lakehouse 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.

LakehouseStartScript

Declaration

string LakehouseStartScript(SQLConnection connection, string modelName, string scriptName)

Description

Starts the Lakehouse script asynchronously.

Supported Runtime Versions

5.0

Parameters	Description
connection	Lakehouse connection.
modelName	Unique name of the model.
scriptName	Name of the script.

Return Value

Identifier of asynchronously running job.

LakehouseStartScript

Declaration

string LakehouseStartScript(SQLConnection connection, string modelName, string scriptName, VariantDictionary parameters)

Description

Starts the Lakehouse script asynchronously.

Supported Runtime Versions

5.0

Parameters	Description
connection	Lakehouse 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.