Skip to content

Commit 29684fe

Browse files
committed
Added more info in README.
1 parent 9ac5b58 commit 29684fe

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,17 @@ async def main() -> None:
299299
await transaction.commit()
300300
```
301301

302+
### Cursor operations
303+
Available cursor operations:
304+
- FETCH count - `cursor.fetch(fetch_number=...)`
305+
- FETCH NEXT - `cursor.fetch_next()`
306+
- FETCH PRIOR - `cursor.fetch_prior()`
307+
- FETCH FIRST - `cursor.fetch_first()`
308+
- FETCH LAST - `cursor.fetch_last()`
309+
- FETCH ABSOLUTE - `cursor.fetch_absolute(absolute_number=)`
310+
- FETCH RELATIVE - `cursor.fetch_relative(relative_number=)`
311+
- FETCH FORWARD ALL - `cursor.fetch_forward_all()`
312+
302313
## Extra Types
303314
Sometimes it's impossible to identify which type user tries to pass as a argument. But Rust is a strongly typed programming language so we have to help.
304315

python/psqlpy/_internal/__init__.pyi

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ class Cursor:
7676
) -> QueryResult:
7777
"""Fetch first row.
7878
79-
Execute FETCH FIRST.
79+
Execute FETCH FIRST
8080
8181
### Returns:
8282
result as `QueryResult`.
@@ -87,24 +87,12 @@ class Cursor:
8787
) -> QueryResult:
8888
"""Fetch last row.
8989
90-
Execute FETCH LAST.
90+
Execute FETCH LAST
9191
9292
### Returns:
9393
result as `QueryResult`.
9494
"""
9595

96-
async def fetch_absolute(
97-
self: Self,
98-
absolute_number: int,
99-
) -> QueryResult:
100-
"""Fetch absolute rows.
101-
102-
Execute FETCH ABSOLUTE <absolute_number>.
103-
104-
### Returns:
105-
result as `QueryResult`.
106-
"""
107-
10896
async def fetch_absolute(
10997
self: Self,
11098
absolute_number: int,

0 commit comments

Comments
 (0)