feat docs: update changelog and fix some typos

apolukhin · apolukhin · commit bc9620c2237f · 2025-06-03T11:37:42.000+03:00
Tests: протестировано CI
commit_hash:1ac5587383679329ba236f4f7ea7b9b47e9f1730
diff --git a/odbc/README.md b/odbc/README.md
@@ -1 +1,3 @@
 # userver: ODBC Driver Wrapper [WIP]
+
+Under heavy development. Come back later
diff --git a/scripts/docs/en/userver/gdb_debugging.md b/scripts/docs/en/userver/gdb_debugging.md
@@ -1,12 +1,16 @@
 # Debugging with GDB
 
-In the most cases writing extensive logs and running profilers is sufficient for debugging. But in the most complex cases it may be useful to do interactive debugging with GDB. Additionally, GDB is the only option for debugging coredumps. Userver provides the capability to perform such debugging.
+In the most cases writing extensive logs and running profilers is sufficient for debugging. But in the most complex
+cases it may be useful to do interactive debugging with GDB. Additionally, GDB is the only option for debugging
+coredumps. 🐙 userver provides the capability to perform such debugging.
+
+First of all, you can use GDB on your service based on userver just like any other binary (debug symbols are included
+by default in all build types).
 
-First of all, you can use GDB on your service based on Userver just like any other binary (debug symbols are included by default in all build types).
 
 ## Userver-specific debug features
 
