Skip to content

Commit 3b714ae

Browse files
authored
docs: add list of third-party result backends and brokers (#499)
1 parent 34e280a commit 3b714ae

File tree

2 files changed

+77
-5
lines changed

2 files changed

+77
-5
lines changed

docs/available-components/brokers.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ await my_task.kicker().with_broker(broker).kiq()
8282

8383
## Custom brokers
8484

85-
These brokers are not parts of the core taskiq lib. You can install them as a separate packages.
85+
These brokers are not parts of the core Taskiq lib. But they are maintained by Taskiq developers.
86+
You can install them as a separate packages.
8687

8788
You can read more about parameters and abilities of these brokers in README.md of each repo.
8889

@@ -110,3 +111,33 @@ Project link: [taskiq-nats](https://github.com/taskiq-python/taskiq-nats).
110111
```bash
111112
pip install taskiq-nats
112113
```
114+
115+
## Third-party brokers
116+
117+
These brokers are not part of the core Taskiq library. They are maintained by other open‑source contributors. You can install them as a separate packages.
118+
119+
You can read more about parameters and abilities of these brokers in README.md of each repo.
120+
121+
### PostgreSQL broker
122+
123+
Project link: [taskiq-postgresql](https://github.com/z22092/taskiq-postgresql).
124+
125+
```bash
126+
pip install taskiq-postgresql
127+
```
128+
129+
### SQS broker
130+
131+
Project link: [taskiq-aio-sqs](https://github.com/vonsteer/taskiq-aio-sqs).
132+
133+
```bash
134+
pip install taskiq-aio-sqs
135+
```
136+
137+
### YDB broker
138+
139+
Project link: [taskiq-ydb](https://github.com/danfimov/taskiq-ydb).
140+
141+
```bash
142+
pip install taskiq-ydb
143+
```

docs/available-components/result-backends.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,60 @@ This includes:
1010
- return value;
1111
- Execution time in seconds.
1212

13-
## DummyResultBackend
13+
## Built-in result backends
14+
15+
### DummyResultBackend
1416

1517
This result backend doesn't do anything. It doesn't store results and cannot be used in cases,
1618
where you need actual results.
1719

1820
This broker will always return `None` for any return_value. Please be careful.
1921

20-
## Redis result backend
2122

22-
This result backend is not part of the core taskiq library. You can install it as a separate package [taskiq-redis](https://pypi.org/project/taskiq-redis/).
23+
## Official result backends
24+
25+
This result backends is not part of the core Taskiq library. But they are maintained by Taskiq developers. You can install them as a separate package.
26+
27+
### Redis result backend
28+
29+
Project link: [taskiq-redis](https://pypi.org/project/taskiq-redis/).
2330

2431
```bash
2532
pip install taskiq-redis
2633
```
2734

28-
You can read more about parameters and abilities of this broker in [README.md](https://github.com/taskiq-python/taskiq-redis).
35+
### NATS result backend
36+
37+
Project link: [taskiq-nats](https://github.com/taskiq-python/taskiq-nats).
38+
39+
```bash
40+
pip install taskiq-nats
41+
```
42+
43+
## Third-party result backends
44+
45+
These result backends are not part of the core Taskiq library. They are maintained by other open‑source contributors. You can install them as a separate packages.
46+
47+
### PostgreSQL result backend
48+
49+
Project link: [taskiq-postgresql](https://github.com/z22092/taskiq-postgresql).
50+
51+
```bash
52+
pip install taskiq-postgresql
53+
```
54+
55+
### S3 result backend
56+
57+
Project link: [taskiq-aio-sqs](https://github.com/vonsteer/taskiq-aio-sqs).
58+
59+
```bash
60+
pip install taskiq-aio-sqs
61+
```
62+
63+
### YDB result backend
64+
65+
Project link: [taskiq-ydb](https://github.com/danfimov/taskiq-ydb).
66+
67+
```bash
68+
pip install taskiq-ydb
69+
```

0 commit comments

Comments
 (0)