Skip to content

Commit dc1040c

Browse files
committed
Small README improvment
1 parent 1fcca9a commit dc1040c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PSQLPy - Async PostgreSQL driver for Python written in Rust.
22

3-
Driver for PostgreSQL written fully in Rust and exposed to Python.
4-
The project is under active development and **we cannot confirm that it's ready for production**. Anyway, We will be grateful for the bugs found and open issues. Stay tuned.
3+
Driver for PostgreSQL written fully in Rust and exposed to Python.
4+
The project is under active development and _**we cannot confirm that it's ready for production**_. Anyway, We will be grateful for the bugs found and open issues. Stay tuned.
55
*Normal documentation is in development.*
66

77
## Installation
@@ -23,7 +23,7 @@ Or you can build it by yourself. To do it, install stable rust and [maturin](htt
2323
```
2424

2525
## Usage
26-
Usage is as easy as possible.
26+
Usage is as easy as possible.
2727
Create new instance of PSQLPool, startup it and start querying.
2828
```python
2929
from typing import Any
@@ -52,11 +52,11 @@ async def main() -> None:
5252
# rust does it instead.
5353

5454
```
55-
Please take into account that each new execute gets new connection from connection pool.
55+
Please take into account that each new execute gets new connection from connection pool.
5656

5757
## Query parameters
58-
You can pass parameters into queries.
59-
Parameters can be passed in any `execute` method as the second parameter, it must be a list.
58+
You can pass parameters into queries.
59+
Parameters can be passed in any `execute` method as the second parameter, it must be a list.
6060
Any placeholder must be marked with `$< num>`.
6161

6262
```python
@@ -98,7 +98,7 @@ async def main() -> None:
9898
```
9999

100100
## Transactions
101-
Of course it's possible to use transactions with this driver.
101+
Of course it's possible to use transactions with this driver.
102102
It's as easy as possible and sometimes it copies common functionality from PsycoPG and AsyncPG.
103103

104104
### Transaction parameters
@@ -153,7 +153,7 @@ async def main() -> None:
153153
"INSERT INTO users VALUES ($1)",
154154
["Some data"],
155155
)
156-
# You must commit the transaction by your own
156+
# You must commit the transaction by your own
157157
# or your changes will be vanished.
158158
await transaction.commit()
159159

@@ -163,8 +163,8 @@ async def main() -> None:
163163
```
164164

165165
### Transactions can be rolled back
166-
You must understand that rollback can be executed only once per transaction.
167-
After it's execution transaction state changes to `done`.
166+
You must understand that rollback can be executed only once per transaction.
167+
After it's execution transaction state changes to `done`.
168168
If you want to use `ROLLBACK TO SAVEPOINT`, see below.
169169
```python
170170
from typing import Any
@@ -293,10 +293,10 @@ async def main() -> None:
293293
# Or you can use it as an async iterator.
294294
async for fetched_result in cursor:
295295
print(fetched_result.result())
296-
296+
297297
# If you want to close cursor, please do it manually.
298298
await cursor.close()
299-
299+
300300
await transaction.commit()
301301
```
302302

@@ -317,7 +317,7 @@ Available cursor operations:
317317
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.
318318

319319
| Extra Type in Python | Type in PostgreSQL | Type in Rust |
320-
| ------------- | ------------- | -------------
320+
| ------------- | ------------- | -------------
321321
| SmallInt | SmallInt | i16 |
322322
| Integer | Integer | i32 |
323323
| BigInt | BigInt | i64 |

0 commit comments

Comments
 (0)