-To use Userver-specific debug features, you need to allow execution of debug scripts, linked into your binary.
+To use userver-specific debug features, you need to allow execution of debug scripts, linked into your binary.
 It can be done by adding the following line to your ~/.gdbinit file
 ```
 add-auto-load-safe-path <path-to-your-binary>
@@ -17,9 +21,11 @@ add-auto-load-safe-path /
 ```
 See [GDB manual](https://www.sourceware.org/gdb/current/onlinedocs/gdb.html/Auto_002dloading-safe-path.html) for more details.
 
+
 ### Custom pretty-printers
 
-The simplest extentions for GDB, that Userver provides, are pretty-printers for certain data stuctures. Below is an example comparing the output for a `formats::json::Value` with and without pretty-printers:
+The simplest extentions for GDB, that userver provides, are pretty-printers for certain data stuctures. Below is an
+example comparing the output for a `formats::json::Value` with and without pretty-printers:
 
 ```
 (gdb) print value
@@ -39,9 +45,12 @@ $2 = {holder_ = {static kInvalidVersion = 18446744073709551615, data_ = {__ptr_
 
 In addition, the output has a hierarchical structure that is displayed correctly when debugging from the IDE.
 
+
 ### Coroutines exploration
 
-Userver provides GDB command `utask`, which mimics `thread` command and allows you to explore all coroutines (Userver Tasks), including running and suspended ones, in a manner similar to threads.
+🐙 userver provides GDB command `utask`, which mimics `thread` command and allows you to explore all coroutines
+(userver tasks), including running and suspended ones, in a manner similar to threads.
+
 
 #### Commands
 
@@ -57,7 +66,10 @@ Task           State     Span
 0x10f27fc42000 Running   task_4
 ```
 
-* `utask apply <task> <cmd...>`: Executes `<cmd...>` in the context of selected `<task>`. The `<task>` may be specified by its ID ("Task") or name ("Span") (as shown in `utask list`), or set to "all" to apply the command to all tasks. `<cmd...>` can be any GDB command, including Python scripts.
+* `utask apply <task> <cmd...>`: Executes `<cmd...>` in the context of selected `<task>`. The `<task>` may be 
+specified by its ID ("Task") or name ("Span") (as shown in `utask list`), or set to "all" to apply the command to all
+ tasks. `<cmd...>` can be any GDB command, including Python scripts.
+
 
 #### Examples:
     
@@ -108,6 +120,15 @@ For now `utask` commands are implemented for only linux x86 platforms, but can b
 
 In addition, all of the above functionality works for debugging both a live process and coredumps.
 
+
 ## Adding new pretty-printers and commands
 
-If you need a new pretty-printer or a GDB command, you can always implement it yourself in `userver/scripts/gdb` and bring us a PR!
+If you need a new pretty-printer or a GDB command, you can always implement it yourself in `userver/scripts/gdb` and
+bring us a PR!
+
+
+----------
+
+@htmlonly <div class="bottom-nav"> @endhtmlonly
+⇦ @ref scripts/docs/en/userver/profile_context_switches.md | @ref scripts/docs/en/userver/grpc/grpc.md ⇨
+@htmlonly </div> @endhtmlonly
diff --git a/scripts/docs/en/userver/grpc/grpc.md b/scripts/docs/en/userver/grpc/grpc.md
@@ -389,7 +389,7 @@ These are the metrics provided for each gRPC method:
 ----------
 
 @htmlonly <div class="bottom-nav"> @endhtmlonly
-⇦ @ref scripts/docs/en/userver/profile_context_switches.md | @ref scripts/docs/en/userver/grpc/server_middlewares.md ⇨
+⇦ @ref scripts/docs/en/userver/gdb_debugging.md | @ref scripts/docs/en/userver/grpc/server_middlewares.md ⇨
 @htmlonly </div> @endhtmlonly
 
 @example grpc-generic-proxy/src/proxy_service.hpp
diff --git a/scripts/docs/en/userver/mongodb.md b/scripts/docs/en/userver/mongodb.md
@@ -101,5 +101,5 @@ requests and helps Mongo to return to the normal state with lower response timin
 ----------
 
 @htmlonly <div class="bottom-nav"> @endhtmlonly
-⇦ @ref scripts/docs/en/userver/ydb.md | @ref scripts/docs/en/userver/redis.md ⇨
+⇦ @ref scripts/docs/en/userver/sqlite/design_and_details.md | @ref scripts/docs/en/userver/redis.md ⇨
 @htmlonly </div> @endhtmlonly
diff --git a/scripts/docs/en/userver/profile_context_switches.md b/scripts/docs/en/userver/profile_context_switches.md
@@ -119,5 +119,5 @@ $ make -j4 userver-core_unittest && ./userver/core/userver-core_unittest --gtest
 ----------
 
 @htmlonly <div class="bottom-nav"> @endhtmlonly
-⇦ @ref scripts/docs/en/userver/chaos_testing.md | @ref scripts/docs/en/userver/grpc/grpc.md ⇨
+⇦ @ref scripts/docs/en/userver/chaos_testing.md | @ref scripts/docs/en/userver/gdb_debugging.md ⇨
 @htmlonly </div> @endhtmlonly
diff --git a/scripts/docs/en/userver/publications.md b/scripts/docs/en/userver/publications.md
@@ -5,6 +5,8 @@
 
 ## Introductions
 * 🎥 [Microservices on C++, or why we made our own framework](https://youtu.be/WkcmNOmwAH8)
+* 📖 Implementing pastebin using only userver (ru):
+  [Пишем свой pastebin, используя только userver](https://habr.com/ru/companies/yandex/articles/894294/)
 * 🎥 Writing a new service with database and cache from scratch (ru):
   [Эффективные и высоконагруженные сервисы на C++](https://youtu.be/qrGZARf2Wno?t=2034)
 * 🎥 Writing a new gRPC server and client with userver (ru):
diff --git a/scripts/docs/en/userver/roadmap_and_changelog.md b/scripts/docs/en/userver/roadmap_and_changelog.md
@@ -39,11 +39,12 @@ Changelog news also go to the
 
 * Initial implementation of @ref scripts/docs/en/userver/sqlite/sqlite_driver.md. Many thanks to
   [Turulin Zakhar](https://github.com/zahartd) for the implementation, tests and for the documentation.
-* Merged a foundation for the ODBC driver. Many thanks to [Alexey](https://github.com/Olex1313) for the PR!
 * GDB pretty printers now can list all the tasks via `utask list` and can apply commands to all or selected
   tasks. For example `utask apply all bt` prints the backtraces of all the tasks, `utask apply some_task_name bt`
-  prints the backtrace of the task with name `some_task_name`. Many thanks to
+  prints the backtrace of the task with name `some_task_name`. See
+  @ref scripts/docs/en/userver/gdb_debugging.md for more info. Many thanks to
   [Maxim Belov](https://github.com/UNEXPECTEDsemicolon) for the brilliant implementation.
+* Merged a foundation for the ODBC driver. Many thanks to [Alexey](https://github.com/Olex1313) for the PR!
 * Redis driver now can ignore ping times to different instances to do a fair round-robin. See `consider_ping` field
   in storages::redis::CommandControl.
 * Dropped gRPC `[(userver.field).secret = true];`. Use `[debug_redact = true];` instead.
diff --git a/scripts/docs/en/userver/ydb.md b/scripts/docs/en/userver/ydb.md
@@ -26,5 +26,5 @@ You may store YQL queries in @ref scripts/docs/en/userver/sql_files.md.
 
 @htmlonly <div class="bottom-nav"> @endhtmlonly
 ⇦ @ref scripts/docs/en/userver/kafka.md |
-@ref scripts/docs/en/userver/mongodb.md ⇨
+@ref scripts/docs/en/userver/sqlite/sqlite_driver.md ⇨
 @htmlonly </div> @endhtmlonly
diff --git a/sqlite/README.md b/sqlite/README.md
@@ -1,3 +1,3 @@
 # userver: SQLite Driver
 
-Docs: TODO
+Docs: https://userver.tech/dd/d8a/md_en_2userver_2sqlite_2sqlite__driver.html
diff --git a/sqlite/functional_tests/integration_tests/tests/test_sqlite.py b/sqlite/functional_tests/integration_tests/tests/test_sqlite.py
@@ -64,8 +64,8 @@ async def test_update_by_unknown_key(service_client):
     assert response.status == 404
 
 
-# A test for checking succesful execute standard transactions with deferred mode
-async def test_trx_deffered_ok(service_client):
+# A test for checking successful execute standard transactions with deferred mode
+async def test_trx_deferred_ok(service_client):
     response = await service_client.delete('/basic/sqlite/key-value?key=foo')
     assert response.status == 200
 
diff --git a/sqlite/include/userver/storages/sqlite/component.hpp b/sqlite/include/userver/storages/sqlite/component.hpp
@@ -19,7 +19,7 @@ namespace components {
 ///
 /// @brief SQLite client component
 ///
-/// Provides access to a SQLite connections.
+/// Provides access to a SQLite connections via storages::sqlite::Client.
 ///
 /// ## Static configuration example:
 ///
@@ -33,7 +33,7 @@ namespace components {
 ///    read_only: false
 ///    initial_read_only_pool_size: 4
 ///    max_read_only_pool_size: 16
-//     persistent_prepared_statements: true
+///    persistent_prepared_statements: true
 ///    cache_size: -65536 # KiB
 ///    foreign_keys: true
 /// ```
@@ -52,7 +52,7 @@ namespace components {
 /// create_file                        | сreate the database file if it does not exist at the specified path               | true
 /// is_read_only                       | open the database in read-only mode                                               | false
 /// shared_cache                       | enable shared in-memory cache for the database                                    | false
-/// read_uncommited                    | allow reading uncommitted data (requires shared_cache)                            | false
+/// read_uncommitted                    | allow reading uncommitted data (requires shared_cache)                           | false
 /// journal_mode                       | mode for database journaling                                                      | wal
 /// busy_timeout                       | timeout duration (in milliseconds) to wait when the database is busy              | 5000
 /// foreign_keys                       | enable enforcement of foreign key constraints                                     | true
diff --git a/sqlite/include/userver/storages/sqlite/infra/statistics/statistics_counter.hpp b/sqlite/include/userver/storages/sqlite/infra/statistics/statistics_counter.hpp
@@ -7,7 +7,7 @@ USERVER_NAMESPACE_BEGIN
 
 namespace storages::sqlite::infra::statistics {
 
-// TODO: make RAII alghorithms
+// TODO: make RAII algorithms
 
 class QueryStatCounter {
 public:
@@ -41,7 +41,7 @@ class TransactionStatCounter {
     void AccountTransactionRollback() noexcept;
 
 private:
-    PoolTransactionsStatistics& transations_stats_;
+    PoolTransactionsStatistics& transactions_stats_;
     utils::datetime::SteadyClock::time_point exec_begin_time;
 };
 
diff --git a/sqlite/include/userver/storages/sqlite/options.hpp b/sqlite/include/userver/storages/sqlite/options.hpp
@@ -78,7 +78,7 @@ struct ConnectionSettings {
 };
 
 /// @brief Default initial size for the connection pool
-inline constexpr std::size_t kDefaulInitialPoolSize = 5;
+inline constexpr std::size_t kDefaultInitialPoolSize = 5;
 
 /// @brief Default maximum size for the connection pool
 inline constexpr std::size_t kDefaultMaxPoolSize = 10;
@@ -88,7 +88,7 @@ inline constexpr std::size_t kDefaultMaxPoolSize = 10;
 /// Configures the behavior of the connection pool, including its size.
 struct PoolSettings final {
     /// @brief Number of connections created initially.
-    std::size_t initial_pool_size{kDefaulInitialPoolSize};
+    std::size_t initial_pool_size{kDefaultInitialPoolSize};
 
     /// @brief Maximum number of connections in the pool.
     std::size_t max_pool_size{kDefaultMaxPoolSize};
@@ -99,7 +99,7 @@ struct PoolSettings final {
 inline constexpr bool kDefaultCreateFile = true;
 inline constexpr bool kDefaultIsReadOnly = false;
 inline constexpr bool kDefaultSharedCache = false;
-inline constexpr bool kDefaultReadUncommited = false;
+inline constexpr bool kDefaultReadUncommitted = false;
 inline constexpr bool kDefaultForeignKeys = true;
 inline constexpr std::string_view kDefaultJournalMode = "wal";
 inline constexpr std::string_view kDefaultSynchronous = "normal";
@@ -147,7 +147,7 @@ struct SQLiteSettings {
     ReadMode read_mode = !kDefaultIsReadOnly ? ReadMode::kReadWrite : ReadMode::kReadOnly;
     bool create_file = kDefaultCreateFile;
     bool shared_cache = kDefaultSharedCache;
-    bool read_uncommited = kDefaultReadUncommited;
+    bool read_uncommitted = kDefaultReadUncommitted;
     bool foreign_keys = kDefaultForeignKeys;
     JournalMode journal_mode = JournalMode::kWal;
     int busy_timeout = kDefaultBusyTimeout;
diff --git a/sqlite/src/storages/sqlite/component.cpp b/sqlite/src/storages/sqlite/component.cpp
@@ -51,7 +51,7 @@ storages::sqlite::settings::SQLiteSettings GetSettings(const components::Compone
                              ? storages::sqlite::settings::SQLiteSettings::ReadMode::kReadOnly
                              : storages::sqlite::settings::SQLiteSettings::ReadMode::kReadWrite;
     settings.shared_cache = config["shared_cache"].As<bool>(settings.shared_cache);
-    settings.read_uncommited = config["read_uncommited"].As<bool>(settings.read_uncommited);
+    settings.read_uncommitted = config["read_uncommitted"].As<bool>(settings.read_uncommitted);
     settings.foreign_keys = config["foreign_keys"].As<bool>(settings.foreign_keys);
     settings.journal_mode =
         ParseJournalMode(config["journal_mode"].As<std::string>(storages::sqlite::settings::kDefaultJournalMode));
@@ -132,7 +132,7 @@ additionalProperties: false
         type: boolean
         description: enable shared in-memory cache for the database
         defaultDescription: false
-    read_uncommited:
+    read_uncommitted:
         type: boolean
         description: allow reading uncommitted data (requires shared_cache)
         defaultDescription: false
diff --git a/sqlite/src/storages/sqlite/impl/connection.cpp b/sqlite/src/storages/sqlite/impl/connection.cpp
@@ -15,7 +15,7 @@ namespace storages::sqlite::impl {
 
 namespace {
 constexpr utils::StringLiteral kStatementTransactionSerializableIsolationLevel = "PRAGMA read_uncommitted=0";
-constexpr utils::StringLiteral kStatementTransactionReadUncommitedIsolationLevel = "PRAGMA read_uncommitted=1";
+constexpr utils::StringLiteral kStatementTransactionReadUncommittedIsolationLevel = "PRAGMA read_uncommitted=1";
 constexpr utils::StringLiteral kStatementTransactionBeginDeferred = "BEGIN DEFERRED";
 constexpr utils::StringLiteral kStatementTransactionBeginImmediate = "BEGIN IMMEDIATE";
 constexpr utils::StringLiteral kStatementTransactionBeginExclusive = "BEGIN EXCLUSIVE";
@@ -60,8 +60,8 @@ void Connection::ExecutionStep(StatementBasePtr prepare_statement) const {
 
 void Connection::Begin(const settings::TransactionOptions& options) {
     if (options.isolation_level == settings::TransactionOptions::IsolationLevel::kReadUncommitted &&
-        !settings_.read_uncommited) {
-        ExecuteQuery(kStatementTransactionReadUncommitedIsolationLevel);
+        !settings_.read_uncommitted) {
+        ExecuteQuery(kStatementTransactionReadUncommittedIsolationLevel);
     }
     switch (options.mode) {
         case settings::TransactionOptions::kDeferred:
@@ -82,15 +82,15 @@ void Connection::Begin(const settings::TransactionOptions& options) {
 void Connection::Commit() {
     ExecuteQuery(kStatementTransactionCommit);
     AccountTransactionCommit();
-    if (!settings_.read_uncommited) {
+    if (!settings_.read_uncommitted) {
         ExecuteQuery(kStatementTransactionSerializableIsolationLevel);
     }
 }
 
 void Connection::Rollback() {
     ExecuteQuery(kStatementTransactionRollback);
     AccountTransactionRollback();
-    if (!settings_.read_uncommited) {
+    if (!settings_.read_uncommitted) {
         ExecuteQuery(kStatementTransactionSerializableIsolationLevel);
     }
 }
diff --git a/sqlite/src/storages/sqlite/impl/io/common_binders.cpp b/sqlite/src/storages/sqlite/impl/io/common_binders.cpp
@@ -93,7 +93,7 @@ void FreestandingBind(OutputBindingsFwd& binds, std::size_t pos, ExplicitRef<boo
     std::vector<std::uint8_t> blob;
     binds.Extract(pos, blob);
     if (blob.size() != boost::uuids::uuid::static_size()) {
-        throw SQLiteException{"Incorect representation of UUIDv4 in SQLite"};
+        throw SQLiteException{"Incorrect representation of UUIDv4 in SQLite"};
     }
     boost::range::copy(blob, val.Get().begin());
 }
diff --git a/sqlite/src/storages/sqlite/impl/native_handler.cpp b/sqlite/src/storages/sqlite/impl/native_handler.cpp
@@ -33,7 +33,7 @@ constexpr utils::StringLiteral kPragmaMmapSize = "PRAGMA mmap_size = ";
 constexpr utils::StringLiteral kPragmaPageSize = "PRAGMA page_size = ";
 constexpr utils::StringLiteral kPragmaTempStoreFile = "PRAGMA temp_store = FILE";
 constexpr utils::StringLiteral kPragmaTempStoreMemory = "PRAGMA temp_store = MEMORY";
-constexpr utils::StringLiteral kPragmaReadUncommited = "PRAGMA read_uncommitted=1";
+constexpr utils::StringLiteral kPragmaReadUncommitted = "PRAGMA read_uncommitted=1";
 
 }  // namespace
 
@@ -88,8 +88,8 @@ void NativeHandler::SetSettings(const settings::SQLiteSettings& settings) {
             Exec(kPragmaTempStoreMemory);
             break;
     }
-    if (settings.read_uncommited) {
-        Exec(kPragmaReadUncommited);
+    if (settings.read_uncommitted) {
+        Exec(kPragmaReadUncommitted);
     }
     sqlite3_busy_timeout(db_handler_, settings.busy_timeout);
     Exec(std::string(kPragmaCacheSize) + std::to_string(settings.cache_size));
diff --git a/sqlite/src/storages/sqlite/infra/statistics/statistics_counter.cpp b/sqlite/src/storages/sqlite/infra/statistics/statistics_counter.cpp
@@ -22,24 +22,24 @@ void QueryStatCounter::AccountQueryCompleted() noexcept {
 
 void QueryStatCounter::AccountQueryFailed() noexcept { ++queries_stats_.error; }
 
-TransactionStatCounter::TransactionStatCounter(PoolTransactionsStatistics& stats) : transations_stats_{stats} {}
+TransactionStatCounter::TransactionStatCounter(PoolTransactionsStatistics& stats) : transactions_stats_{stats} {}
 
 TransactionStatCounter::~TransactionStatCounter() = default;
 
 void TransactionStatCounter::AccountTransactionStart() noexcept {
-    ++transations_stats_.total;
+    ++transactions_stats_.total;
     exec_begin_time = utils::datetime::SteadyClock::now();
 }
 
 void TransactionStatCounter::AccountTransactionCommit() noexcept {
     auto now = utils::datetime::SteadyClock::now();
-    ++transations_stats_.commit;
-    transations_stats_.timings.Account(
+    ++transactions_stats_.commit;
+    transactions_stats_.timings.Account(
         std::chrono::duration_cast<std::chrono::milliseconds>(now - exec_begin_time).count()
     );
 }
 
-void TransactionStatCounter::AccountTransactionRollback() noexcept { ++transations_stats_.rollback; }
+void TransactionStatCounter::AccountTransactionRollback() noexcept { ++transactions_stats_.rollback; }
 
 }  // namespace storages::sqlite::infra::statistics
 
diff --git a/sqlite/src/storages/sqlite/tests/journals_test.cpp b/sqlite/src/storages/sqlite/tests/journals_test.cpp
@@ -80,7 +80,7 @@ UTEST_P_MT(SQLiteJournalModesTest, ReadWrite, 10) {
 }
 
 INSTANTIATE_UTEST_SUITE_P(
-    SQLiteCommonConcurent,
+    SQLiteCommonConcurrent,
     SQLiteJournalModesTest,
     ::testing::Values(
         settings::SQLiteSettings::JournalMode::kWal,
diff --git a/sqlite/src/storages/sqlite/tests/metrics_test.cpp b/sqlite/src/storages/sqlite/tests/metrics_test.cpp
diff --git a/sqlite/src/storages/sqlite/tests/mocked_result_set_test.cpp b/sqlite/src/storages/sqlite/tests/mocked_result_set_test.cpp
diff --git a/sqlite/src/storages/sqlite/tests/supported_types_test.cpp b/sqlite/src/storages/sqlite/tests/supported_types_test.cpp
diff --git a/sqlite/src/storages/sqlite/tests/trx_options_test.cpp b/sqlite/src/storages/sqlite/tests/trx_options_test.cpp
diff --git a/sqlite/src/storages/sqlite/tests/utils_test.hpp b/sqlite/src/storages/sqlite/tests/utils_test.hpp
diff --git a/sqlite/src/storages/sqlite/transaction.cpp b/sqlite/src/storages/sqlite/transaction.cpp

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`# userver: ODBC Driver Wrapper [WIP]`
	`2`	`+`
	`3`	`+Under heavy development. Come back later`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# userver: SQLite Driver`
`2`	`2`
`3`		`-Docs: TODO`
	`3`	`+Docs: https://userver.tech/dd/d8a/md_en_2userver_2sqlite_2sqlite__driver.html`