Source: https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/data-admin/invite-user/
Documentation version: v5.3.2

# INVITE USER

`INVITE USER`命令用于邀请用户加入服务组。

在邀请用户时，您可以选择为该用户设置主 Schema 和主图。主 Schema 和主图将在用户连接服务组时作为会话的默认 Schema 和图。

用户被邀请后，您须授予其在服务组上执行`CONNECT`操作的权限，该用户才能连接到服务组。此外，如果要访问服务组中的资源，用户还必须具有访问这些资源所需的相应角色或权限。更多信息，请参见[授权](https://dev-docs.yueshu.com.cn/v5.3.2/server-admin/authorization/)。

## 前提条件

- 要邀请用户，您必须是拥有该服务组的`ADMIN`角色的用户。
- 待邀请的用户已创建。更多信息，请参见[创建用户](https://dev-docs.yueshu.com.cn/v5.3.2/server-admin/authentication/manage-users/)。

## 语法

语法图源码

 invite_user_command  

````
invite_user_command ::=
    'INVITE' 'USER' user_name ('SCHEMA' schema_reference)? ('GRAPH' (schema_reference '/')? graph_name)?

````

## 参数

### `user_name`

待邀请的用户的名称。

### `schema_reference`

所引用的 Schema 路径。

- 为待邀请的用户设置主 Schema 时，`schema_reference`为要设置为主 Schema 的所在路径。若未指定路径，该用户的主 Schema 默认为`/default_schema`。
- 为待邀请的用户设置主图时，`schema_reference`为要设置为主图的图所在的 Schema 路径。若想将不在当前会话中的 Schema 中的图设置为待邀请用户的主图，则必须指定对应 Schema 路径。若未指定，则所设置主图必须在当前 Schema 中。

路径区分大小写，必须与现有的 Schema 路径匹配。绝对路径或相对路径均可在命令中使用。您可以使用 [CREATE SCHEMA](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/ddl/schema/create/) 创建 Schema。关于为当前会话设置和查看 Schema 的更多信息，请参见 [SESSION SET](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/sessions/set/) 和 [SHOW CURRENT_SCHEMA](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/data-admin/show/show-current-schema/)。

Note

邀请用户时设置主 Schema 或主图，不会授予用户父级 Schema 的`USAGE`。如果主 Schema 不是`/default_schema`，需要单独授予所需的`USAGE`。更多信息，请参见 [Schema 访问控制](https://dev-docs.yueshu.com.cn/v5.3.2/server-admin/authorization/schema-access-control/)。

### `graph_name`

要设置为该用户的主图的名称。

名称区分大小写，必须与`schema_reference`指定的 Schema 中的现有图的名称匹配。您可以使用 [CREATE GRAPH](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/ddl/graph/create/) 创建图。

若未指定，则不为该用户设置主图。

## 示例

### 邀请用户并将当前 Schema 设置为该用户的主 Schema

````
INVITE USER user1 SCHEMA /default_schema

````

上述示例演示了如何邀请用户`user1`，并为其设置主 Schema。

### 邀请用户并将当前 Schema 中的图设置为该用户的主图

````
'''
// 创建一个 Schema
CREATE SCHEMA IF NOT EXISTS /my_schema
'''

'''
// 将当前会话的 Schema 设置为新建的 Schema
SESSION SET SCHEMA /my_schema
'''

'''
// 在新建的 Schema 中创建图类型
CREATE GRAPH TYPE IF NOT EXISTS home_graph_type AS {}
'''

'''
// 在新建的 Schema 中创建图
CREATE GRAPH IF NOT EXISTS test_graph TYPED home_graph_type
'''

'''
// 邀请用户 user1，并为其设置主图
INVITE USER user1 GRAPH test_graph
'''

````

上述示例演示了如何邀请用户`user1`，并将当前 Schema 中的所创建的图`test_graph`设置为主图。

### 邀请用户并将指定 Schema 中的图设置为该用户的主图

````
'''
// 在默认 Schema 中创建图类型
CREATE GRAPH TYPE IF NOT EXISTS home_graph_type AS {}
'''

'''
// 在默认 Schema 中创建图
CREATE GRAPH IF NOT EXISTS test_graph TYPED home_graph_type
'''

'''
// 创建 Schema
CREATE SCHEMA IF NOT EXISTS /my_schema
'''

'''
// 将当前会话的 Schema 设置为新建的 Schema
SESSION SET SCHEMA /my_schema
'''

'''
// 邀请用户 user1，并为其设置主图
INVITE USER user1 GRAPH /default_schema/test_graph
'''

````

上述示例演示了如何邀请用户`user1`，并在当前会话的 Schema 为`/my_schema`的情况下将默认 Schema 中的`test_graph`设置为主图。