From d5d1e2962fac9caa675517fd82446b848968ffaf Mon Sep 17 00:00:00 2001 From: zhijian Date: Mon, 9 Oct 2023 09:51:07 +0800 Subject: [PATCH] doc: improve escape description (#4074) --- docs/en/reference/how_to_set_up_metadata_engine.md | 7 ++++++- docs/zh_cn/reference/how_to_set_up_metadata_engine.md | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/en/reference/how_to_set_up_metadata_engine.md b/docs/en/reference/how_to_set_up_metadata_engine.md index 4a0d6d8e553a..c01a0f56add4 100644 --- a/docs/en/reference/how_to_set_up_metadata_engine.md +++ b/docs/en/reference/how_to_set_up_metadata_engine.md @@ -200,6 +200,8 @@ juicefs format \ 1. JuiceFS uses public [schema](https://www.postgresql.org/docs/current/ddl-schemas.html) by default, if you want to use a `non-public schema`, you need to specify `search_path` in the connection string parameter. e.g `postgres://user:mypassword@192.168.1.6:5432/juicefs?search_path=pguser1` 2. If the `public schema` is not the first hit in the `search_path` configured on the PostgreSQL server, the `search_path` parameter must be explicitly set in the connection string. 3. The `search_path` connection parameter can be set to multiple schemas natively, but currently JuiceFS only supports setting one. `postgres://user:mypassword@192.168.1.6:5432/juicefs?search_path=pguser1,public` will be considered illegal. +4. Special characters in the password need to be replaced by url encoding. For example, `|` needs to be replaced with `%7C`. + ::: ### Mount a file system @@ -255,7 +257,10 @@ mysql://[:]@unix()/ :::note -Don't leave out the `()` brackets on either side of the URL. + +1. Don't leave out the `()` brackets on either side of the URL. +2. Special characters in passwords do not require url encoding + ::: For example: diff --git a/docs/zh_cn/reference/how_to_set_up_metadata_engine.md b/docs/zh_cn/reference/how_to_set_up_metadata_engine.md index 36e522b6f9d8..6c13b68fa48c 100644 --- a/docs/zh_cn/reference/how_to_set_up_metadata_engine.md +++ b/docs/zh_cn/reference/how_to_set_up_metadata_engine.md @@ -200,6 +200,8 @@ juicefs format \ 1. JuiceFS 默认使用的 public [schema](https://www.postgresql.org/docs/current/ddl-schemas.html) ,如果要使用非 `public schema`,需要在连接字符串中指定 `search_path` 参数,例如 `postgres://user:mypassword@192.168.1.6:5432/juicefs?search_path=pguser1` 2. 如果 `public schema` 并非是 PostgreSQL 服务端配置的 `search_path` 中第一个命中的,则必须在连接字符串中明确设置 `search_path` 参数 3. `search_path` 连接参数原生可以设置为多个 schema,但是目前 JuiceFS 仅支持设置一个。`postgres://user:mypassword@192.168.1.6:5432/juicefs?search_path=pguser1,public` 将被认为不合法 +4. 密码中的特殊字符需要进行 url 编码,例如 `|` 需要编码为`%7C`。 + ::: ### 挂载文件系统 @@ -255,7 +257,10 @@ mysql://[:]@unix()/ :::note 注意 -不要漏掉 URL 两边的 `()` 括号 + +1. 不要漏掉 URL 两边的 `()` 括号 +2. 密码中的特殊字符不需要进行 url 编码 + ::: 例如: