sqlRead

Reads data from a Standard Sql Statement. See SQL Statements for how to create statements.

Demo

Parameters

  1. statementName - The name of the statement

  2. additionalParameters - all controls in the current config are set as paramters automatically. If you need to add additional parameters, you can use this json object to set them

  3. queryOptions - (optional) a json object with options for the request

    • timeout - (optional) timeout for the SQL request. Default is 30 seconds

    • connectionKey - (optional) a key to a custom settings entry with the connection string to an external MSSQL database

Example Usages

Lets assume, we have a standard statement "select adrName from address where id=@id"

   let result = await brixxApi.sqlRead("readAddress"); //this will use the statement "readAddress". The @id parameter is set to the id of the current loaded record in the app where we use this function
   console.log(result[0].adrName);
   let result = await brixxApi.sqlRead("readAddress", {id: 1}); //this will use the statement "readAddress". The @id parameter is set to 1
   console.log(result[0].adrName);
   let result = await brixxApi.sqlRead("readAddress", {id: 1}, {timeout: 60}); // Wait for 60 seconds
   console.log(result[0].adrName);
   let result = await brixxApi.sqlRead("readAddress", null, {timeout: 60}); //use a timeout but without script parameters
   console.log(result[0].adrName);

Last updated