Skip to content

Commit a52414a

Browse files
committed
feat docs: update build options and task queue info
Tests: протестировано CI, на прод не влияет commit_hash:e974718d722715a649e158fc528656c43bdeea35
1 parent 551873a commit a52414a

File tree

8 files changed

+30
-7
lines changed

8 files changed

+30
-7
lines changed

.mapping.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4491,6 +4491,7 @@
44914491
"scripts/docs/en/userver/mysql/design_and_details.md":"taxi/uservices/userver/scripts/docs/en/userver/mysql/design_and_details.md",
44924492
"scripts/docs/en/userver/mysql/mysql_driver.md":"taxi/uservices/userver/scripts/docs/en/userver/mysql/mysql_driver.md",
44934493
"scripts/docs/en/userver/mysql/supported_types.md":"taxi/uservices/userver/scripts/docs/en/userver/mysql/supported_types.md",
4494+
"scripts/docs/en/userver/odbc.md":"taxi/uservices/userver/scripts/docs/en/userver/odbc.md",
44944495
"scripts/docs/en/userver/os_signals.md":"taxi/uservices/userver/scripts/docs/en/userver/os_signals.md",
44954496
"scripts/docs/en/userver/periodics.md":"taxi/uservices/userver/scripts/docs/en/userver/periodics.md",
44964497
"scripts/docs/en/userver/pg_connlimit_mode_auto.md":"taxi/uservices/userver/scripts/docs/en/userver/pg_connlimit_mode_auto.md",

core/include/userver/components/manager_controller_component.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class Manager;
6262
/// worker_threads | threads count for the task processor | -
6363
/// os-scheduling | OS scheduling mode for the task processor threads. 'idle' sets the lowest priority. 'low-priority' sets the priority below 'normal' but higher than 'idle'. | normal
6464
/// spinning-iterations | tunes the number of spin-wait iterations in case of an empty task queue before threads go to sleep | 1000
65-
/// task-processor-queue | Task queue mode for the task processor. `global-task-queue` default task queue. `work-stealing-task-queue` experimental with potentially better scalability than `global-task-queue`. | global-task-queue
65+
/// task-processor-queue | Task queue mode for the task processor. `global-task-queue` default task queue. `work-stealing-task-queue` experimental with potentially better scalability than `global-task-queue`. 'pull-pin-task-queue' - experimental queue where each task gets pinned to a thread-specific queue and is executed only in that thread. See also @ref engine::TaskQueueType | global-task-queue
6666
/// task-trace | optional dictionary of tracing options | empty (disabled)
6767
/// task-trace.every | set N to trace each Nth task | 1000
6868
/// task-trace.max-context-switch-count | set upper limit of context switches to trace for a single task | 1000

scripts/docs/en/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,10 @@ and make sure that it builds and passes tests.
177177
* @ref scripts/docs/en/userver/sqlite/design_and_details.md
178178

179179

180+
## ODBC
181+
* @ref scripts/docs/en/userver/odbc.md
182+
183+
180184
## Non relational databases
181185
* @ref scripts/docs/en/userver/mongodb.md
182186
* @ref scripts/docs/en/userver/redis.md

scripts/docs/en/userver/build/options.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ userver is split into multiple CMake libraries.
2626
| `userver::rabbitmq` | `USERVER_FEATURE_RABBITMQ` | `rabbitmq` | @ref rabbitmq_driver |
2727
| `userver::mysql` | `USERVER_FEATURE_MYSQL` | `mysql` | @ref scripts/docs/en/userver/mysql/mysql_driver.md |
2828
| `userver::rocks` | `USERVER_FEATURE_ROCKS` | `rocks` | TODO |
29+
| `userver::sqlite` | `USERVER_FEATURE_SQLITE` | `sqlite` | @ref scripts/docs/en/userver/sqlite/sqlite_driver.md |
30+
| `userver::odbc` | `USERVER_FEATURE_ODBC` | `odbc` | @ref scripts/docs/en/userver/odbc.md |
2931
| `userver::ydb` | `USERVER_FEATURE_YDB` | `ydb` | @ref scripts/docs/en/userver/ydb.md |
3032
| `userver::otlp` | `USERVER_FEATURE_OTLP` | `otlp` | @ref opentelemetry "OpenTelemetry Protocol" |
3133
| `userver::s3api` | `USERVER_FEATURE_S3API` | `s3api` | @ref scripts/docs/en/userver/libraries/s3api.md |
@@ -78,6 +80,8 @@ The exact format of setting cmake options varies depending on the method of buil
7880
| `USERVER_FEATURE_RABBITMQ` | Provide asynchronous driver for RabbitMQ (AMQP 0-9-1) | `${USERVER_BUILD_ALL_COMPONENTS}` |
7981
| `USERVER_FEATURE_MYSQL` | Provide asynchronous driver for MySQL/MariaDB | `${USERVER_BUILD_ALL_COMPONENTS}` |
8082
| `USERVER_FEATURE_ROCKS` | Provide asynchronous driver for RocksDB | `${USERVER_BUILD_ALL_COMPONENTS}` |
83+
| `USERVER_FEATURE_SQLITE` | Provide asynchronous driver for SQLite | `${USERVER_BUILD_ALL_COMPONENTS}` |
84+
| `USERVER_FEATURE_ODBC` | Provide asynchronous driver for ODBC | `${USERVER_BUILD_ALL_COMPONENTS}` |
8185
| `USERVER_FEATURE_YDB` | Provide asynchronous driver for YDB | `${USERVER_BUILD_ALL_COMPONENTS}` AND C++ standard >= 20 |
8286
| `USERVER_FEATURE_OTLP` | Provide Logger for OpenTelemetry protocol | `${USERVER_BUILD_ALL_COMPONENTS}` |
8387
| `USERVER_FEATURE_GRPC_REFLECTION` | Provide reflection service for gRPC | `${USERVER_BUILD_ALL_COMPONENTS}` |
@@ -188,7 +192,10 @@ The exact format of setting cmake options varies depending on the method of buil
188192
| `USERVER_CONAN` | Build userver using Conan packages | `ON` if build is launched from Conan, `OFF` otherwise |
189193
| `USERVER_CHAOTIC_FORMAT` | Whether to format generated code if FORMAT option is missing | `ON` |
190194

