Skip to content

change result and more optimizations #148

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.

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

Open
wants to merge 5 commits into
base: result-as-tuple
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 10 additions & 4 deletions docs/components/results.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +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`: return result as a tuple instead of dict.
- `as_tuple`: Headless tuple output

Get the result as a list of dicts

Expand All @@ -32,14 +33,15 @@ async def main() -> None:
list_dict_result: List[Dict[str, Any]] = query_result.result()

# Result as tuple
list_tuple_result: List[Tuple[Tuple[str, typing.Any], ...]] = query_result.result(
list_tuple_result: List[Tuple[str, 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 @@ -68,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 @@ -78,8 +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`: return result as a tuple instead of dict.
- `as_tuple`: Headless tuple output

Get the result as a dict

Expand All @@ -96,14 +100,15 @@ async def main() -> None:
dict_result: Dict[str, Any] = query_result.result()

# Result as tuple
tuple_result: Tuple[Tuple[str, typing.Any], ...] = query_result.result(
tuple_result: Tuple[str, 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 @@ -131,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