Skip to content

Commit 16d0cd6

Browse files
author
Cary Huang
committed
updates
1 parent 5e7f8a0 commit 16d0cd6

File tree

5 files changed

+151
-5
lines changed

5 files changed

+151
-5
lines changed

‎docs/en/monitoring/attr_view.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,53 @@
1-
# Attribute View
1+
# Attribute View
2+
3+
## **Review Attributes Managed by a Connector**
4+
5+
As a connector completes initial table snapshot, the source tables, columns and data types would have been translated, transformed and created on PostgreSQL side according to the [object mapping rules](https://docs.synchdb.com/user-guide/object_mapping_rules/). SynchDB provides a view that displays a side-by-side view of a connector's data type, name mapping and transform rule relationships between source and destination tables.
6+
7+
This view is informational and it intends to show the user the list of tables a connector currently is tracking and the mapping/transform rules it uses per table/column.
8+
9+
```sql
10+
SELECT * FROM synchdb_att_view();
11+
```
12+
13+
**Return Fields**:
14+
15+
| Field | Description | Type |
16+
|-|-|-|
17+
| `name` | Connector identifier | Text |
18+
| `attnum` | Attribute number | Integer |
19+
| `ext_tbname` | table name as appeared remotely | Text |
20+
| `pg_tbname` | mapped table name in PostgreSQL | Text |
21+
| `ext_attname` | column name as appeared remotely | Text |
22+
| `pg_attname` | mapped column name in PostgreSQL | Text |
23+
| `ext_atttypename` | data type as appeared remotely | Text |
24+
| `pg_atttypename` | mapped data type in PostgreSQL | Text |
25+
| `transform` | transform expression | Text |
26+
27+
**Example Output**
28+
29+
```sql
30+
SELECT * from synchdb_att_view;
31+
name | type | attnum | ext_tbname | pg_tbname | ext_attname | pg_attname | ext_atttypename | pg_atttypename | transform
32+
-----------+-------+--------+----------------------------+----------------------------+-------------+-------------+-----------------+----------------+----------------------------
33+
mysqlconn | mysql | 1 | inventory.addresses | inventory.addresses | id | id | INT | int4 |
34+
mysqlconn | mysql | 2 | inventory.addresses | inventory.addresses | customer_id | customer_id | INT | int4 |
35+
mysqlconn | mysql | 3 | inventory.addresses | inventory.addresses | street | street | VARCHAR | varchar |
36+
mysqlconn | mysql | 4 | inventory.addresses | inventory.addresses | city | city | VARCHAR | varchar |
37+
mysqlconn | mysql | 5 | inventory.addresses | inventory.addresses | state | state | VARCHAR | varchar |
38+
mysqlconn | mysql | 6 | inventory.addresses | inventory.addresses | zip | zip | VARCHAR | varchar |
39+
mysqlconn | mysql | 7 | inventory.addresses | inventory.addresses | type | type | ENUM | text |
40+
mysqlconn | mysql | 1 | inventory.customers | schema1.people | id | id | INT | int4 |
41+
mysqlconn | mysql | 2 | inventory.customers | schema1.people | first_name | first_name | VARCHAR | varchar |
42+
mysqlconn | mysql | 3 | inventory.customers | schema1.people | last_name | family_name | VARCHAR | varchar |
43+
mysqlconn | mysql | 4 | inventory.customers | schema1.people | email | contact | VARCHAR | varchar |
44+
mysqlconn | mysql | 1 | inventory.geom | inventory.geom | id | id | INT | int4 |
45+
mysqlconn | mysql | 2 | inventory.geom | inventory.geom | g | g | GEOMETRY | geometry |
46+
mysqlconn | mysql | 3 | inventory.geom | inventory.geom | h | h | GEOMETRY | text |
47+
mysqlconn | mysql | 1 | inventory.products | public.stuff | id | id | INT | int4 |
48+
mysqlconn | mysql | 2 | inventory.products | public.stuff | name | name | VARCHAR | varchar | '>>>>>' || '%d' || '<<<<<'
49+
mysqlconn | mysql | 3 | inventory.products | public.stuff | description | description | VARCHAR | varchar |
50+
mysqlconn | mysql | 4 | inventory.products | public.stuff | weight | weight | FLOAT | float4 |
51+
mysqlconn | mysql | 1 | inventory.products_on_hand | inventory.products_on_hand | product_id | product_id | INT | int4 |
52+
mysqlconn | mysql | 2 | inventory.products_on_hand | inventory.products_on_hand | quantity | quantity | INT | int8 |
53+
```

‎docs/en/monitoring/jvm_mem.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,22 @@
1-
# JVM Memory Usage
1+
# JVM Memory Usage
2+
3+
## **Dump JVM Memory Usage**
4+
5+
We can use an utility function `synchdb_log_jvm_meminfo` to dump current JVM's current heap and non-heap memory usage in the logfile. This is purely informational and is intended to give user an idea the memory usage of different workload, which may be important to configure a suitable value for max heap memory to be allocated to JVM of a connector.
6+
```sql
7+
SELECT synchdb_log_jvm_meminfo('mysqlconn');
8+
```
9+
10+
Check the PostgreSQL log file:
11+
```
12+
2024-12-09 14:34:21.910 PST [25491] LOG: Requesting memdump for mysqlconn connector
13+
2024-12-09 14:34:21 WARN DebeziumRunner:297 - Heap Memory:
14+
2024-12-09 14:34:21 WARN DebeziumRunner:298 - Used: 19272600 bytes
15+
2024-12-09 14:34:21 WARN DebeziumRunner:299 - Committed: 67108864 bytes
16+
2024-12-09 14:34:21 WARN DebeziumRunner:300 - Max: 2147483648 bytes
17+
2024-12-09 14:34:21 WARN DebeziumRunner:302 - Non-Heap Memory:
18+
2024-12-09 14:34:21 WARN DebeziumRunner:303 - Used: 42198864 bytes
19+
2024-12-09 14:34:21 WARN DebeziumRunner:304 - Committed: 45023232 bytes
20+
2024-12-09 14:34:21 WARN DebeziumRunner:305 - Max: -1 bytes
21+
22+
```

‎docs/zh/monitoring/attr_view.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,53 @@
1-
# Attribute View
1+
# 属性视图
2+
3+
## **查看连接器管理的属性**
4+
5+
连接器完成初始表快照后，源表、列和数据类型将根据[对象映射规则](https://docs.synchdb.com/zh/user-guide/object_mapping_rules/)在 PostgreSQL 端进行转换和创建。SynchDB 提供了一个视图，可并排显示连接器的数据类型、名称映射以及源表和目标表之间的转换规则关系。
6+
7+
此视图仅供参考，旨在向用户显示连接器当前正在跟踪的表的列表以及每个表/列使用的映射/转换规则。
8+
9+
```sql
10+
SELECT * FROM synchdb_att_view();
11+
```
12+
13+
**返回字段**：
14+
15+
| 字段 | 描述 | 类型 |
16+
|-|-|-|
17+
| `name` | 连接器标识符 | 文本 |
18+
| `attnum` | 属性编号 | 整数 |
19+
| `ext_tbname` | 远程显示的表名 | 文本 |
20+
| `pg_tbname` | PostgreSQL 中的映射表名 | 文本 |
21+
| `ext_attname` | 远程显示的列名 | 文本 |
22+
| `pg_attname` | PostgreSQL 中映射的列名 | 文本 |
23+
| `ext_atttypename` | 远程显示的数据类型 | 文本 |
24+
| `pg_atttypename` | PostgreSQL 中映射的数据类型 | 文本 |
25+
| `transform` | 转换表达式 | 文本 |
26+
27+
**示例输出**
28+
29+
```sql
30+
SELECT * from synchdb_att_view;
31+
name | type | attnum | ext_tbname | pg_tbname | ext_attname | pg_attname | ext_atttypename | pg_atttypename | transform
32+
-----------+-------+--------+----------------------------+----------------------------+-------------+-------------+-----------------+----------------+----------------------------
33+
mysqlconn | mysql | 1 | inventory.addresses | inventory.addresses | id | id | INT | int4 |
34+
mysqlconn | mysql | 2 | inventory.addresses | inventory.addresses | customer_id | customer_id | INT | int4 |
35+
mysqlconn | mysql | 3 | inventory.addresses | inventory.addresses | street | street | VARCHAR | varchar |
36+
mysqlconn | mysql | 4 | inventory.addresses | inventory.addresses | city | city | VARCHAR | varchar |
37+
mysqlconn | mysql | 5 | inventory.addresses | inventory.addresses | state | state | VARCHAR | varchar |
38+
mysqlconn | mysql | 6 | inventory.addresses | inventory.addresses | zip | zip | VARCHAR | varchar |
39+
mysqlconn | mysql | 7 | inventory.addresses | inventory.addresses | type | type | ENUM | text |
40+
mysqlconn | mysql | 1 | inventory.customers | schema1.people | id | id | INT | int4 |
41+
mysqlconn | mysql | 2 | inventory.customers | schema1.people | first_name | first_name | VARCHAR | varchar |
42+
mysqlconn | mysql | 3 | inventory.customers | schema1.people | last_name | family_name | VARCHAR | varchar |
43+
mysqlconn | mysql | 4 | inventory.customers | schema1.people | email | contact | VARCHAR | varchar |
44+
mysqlconn | mysql | 1 | inventory.geom | inventory.geom | id | id | INT | int4 |
45+
mysqlconn | mysql | 2 | inventory.geom | inventory.geom | g | g | GEOMETRY | geometry |
46+
mysqlconn | mysql | 3 | inventory.geom | inventory.geom | h | h | GEOMETRY | text |
47+
mysqlconn | mysql | 1 | inventory.products | public.stuff | id | id | INT | int4 |
48+
mysqlconn | mysql | 2 | inventory.products | public.stuff | name | name | VARCHAR | varchar | '>>>>>' || '%d' || '<<<<<'
49+
mysqlconn | mysql | 3 | inventory.products | public.stuff | description | description | VARCHAR | varchar |
50+
mysqlconn | mysql | 4 | inventory.products | public.stuff | weight | weight | FLOAT | float4 |
51+
mysqlconn | mysql | 1 | inventory.products_on_hand | inventory.products_on_hand | product_id | product_id | INT | int4 |
52+
mysqlconn | mysql | 2 | inventory.products_on_hand | inventory.products_on_hand | quantity | quantity | INT | int8 |
53+
```

‎docs/zh/monitoring/jvm_mem.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,22 @@
1-
# JVM Memory Usage
1+
# JVM 内存使用情况
2+
3+
## **转储 JVM 内存使用情况**
4+
5+
我们可以使用实用函数 `synchdb_log_jvm_meminfo` 将当前 JVM 的堆内存和非堆内存使用情况转储到日志文件中。这纯粹是提供信息，旨在让用户了解不同工作负载的内存使用情况，这对于为连接器的 JVM 配置合适的最大堆内存值可能很重要。
6+
```sql
7+
SELECT synchdb_log_jvm_meminfo('mysqlconn');
8+
```
9+
10+
检查 PostgreSQL 日志文件：
11+
```
12+
2024-12-09 14:34:21.910 PST [25491] LOG: Requesting memdump for mysqlconn connector
13+
2024-12-09 14:34:21 WARN DebeziumRunner:297 - Heap Memory:
14+
2024-12-09 14:34:21 WARN DebeziumRunner:298 - Used: 19272600 bytes
15+
2024-12-09 14:34:21 WARN DebeziumRunner:299 - Committed: 67108864 bytes
16+
2024-12-09 14:34:21 WARN DebeziumRunner:300 - Max: 2147483648 bytes
17+
2024-12-09 14:34:21 WARN DebeziumRunner:302 - Non-Heap Memory:
18+
2024-12-09 14:34:21 WARN DebeziumRunner:303 - Used: 42198864 bytes
19+
2024-12-09 14:34:21 WARN DebeziumRunner:304 - Committed: 45023232 bytes
20+
2024-12-09 14:34:21 WARN DebeziumRunner:305 - Max: -1 bytes
21+
22+
```

‎mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ nav:
137137
- Statistic View: monitoring/stats_view.md
138138
- State View: monitoring/state_view.md
139139
# - Attribute View: monitoring/attr_view.md
140-
# - JVM Memory Usage: monitoring/jvm_mem.md
140+
- JVM Memory Usage: monitoring/jvm_mem.md
141141
- Tutorial:
142142
# - MySQL CDC to PostgreSQL: tutorial/mysql_cdc_to_postgresql.md
143143
# - SQL Server CDC to PostgreSQL: tutorial/sqlserver_cdc_to_postgresql.md

0 commit comments

Comments
 (0)