From 235be00e4a9e223da9a95e64ed69bc4088364f0e Mon Sep 17 00:00:00 2001 From: He Wang Date: Wed, 13 Jul 2022 19:17:26 +0800 Subject: [PATCH] update doc about fnmatch (#53) --- docs/quickstart/logproxy-client-tutorial.md | 2 +- .../oceanbase/clogproxy/client/config/ObReaderConfig.java | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/quickstart/logproxy-client-tutorial.md b/docs/quickstart/logproxy-client-tutorial.md index 126cd22..9f990e3 100644 --- a/docs/quickstart/logproxy-client-tutorial.md +++ b/docs/quickstart/logproxy-client-tutorial.md @@ -58,7 +58,7 @@ To connect to LogProxy, there are some parameters to set in `ObReaderConfig`: - *cluster_username*: Username for OceanBase, the format is `username@tenant_name#cluster_name` when connecting to [obproxy](https://github.com/oceanbase/obproxy) or `username@tenant_name` when directly connecting to OceanBase server. - *cluster_password*: Password for OceanBase when using configured `cluster_username`. - *first_start_timestamp*: Start timestamp in seconds, and zero means starting from now. Default is `0`. -- *tb_white_list*: Table whitelist in format `tenant_name.database_name.table_name`, `*` indicates any value, and multiple values can be separated by `|`. Default is `*.*.*`. +- *tb_white_list*: Table whitelist in format `tenant_name.database_name.table_name`. Pattern matching is provided by `fnmatch`, and multiple values can be separated by `|`. Default is `*.*.*`. - *tb_black_list*: Table blacklist in the same format with whitelist. Default is `|`. - *timezone*: Timezone offset from UTC. Default value is `+8:00`. - *working_mode*: Working mode. Can be `storage` (default value, supported from `obcdc` 3.1.3) or `memory`. diff --git a/logproxy-client/src/main/java/com/oceanbase/clogproxy/client/config/ObReaderConfig.java b/logproxy-client/src/main/java/com/oceanbase/clogproxy/client/config/ObReaderConfig.java index 4b658bf..2fb030d 100644 --- a/logproxy-client/src/main/java/com/oceanbase/clogproxy/client/config/ObReaderConfig.java +++ b/logproxy-client/src/main/java/com/oceanbase/clogproxy/client/config/ObReaderConfig.java @@ -205,8 +205,9 @@ public class ObReaderConfig extends AbstractConnectionConfig { } /** - * Set table whitelist. It is composed of three dimensions: tenant, library, and table. Asterisk - * means any, such as: "A.foo.bar", "B.foo.*", "C.*.*", "*.*.*". + * Set table whitelist. It is composed of three dimensions: tenant, db and table. Pattern + * matching is provided by `fnmatch`, so asterisk means any, for example: "A.foo.bar", + * "B.foo.*", "C.*.*", "*.*.*". * * @param tableWhiteList Table whitelist. */ -- GitLab