blob: 21751f32008cb8b87fde33c3029d85a37632e19f [file] [log] [blame] [view]
---
{
"title": "ALTER-USER",
"language": "en"
}
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
## ALTER USER
### Name
ALTER USER
### Description
The ALTER USER command is used to modify a user's account attributes, including passwords, and password policies, etc.
>Note that.
>
>This command give over supports modifying user roles from versions 2.0. Please use [GRANT](./GRANT.md) and [REVOKE](./REVOKE.md) for related operations
```sql
ALTER USER [IF EXISTS] user_identity [IDENTIFIED BY 'password']
[password_policy]
[comment]
user_identity:
'user_name'@'host'
password_policy:
1. PASSWORD_HISTORY [n|DEFAULT]
2. PASSWORD_EXPIRE [DEFAULT|NEVER|INTERVAL n DAY/HOUR/SECOND]
3. FAILED_LOGIN_ATTEMPTS n
4. PASSWORD_LOCK_TIME [n DAY/HOUR/SECOND|UNBOUNDED]
5. ACCOUNT_UNLOCK
```
About `user_identity` and `password_policy`, Please refer to `CREATE USER`.
`ACCOUNT_UNLOCK` is used to unlock a locked user.
In an ALTER USER command, only one of the following account attributes can be modified at the same time:
1. Change password
2. Modify `PASSWORD_HISTORY`
3. Modify `PASSWORD_EXPIRE`
4. Modify `FAILED_LOGIN_ATTEMPTS` and `PASSWORD_LOCK_TIME`
5. Unlock users
### Example
1. Change the user's password
```
ALTER USER jack@'%' IDENTIFIED BY "12345";
```
2. Modify the user's password policy
```
ALTER USER jack@'%' FAILED_LOGIN_ATTEMPTS 3 PASSWORD_LOCK_TIME 1 DAY;
```
3. Unlock a user
```
ALTER USER jack@'%' ACCOUNT_UNLOCK
```
4. Modify the user's comment
```
ALTER USER jack@'%' COMMENT "this is my first user"
```
### Keywords
ALTER, USER
### Best Practice
1. Modify the password policy
1. Modify `PASSWORD_EXPIRE` will reset the timing of password expiration time.
2. Modify `FAILED_LOGIN_ATTEMPTS` or `PASSWORD_LOCK_TIME` will unlock the user.