Skip to content
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

sql, README: improve JSON doc #949

Merged
merged 4 commits into from
Nov 2, 2018
Merged

sql, README: improve JSON doc #949

merged 4 commits into from
Nov 2, 2018

Conversation

CaitinChen
Copy link
Contributor

@morgo
Copy link

morgo commented Oct 26, 2018

Note: one of the 'unsupported' functions has since been merged: pingcap/docs#680

(Up to you if you want to handle in this PR, or a followup one.)

);
```

该表中,`city` 列是一个 **generated column**。顾名思义,此列由该表的其他列生成,对此列进行插入或更新操作时,并不能对之赋值。此列按需生成,并不存储在数据库中,也不占用内存空间,因而是_虚拟的_。`city` 列的索引_存储在数据库中_,并使用和 `varchar(64)` 类的其他索引相同的结构。
Copy link
Member

Choose a reason for hiding this comment

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

The italic effect does not work well here. You can click "View" to check it.

In Chinese text, limit the use of the italic effect. For emphasis, the bold effect is preferred.

Copy link
Member

Choose a reason for hiding this comment

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

How about "因而是虚拟的" Or "因而是 虚拟的 。"?

因而是**虚拟的**
因而是 _虚拟的_ 。 // NOTE: There is a space to separate the _ symbol.

Copy link
Contributor Author

@CaitinChen CaitinChen Nov 1, 2018

Choose a reason for hiding this comment

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

@lilin90 @zz-jason Thank you both. Generally, we do not use the italic effect in Chinese text, so I will change it to the bold style.


- 不能通过 `ALTER TABLE` 增加 `STORED` 存储方式的 generated column;
- 不能通过 `ALTER TABLE` 在 generated column 上增加索引;
- 并未支持所有的 [JSON 函数](json-functions.md)。
Copy link
Member

Choose a reason for hiding this comment

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

Please update the link path to ../sql/json-functions.md.

category: user guide
---

# JSON 相关的函数和语法糖
# JSON 相关的函数及语法糖
Copy link
Member

Choose a reason for hiding this comment

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

Keep this heading consistent with the title in metadata.

* `JSON_APPEND` 及其别名 `JSON_ARRAY_APPEND`
* `JSON_ARRAY_INSERT`
* `JSON_DEPTH`
* `JSON_KEYS`
Copy link
Member

Choose a reason for hiding this comment

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

As what Morgan has mentioned, this function has been removed from the unsupported list. See pingcap/docs#680

@@ -30,3 +72,10 @@ category: user guide
[json_merge]: https://dev.mysql.com/doc/refman/5.7/en/json-modification-functions.html#function_json-merge
[json_object]: https://dev.mysql.com/doc/refman/5.7/en/json-creation-functions.html#function_json-object
[json_array]: https://dev.mysql.com/doc/refman/5.7/en/json-creation-functions.html#function_json-array
[json_keys]: https://dev.mysql.com/doc/refman/5.7/en/json-search-functions.html#function_json-keys
Copy link
Member

Choose a reason for hiding this comment

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

Please also check and update the links. If it links to no place, please remove it.

@CaitinChen
Copy link
Contributor Author

@lilin90 @zz-jason Thanks. PTAL again.

Copy link
Member

@zz-jason zz-jason left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

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

LGTM

@lilin90 lilin90 merged commit c1f22d8 into pingcap:master Nov 2, 2018
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.

4 participants