# pg_snapdump

**Repository Path**: haru_hi/pg_snapdump

## Basic Information

- **Project Name**: pg_snapdump
- **Description**: postgresql tool for parser data file to display mvcc version records.
- **Primary Language**: C
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-09-18
- **Last Updated**: 2025-09-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Postgresql, database-tools, openGauss

## README

# 指引

[英文版介绍](https://github.com/baijiu1/pg_snapdump/blob/main/README.md)

[pg_snapdump](https://github.com/baijiu1/pg_snapdump) 是一款数据恢复的工具。 它可以直接从postgresql/opengauss的底层数据文件中解析出明文数据。pg_snapdump用C/C++编写，为学习postgresql的数据文件格式、数据恢复等提供帮助。



# 特性

安全： 只需要简单的读取权限

全面： 支持postgresql 9.x/10.x/11.x/12.x/13.x/14.x/15.x/16.x/17.x/18.x，openguass 3.x/5.x/6.x的数据文件解析

简单： 编译不需要依赖任何第三方库

实用： 可以直接解析数据文件中的mvcc老版本数据，在vacuum之前


# 使用方式

## 编译

**Linux/MacOS**
1. 编辑PG_VERSION_NUM宏版本号，该宏位于pg_config.h文件中，以匹配你当前的PG/opengauss版本，默认版本为17.2
```c
cd pg_snapdump/
vim pg_config.h
647 #define PG_VERSION_NUM 170002
```

2. 配置日志显示等级，默认为INFO级别
```c
// log level
#define LOG_LEVEL_DEBUG 0
#define LOG_LEVEL_INFO  1
#define LOG_LEVEL_WARN  2
#define LOG_LEVEL_ERROR 3
#define LOG_LEVEL_FATAL 3
```

```c
vim CMakeList.txt
add_compile_definitions(LOG_LEVEL=1)
```

3. 编译
```shell
cmake .
make
cd bin/
```

## 执行

**Linux/MacOS**

```shell
./pg_snapdump [[-f /pgdata/data/base/16384/50000] [-o]]
```

# 示例

```shell
SQL> update table_name set name = 'this name 2' where id = 2;

SHELL> ./pg_snapdump -f /path/to/pgdata/base/16384/50000 
id: 1 name: User_1 age: 108 class: 20 desc: This is a description for row 1  列读取完毕 ctid(0,1)
id: 2 name: this name 2 age: 108 class: 20 desc: This is a description for row 2 列读取完毕 ctid(0,3)
  -- id: 2 name: User_2 age: 108 class: 20 desc: This is a description for row 2 列读取完毕 ctid(0,3)


SHELL> ./pg_snapdump -f /path/to/pgdata/base/16384/50000 -o
id: 1 name: User_1 age: 108 class: 20 desc: This is a description for row 1 列读取完毕 ctid(0,1)
id: 2 name: this name 2 age: 108 class: 20 desc: This is a description for row 2 列读取完毕 ctid(0,3)
```


# CHANGE LOG

| VERSION | UPDATE     | NOTE                                     |
| ------- | ---------- | ---------------------------------------- |
| v0.1    | 2024.8.21  | first version                            |





# REQUIRE & SUPPORT

require: gcc

support range: postgresql/opengauss