> For the complete documentation index, see [llms.txt](https://wirebox.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wirebox.ortusbooks.com/6/advanced-topics/wirebox-object-populator/populatefromquerywithprefix.md).

# populateFromQueryWithPrefix

Populates an Object using only specific columns from a query. Useful for performing a query with joins that needs to populate multiple objects.

## Returns

* This function returns any

## Arguments

The structure to populate the object with.

| Key                  | Type    | Required | Default | Description                                                                                                                                                                                                                                                                 |
| -------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| target               | any     | Yes      | ---     | This can be an instantiated bean object or a bean instantiation path as a string. If you pass an instantiation path and the bean has an 'init' method. It will be executed. This method follows the bean contract (set{property\_name}). Example: setUsername(), setfname() |
| qry                  | query   | yes      | ---     | The query to populate the bean object with                                                                                                                                                                                                                                  |
| rowNumber            | Numeric | No       | 1       | The query row number to use for population                                                                                                                                                                                                                                  |
| scope                | string  | No       |         | Use scope injection instead of setters population. Ex: scope=variables.instance.                                                                                                                                                                                            |
| trustedSetter        | boolean | No       | false   | If set to true, the setter method will be called even if it does not exist in the bean                                                                                                                                                                                      |
| include              | string  | No       |         | A list of keys to include in the population                                                                                                                                                                                                                                 |
| exclude              | string  | No       |         | A list of keys to exclude in the population                                                                                                                                                                                                                                 |
| prefix               | string  | Yes      | ---     | The prefix used to filter, Example: 'user\_' would apply to the following columns: 'user\_id' and 'user\_name' but not 'address\_id'.                                                                                                                                       |
| ignoreEmpty          | boolean | No       | false   | Ignore empty values on populations, great for ORM population                                                                                                                                                                                                                |
| nullEmptyInclude     | string  | No       |         | A list of keys to NULL when empty                                                                                                                                                                                                                                           |
| nullEmptyExclude     | string  | No       |         | A list of keys to NOT NULL when empty                                                                                                                                                                                                                                       |
| composeRelationships | boolean | No       | false   | Automatically attempt to compose relationships from memento                                                                                                                                                                                                                 |


---

# 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://wirebox.ortusbooks.com/6/advanced-topics/wirebox-object-populator/populatefromquerywithprefix.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.
