Skip to content

Added new as_tuple parameter to QueryResult #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jul 16, 2025
Merged

Added new as_tuple parameter to QueryResult #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ee26552
Added new as_tuple parameter to QueryResult
chandr-andr Jun 30, 2025
20247b5
change result
bymoye Jul 1, 2025
8cc74de
more optimizations
bymoye Jul 1, 2025
e799526
fix typing hint
bymoye Jul 1, 2025
8ed0724
more optimizations
bymoye Jul 2, 2025
ba63201
refactor execute_many for better performance
bymoye Jul 2, 2025
d48163a
more optimizations
bymoye Jul 2, 2025
5bf59e2
fix clippy warning
bymoye Jul 3, 2025
a2b8e2f
Merge pull request #148 from bymoye/result-as-tuple
chandr-andr Jul 11, 2025
fc67e74
Merge branch 'main' into result-as-tuple
chandr-andr Jul 11, 2025
c6335fe
Added performance improvement
chandr-andr Jul 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions docs/components/results.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ Currently there are two results:
### Result

#### Parameters

- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)
- `as_tuple`: Headless tuple output

Get the result as a list of dicts

Expand All @@ -27,12 +29,19 @@ async def main() -> None:
[],
)

result: List[Dict[str, Any]] = query_result.result()
# Result as dict
list_dict_result: List[Dict[str, Any]] = query_result.result()

# Result as tuple
list_tuple_result: List[Tuple[t.Any, ...]] = query_result.result(
as_tuple=True,
)
```

### As class

#### Parameters

- `as_class`: Custom class from Python.
- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)

Expand Down Expand Up @@ -61,6 +70,7 @@ async def main() -> None:
### Row Factory

#### Parameters

- `row_factory`: custom callable object.
- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)

Expand All @@ -71,7 +81,9 @@ async def main() -> None:
### Result

#### Parameters

- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)
- `as_tuple`: Headless tuple output

Get the result as a dict

Expand All @@ -84,12 +96,19 @@ async def main() -> None:
[100],
)

result: Dict[str, Any] = query_result.result()
# Result as dict
dict_result: Dict[str, Any] = query_result.result()

# Result as tuple
tuple_result: Tuple[typing.Any, ...] = query_result.result(
as_tuple=True,
)
```

### As class

#### Parameters

- `as_class`: Custom class from Python.
- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)

Expand Down Expand Up @@ -117,6 +136,7 @@ async def main() -> None:
### Row Factory

#### Parameters

- `row_factory`: custom callable object.
- `custom_decoders`: custom decoders for unsupported types. [Read more](/usage/types/advanced_type_usage.md)

Expand Down
Loading
Loading