> 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/client-api-reference/functions/sqlreadvalue.md).

# sqlReadValue

### Demo

{% embed url="<https://youtu.be/vs3uR5BRPKU>" %}

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

```javascript
   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);
```

```javascript
   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);
```

```javascript
   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);
```

```javascript
   let result = await brixxApi.sqlRead("readAddress", {id: 1}, "adrStreet", {timeout: 45}); // as above, but with 45 seconds timeout
   console.log(result);
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://brixxbox.gitbook.io/brixxbox-documentation/client-api-reference/functions/sqlreadvalue.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.