Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

docs: the sample configuration in design document 08 does not load

未关闭 适合新手
#585 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
82/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
rust
领域
documentation

调研方向

阅读 docs/design/08-component-config.md 的第 3 节,并将其中的 [server] 和 [storage.postgres] 块与 crates/config/src/lib.rs 中的 ServerConfig 以及 crates/storage-postgres/src/config.rs 中的 PostgresStorageConfig 进行比较。使用 docs/manuals/05-admin-guide.md 中的运维人员参考文档,检查接受哪些 PostgreSQL 键。加载器接受示例中的所有键即为完成。

由索引模型根据 Issue 内容生成。

描述

documentation

Summary

The sample configuration in docs/design/08-component-config.md section 3 does not load. Both ServerConfig and PostgresStorageConfig carry #[serde(deny_unknown_fields)], and the sample sets keys neither struct has, so a server started from a copy of it stops at startup with an unknown field error.

Keys in the sample that no struct has

[server] (crates/config/src/lib.rs, fields bind_addr, port, region, run_dir, tls, throttling_enabled):

  • max_connections
  • request_timeout_secs
  • shutdown_drain_secs
  • max_request_size_bytes
  • the [server.rate_limit] table (global_rps, per_table_rps)

[storage.postgres] (crates/storage-postgres/src/config.rs, fields connection_string, pool_size, catalog_pool_size):

  • connection_timeout_secs
  • statement_timeout_secs

The read_replica_url and read_replica_pool_size lines were removed by #584 (issue #561). The rest of the sample has the same defect.

Expected

The sample loads as written, or each key it shows is one the loader accepts. The operator reference in docs/manuals/05-admin-guide.md lists the [storage.postgres] keys the loader has and can serve as the source for the sample.

Where

  • docs/design/08-component-config.md, section 3, the [server] block and the [storage.postgres] block
  • crates/config/src/lib.rs, ServerConfig
  • crates/storage-postgres/src/config.rs, PostgresStorageConfig
主要语言
Rust
星标
517
派生
60
平均合并
2 天 23 小时
30 天内合并 PR
25

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ExtendDB/extenddb 的其他 Issue

查看 ExtendDB/extenddb 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。