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

# sqlRead

### Demo

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

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

Lets assume, we have a standard statement "select adrName from address where id=@id"

```javascript
   let result = await brixxApi.sqlRead("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
   console.log(result[0].adrName);
```

```javascript
   let result = await brixxApi.sqlRead("readAddress", {id: 1}); //this will use the statement "readAddress". The @id parameter is set to 1
   console.log(result[0].adrName);
```

```javascript
   let result = await brixxApi.sqlRead("readAddress", {id: 1}, {timeout: 60}); // Wait for 60 seconds
   console.log(result[0].adrName);
```

```javascript
   let result = await brixxApi.sqlRead("readAddress", null, {timeout: 60}); //use a timeout but without script parameters
   console.log(result[0].adrName);
```


---

# 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/sqlread.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.