sqlReadValue

Reads a single value from a standard sql statement. See SQL Statements for how to create statements.

Demo

Parameters

  1. statementName - The name of the standard statement

  2. additionalParameters - (optional) 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. columnName - (optional) the column name to pick from the first result line. If this is empty, the first column will be used

  4. 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, adrStreet from address where id=@id"

   let result = await brixxApi.sqlReadValue("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. The first column is adrName, so the value of adrName will be returned;
   console.log(result);
   let result = await brixxApi.sqlRead("readAddress", {id: 1}); // as above, but we overwrite the id from the app with a specific one
   console.log(result);
   let result = await brixxApi.sqlRead("readAddress", {id: 1}, "adrStreet"); // as above, but we overwrite the id from the app with a specific one and take "adrStreet" instead of the first column "adrName"
   console.log(result);
   let result = await brixxApi.sqlRead("readAddress", {id: 1}, "adrStreet", {timeout: 45}); // as above, but with 45 seconds timeout
   console.log(result);

Last updated