191-
@warning Using LTO can lead to [some problems](https://github.com/userver-framework/userver/issues/242). We don't recommend using `USERVER_LTO`.
195+
@warning Using LTO can lead to [some problems](https://github.com/userver-framework/userver/issues/242). We don't
196+
recommend using `USERVER_LTO` or consider using thread pinning schedulers (see @ref engine::TaskQueueType
197+
for a list of queues and `task-processor-queue` static config option of
198+
@ref components::ManagerControllerComponent for a ways to choose a queue).
192199

193200
[tsan]: https://github.com/userver-framework/userver/blob/develop/cmake/tsan.suppressions.txt
194201

scripts/docs/en/userver/mongodb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,5 +127,5 @@ the service, then something is wrong with the database. Service or database main
127127
----------
128128

129129
@htmlonly <div class="bottom-nav"> @endhtmlonly
130-
@ref scripts/docs/en/userver/sqlite/design_and_details.md | @ref scripts/docs/en/userver/redis.md ⇨
130+
@ref scripts/docs/en/userver/odbc.md | @ref scripts/docs/en/userver/redis.md ⇨
131131
@htmlonly </div> @endhtmlonly

scripts/docs/en/userver/odbc.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## ODBC Driver
2+
3+
🐙 **userver** provides generic asynchronous driver for SQL-like databases via ODBC. The driver is in early
4+
development stage and can only execute simple querries.
5+
6+
7+
----------
8+
9+
@htmlonly <div class="bottom-nav"> @endhtmlonly
10+
@ref scripts/docs/en/userver/sqlite/design_and_details.md | @ref scripts/docs/en/userver/mongodb.md ⇨
11+
@htmlonly </div> @endhtmlonly

scripts/docs/en/userver/roadmap_and_changelog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,17 +50,17 @@ Changelog news also go to the
5050
* Added @ref utils::TaskBuilder
5151
*@ref scripts/docs/en/userver/libraries/s3api.md now has @ref QUALITY_TIERS "Platinum Tier".
5252
* Kafka is now more accurate in computing message time spent in @ref kafka::ConsumerComponent queue.
53-
* @ref utils::statistics::RecentPeriod is does not lose precision under heavy contention.
53+
* @ref utils::statistics::RecentPeriod now does not lose precision under heavy contention.
5454
* Added functionality to @ref scripts/docs/en/userver/dump_coroutines.md
5555
* Added DeadlockDetector that can be enabled via `coro_pool.deadlock_detector` option
5656
in @ref components::ManagerControllerComponent.
5757
* Added @ref storages::mongo::Transaction
5858
* Added @ref server::middlewares::Cors
5959
* Added @ref utils::FromStringNoThrow
60-
* Fixed unnecessary lock in TaskContext desctructor when there are no plugins. Many thanks to
60+
* Fixed unnecessary lock in TaskContext destructor when there are no plugins. Many thanks to
6161
[Ivan Trofimov](https://github.com/itrofimow) for the PR
6262
* @ref formats::yaml::Value now checks for key uniqueness in mappings.
63-
* @ref scripts/docs/en/userver/gdb_debugging.md "Stack monitor usage" is not automatically disabled under GDB.
63+
* @ref scripts/docs/en/userver/gdb_debugging.md "Stack monitor usage" is now automatically disabled under GDB.
6464
* Disabled phdr cache if ASAN is enabled. Many thanks to
6565
[Yury Bogomolov](https://github.com/ybogo) for the PR
6666
* Allowed using mapped enums in @ref storages::postgres::ParameterStore. Many thanks to Aleksey Popov for the patch and

scripts/docs/en/userver/sqlite/design_and_details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,5 +126,5 @@ transaction.Rollback();
126126
----------
127127

128128
@htmlonly <div class="bottom-nav"> @endhtmlonly
129-
@ref scripts/docs/en/userver/sqlite/supported_types.md | @ref scripts/docs/en/userver/mongodb.md ⇨
129+
@ref scripts/docs/en/userver/sqlite/supported_types.md | @ref scripts/docs/en/userver/odbc.md ⇨
130130
@htmlonly </div> @endhtmlonly

0 commit comments

Comments
 (0)