executeStoredProcedure

Executes a stored procedure.

Parameters

  1. procedureName - The name of the stored procedure

  2. procedure parameters - If you need to add 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

1. Simple (pay attention to the await keyword)

   await brixxApi.executeStoredProcedure("procedureName");

2. With parameters (pay attention to the await keyword)

   let parameterJson = {
      myCustomSqlParameter: 12345
   };
   await brixxApi.executeStoredProcedure("procedureName", parameterJson);

3. Short version (pay attention to the await keyword)

   await brixxApi.executeStoredProcedure("procedureName", {
      myCustomSqlParameter: 12345
   });

4. With Timeout

   await brixxApi.executeStoredProcedure("procedureName", {
      myCustomSqlParameter: 12345
   },{
      timeout: 45
   });

Last updated