Skip to content

Add doc about pg_waldump #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add doc about pg_waldump #232

wants to merge 4 commits into from

Conversation

owanglio
Copy link


Change logs

Describe your change clearly, including what problem is being solved or what document is being added or updated.
Added draft documentation about pg_waldump in both English and Chinese

Contributor's checklist

Here are some reminders before you submit your pull request:

Adding a descriptive documentation draft about the pg_waldump functionality for testing purposes.
Adding a descriptive documentation draft about the pg_waldump functionality for testing purposes. - Chinese version
Add common options for reference
Add common options
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hiiii, @owanglio welcome!🎊 Thanks for taking the effort to make our project better! 🙌 Keep making such awesome contributions!

Copy link
Contributor

@TomShawn TomShawn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done!


## Features

- **WAL Analysis**: The `pg_waldump` function in Cloudberry allows users to parse and decode WAL files, presenting a human-readable format of the log data.
Copy link
Contributor

@TomShawn TomShawn Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **WAL Analysis**: The `pg_waldump` function in Cloudberry allows users to parse and decode WAL files, presenting a human-readable format of the log data.
- **WAL Analysis**: The `pg_waldump` tool in Cloudberry allows users to parse and decode WAL files, presenting a human-readable format of the log data.

Comment on lines +17 to +18
```bash
pg_waldump --nodes=node1,node2 --format=human --level=high
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```bash
pg_waldump --nodes=node1,node2 --format=human --level=high
```bash
pg_waldump --nodes=node1,node2 --format=human --level=high
```

Comment on lines +2 to +4
### 中文版本: Apache Cloudberry中的pg_waldump

```markdown
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### 中文版本: Apache Cloudberry中的pg_waldump
```markdown

Comment on lines +21 to +22
```bash
pg_waldump --nodes=node1,node2 --format=human --level=high
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```bash
pg_waldump --nodes=node1,node2 --format=human --level=high
```bash
pg_waldump --nodes=node1,node2 --format=human --level=high
```

```markdown
# Apache Cloudberry中的pg_waldump

Apache Cloudberry提供了一种强大的机制,用于检查预写日志(WAL)文件,帮助用户分析数据库变化、跟踪操作以及诊断问题。Cloudberry中的`pg_waldump`功能模仿了PostgreSQL中的`pg_waldump`工具,但针对Cloudberry的分布式架构进行了增强。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please reserve a space between an English character (or a number) and a Chinese character.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants