From 1ad8a7b260f6fd56661a0224f93e31a78ce0f9d7 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Mon, 7 Nov 2022 14:35:50 +0800 Subject: [PATCH] Add description about user ATTRIBUTE (#11084) --- TOC.md | 1 + .../information-schema-user-attributes.md | 49 +++++++++++ information-schema/information-schema.md | 1 + sql-statements/sql-statement-alter-user.md | 56 +++++++++++-- sql-statements/sql-statement-create-user.md | 36 ++++++++- .../sql-statement-show-columns-from.md | 81 ++++++++++--------- 6 files changed, 180 insertions(+), 44 deletions(-) create mode 100644 information-schema/information-schema-user-attributes.md diff --git a/TOC.md b/TOC.md index 58bc4f8197253..5ff9c8cc0854b 100644 --- a/TOC.md +++ b/TOC.md @@ -812,6 +812,7 @@ - [`TIKV_REGION_PEERS`](/information-schema/information-schema-tikv-region-peers.md) - [`TIKV_REGION_STATUS`](/information-schema/information-schema-tikv-region-status.md) - [`TIKV_STORE_STATUS`](/information-schema/information-schema-tikv-store-status.md) + - [`USER_ATTRIBUTES`](/information-schema/information-schema-user-attributes.md) - [`USER_PRIVILEGES`](/information-schema/information-schema-user-privileges.md) - [`VARIABLES_INFO`](/information-schema/information-schema-variables-info.md) - [`VIEWS`](/information-schema/information-schema-views.md) diff --git a/information-schema/information-schema-user-attributes.md b/information-schema/information-schema-user-attributes.md new file mode 100644 index 0000000000000..c2d31494a3819 --- /dev/null +++ b/information-schema/information-schema-user-attributes.md @@ -0,0 +1,49 @@ +--- +title: USER_ATTRIBUTES +summary: Learn the `USER_ATTRIBUTES` INFORMATION_SCHEMA table. +--- + +# USER_ATTRIBUTES + +The `USER_PRIVILEGES` table provides information about user comments and user attributes. This information comes from the `mysql.user` system table. + +```sql +USE information_schema; +DESC user_attributes; +``` + +```sql ++-----------+--------------+------+------+---------+-------+ +| Field | Type | Null | Key | Default | Extra | ++-----------+--------------+------+------+---------+-------+ +| USER | varchar(32) | NO | | NULL | | +| HOST | varchar(255) | NO | | NULL | | +| ATTRIBUTE | longtext | YES | | NULL | | ++-----------+--------------+------+------+---------+-------+ +3 rows in set (0.00 sec) +``` + +Fields in the `USER_ATTRIBUTES` table are described as follows: + +* `USER`: The user name. +* `HOST`: The host from which the user can connect to TiDB. If the value of this field is `％`, it means that the user can connect to TiDB from any host. +* `ATTRIBUTE`: The comment and attribute of the user, which are set by the [`CREATE USER`](/sql-statements/sql-statement-create-user.md) or [`ALTER USER`](/sql-statements/sql-statement-alter-user.md) statement. + +The following is an example: + +```sql +CREATE USER testuser1 COMMENT 'This user is created only for test'; +CREATE USER testuser2 ATTRIBUTE '{"email": "user@pingcap.com"}'; +SELECT * FROM information_schema.user_attributes; +``` + +```sql ++-----------+------+---------------------------------------------------+ +| USER | HOST | ATTRIBUTE | ++-----------+------+---------------------------------------------------+ +| root | % | NULL | +| testuser1 | % | {"comment": "This user is created only for test"} | +| testuser2 | % | {"email": "user@pingcap.com"} | ++-----------+------+---------------------------------------------------+ +3 rows in set (0.00 sec) +``` \ No newline at end of file diff --git a/information-schema/information-schema.md b/information-schema/information-schema.md index f10da32da2c25..96db8f13848c1 100644 --- a/information-schema/information-schema.md +++ b/information-schema/information-schema.md @@ -46,6 +46,7 @@ Many `INFORMATION_SCHEMA` tables have a corresponding `SHOW` command. The benefi | [`TABLE_CONSTRAINTS`](/information-schema/information-schema-table-constraints.md) | Provides information on primary keys, unique indexes and foreign keys. | | `TABLE_PRIVILEGES` | Not implemented by TiDB. Returns zero rows. | | `TRIGGERS` | Not implemented by TiDB. Returns zero rows. | +| [`USER_ATTRIBUTES`](/information-schema/information-schema-user-attributes.md) | Summarizes information about user comments and user attributes. | | [`USER_PRIVILEGES`](/information-schema/information-schema-user-privileges.md) | Summarizes the privileges associated with the current user. | | [`VARIABLES_INFO`](/information-schema/information-schema-variables-info.md) | Provides information about TiDB system variables. | | [`VIEWS`](/information-schema/information-schema-views.md) | Provides a list of views that the current user has visibility of. Similar to running `SHOW FULL TABLES WHERE table_type = 'VIEW'` | diff --git a/sql-statements/sql-statement-alter-user.md b/sql-statements/sql-statement-alter-user.md index ba1f4071b4847..3e5bfa7b506f1 100644 --- a/sql-statements/sql-statement-alter-user.md +++ b/sql-statements/sql-statement-alter-user.md @@ -12,7 +12,7 @@ This statement changes an existing user inside the TiDB privilege system. In the ```ebnf+diagram AlterUserStmt ::= - 'ALTER' 'USER' IfExists (UserSpecList RequireClauseOpt ConnectionOptions LockOption | 'USER' '(' ')' 'IDENTIFIED' 'BY' AuthString) + 'ALTER' 'USER' IfExists (UserSpecList RequireClauseOpt ConnectionOptions LockOption AttributeOption | 'USER' '(' ')' 'IDENTIFIED' 'BY' AuthString) UserSpecList ::= UserSpec ( ',' UserSpec )* @@ -27,6 +27,8 @@ AuthOption ::= ( 'IDENTIFIED' ( 'BY' ( AuthString | 'PASSWORD' HashString ) | 'WITH' StringName ( 'BY' AuthString | 'AS' HashString )? ) )? LockOption ::= ( 'ACCOUNT' 'LOCK' | 'ACCOUNT' 'UNLOCK' )? + +AttributeOption ::= ( 'COMMENT' CommentString | 'ATTRIBUTE' AttributeString )? ``` ## Examples @@ -63,14 +65,58 @@ ALTER USER 'newuser' ACCOUNT LOCK; Query OK, 0 rows affected (0.02 sec) ``` +Modify the attributes of `newuser`: + +```sql +ALTER USER 'newuser' ATTRIBUTE '{"newAttr": "value", "deprecatedAttr": null}'; +SELECT * FROM information_schema.user_attributes; +``` + +```sql ++-----------+------+--------------------------+ +| USER | HOST | ATTRIBUTE | ++-----------+------+--------------------------+ +| newuser | % | {"newAttr": "value"} | ++-----------+------+--------------------------+ +1 rows in set (0.00 sec) +``` + +Modify the comment of `newuser` using `ALTER USER ... COMMENT`: + +```sql +ALTER USER 'newuser' COMMENT 'Here is the comment'; +SELECT * FROM information_schema.user_attributes; +``` + +```sql ++-----------+------+--------------------------------------------------------+ +| USER | HOST | ATTRIBUTE | ++-----------+------+--------------------------------------------------------+ +| newuser | % | {"comment": "Here is the comment", "newAttr": "value"} | ++-----------+------+--------------------------------------------------------+ +1 rows in set (0.00 sec) +``` + +Remove the comment of `newuser` using `ALTER USER ... ATTRIBUTE`: + +```sql +ALTER USER 'newuser' ATTRIBUTE '{"comment": null}'; +SELECT * FROM information_schema.user_attributes; +``` + +```sql ++-----------+------+---------------------------+ +| USER | HOST | ATTRIBUTE | ++-----------+------+---------------------------+ +| newuser | % | {"newAttr": "value"} | ++-----------+------+---------------------------+ +1 rows in set (0.00 sec) +``` + > **Note:** > > Do not use `ACCOUNT UNLOCK` to unlock a [role](/sql-statements/sql-statement-create-role.md). Otherwise, the unlocked role can be used to log in to TiDB without password. -## MySQL compatibility - -* In MySQL this statement is used to change attributes such as to expire a password. This functionality is not yet supported by TiDB. - ## See also diff --git a/sql-statements/sql-statement-create-user.md b/sql-statements/sql-statement-create-user.md index d77e194be49cd..35a3629c92960 100644 --- a/sql-statements/sql-statement-create-user.md +++ b/sql-statements/sql-statement-create-user.md @@ -12,7 +12,7 @@ This statement creates a new user, specified with a password. In the MySQL privi ```ebnf+diagram CreateUserStmt ::= - 'CREATE' 'USER' IfNotExists UserSpecList RequireClauseOpt ConnectionOptions LockOption + 'CREATE' 'USER' IfNotExists UserSpecList RequireClauseOpt ConnectionOptions LockOption AttributeOption IfNotExists ::= ('IF' 'NOT' 'EXISTS')? @@ -31,6 +31,8 @@ StringName ::= | Identifier LockOption ::= ( 'ACCOUNT' 'LOCK' | 'ACCOUNT' 'UNLOCK' )? + +AttributeOption ::= ( 'COMMENT' CommentString | 'ATTRIBUTE' AttributeString )? ``` ## Examples @@ -73,6 +75,38 @@ CREATE USER 'newuser5'@'%' ACCOUNT LOCK; Query OK, 1 row affected (0.02 sec) ``` +Create a user with a comment. + +```sql +CREATE USER 'newuser6'@'%' COMMENT 'This user is created only for test'; +SELECT * FROM information_schema.user_attributes; +``` + +``` ++-----------+------+---------------------------------------------------+ +| USER | HOST | ATTRIBUTE | ++-----------+------+---------------------------------------------------+ +| newuser6 | % | {"comment": "This user is created only for test"} | ++-----------+------+---------------------------------------------------+ +1 rows in set (0.00 sec) +``` + +Create a user with an `email` attribute. + +```sql +CREATE USER 'newuser7'@'%' ATTRIBUTE '{"email": "user@pingcap.com"}'; +SELECT * FROM information_schema.user_attributes; +``` + +```sql ++-----------+------+---------------------------------------------------+ +| USER | HOST | ATTRIBUTE | ++-----------+------+---------------------------------------------------+ +| newuser7 | % | {"email": "user@pingcap.com"} | ++-----------+------+---------------------------------------------------+ +1 rows in set (0.00 sec) +``` + ## MySQL compatibility The following `CREATE USER` options are not yet supported by TiDB, and will be parsed but ignored: diff --git a/sql-statements/sql-statement-show-columns-from.md b/sql-statements/sql-statement-show-columns-from.md index f94a90618f9f8..79e15bb6a9f8b 100644 --- a/sql-statements/sql-statement-show-columns-from.md +++ b/sql-statements/sql-statement-show-columns-from.md @@ -111,44 +111,49 @@ mysql> show full columns from v1; 1 row in set (0.00 sec) mysql> show full columns from mysql.user; -+-----------------------+---------------+-------------+------+------+---------+-------+---------------------------------+---------+ -| Field | Type | Collation | Null | Key | Default | Extra | Privileges | Comment | -+-----------------------+---------------+-------------+------+------+---------+-------+---------------------------------+---------+ -| Host | char(64) | utf8mb4_bin | NO | PRI | NULL | | select,insert,update,references | | -| User | char(32) | utf8mb4_bin | NO | PRI | NULL | | select,insert,update,references | | -| authentication_string | text | utf8mb4_bin | YES | | NULL | | select,insert,update,references | | -| Select_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Insert_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Update_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Delete_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Create_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Drop_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Process_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Grant_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| References_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Alter_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Show_db_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Super_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Create_tmp_table_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Lock_tables_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Execute_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Create_view_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Show_view_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Create_routine_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Alter_routine_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Index_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Create_user_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Event_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Trigger_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Create_role_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Drop_role_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Account_locked | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Shutdown_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Reload_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| FILE_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -| Config_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | -+-----------------------+---------------+-------------+------+------+---------+-------+---------------------------------+---------+ -33 rows in set (0.01 sec) ++------------------------+---------------+-------------+------+------+---------+-------+---------------------------------+---------+ +| Field | Type | Collation | Null | Key | Default | Extra | Privileges | Comment | ++------------------------+---------------+-------------+------+------+---------+-------+---------------------------------+---------+ +| Host | char(255) | utf8mb4_bin | NO | PRI | NULL | | select,insert,update,references | | +| User | char(32) | utf8mb4_bin | NO | PRI | NULL | | select,insert,update,references | | +| authentication_string | text | utf8mb4_bin | YES | | NULL | | select,insert,update,references | | +| plugin | char(64) | utf8mb4_bin | YES | | NULL | | select,insert,update,references | | +| Select_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Insert_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Update_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Delete_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Create_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Drop_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Process_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Grant_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| References_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Alter_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Show_db_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Super_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Create_tmp_table_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Lock_tables_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Execute_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Create_view_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Show_view_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Create_routine_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Alter_routine_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Index_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Create_user_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Event_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Repl_slave_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Repl_client_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Trigger_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Create_role_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Drop_role_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Account_locked | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Shutdown_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Reload_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| FILE_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Config_priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| Create_Tablespace_Priv | enum('N','Y') | utf8mb4_bin | NO | | N | | select,insert,update,references | | +| User_attributes | json | NULL | YES | | NULL | | select,insert,update,references | | ++------------------------+---------------+-------------+------+------+---------+-------+---------------------------------+---------+ +38 rows in set (0.00 sec) ``` ## MySQL compatibility