> For the complete documentation index, see [llms.txt](https://brixxbox.gitbook.io/brixxbox-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://brixxbox.gitbook.io/brixxbox-documentation/server-api-reference/functions/sqlread.md).

# sqlRead

Executes a write sql statement and returns the number of rows affected

### 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

*Read all data without parameters*

```javascript
   let rowsChanged = await brixxServerApi.sqlRead("getAddresses", {}, {timeout: 90});
```

*Read all data with parameters*

```javascript
   let rowsChanged = await brixxServerApi.sqlRead("getAddresses", { adrType: 1});
```

See also client side api [sqlRead](/brixxbox-documentation/client-api-reference/functions/sqlread.md)
