> 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/sqlwrite.md).

# sqlWrite

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

*Update a record with parameters*

```javascript
   let rowsChanged = await brixxServerApi.sqlWrite("updateAddres", {
       newName: "John",
       addressId: 45,
   });
```

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://brixxbox.gitbook.io/brixxbox-documentation/server-api-reference/functions/sqlwrite.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.