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

# DESCRIBE EDGE TYPE

`DESCRIBE EDGE TYPE`命令返回关于边类型的详细信息，返回信息包含以下列：

 | 列 | 描述
 | `property_name` | 边类型属性的名称。
 | `data_type` | 边类型属性的值类型。
 | `multi_edge_key` | 指示边类型的属性是否用于创建多边键。
如果是，值为`Y`；否则，值为空。
 | `nullable` | 指示边类型的属性是否可以为`NULL`。有效值：`true`和`false`。
 | `default` | 边类型属性的默认值。

Note

对非默认 Schema 或其中的对象执行操作时，用户既要通过隐式访问规则或显式`USAGE`授权获得该 Schema 的访问权，也要具备目标操作所需的权限。Schema 访问校验和目标操作所需的权限校验相互独立，满足其中一项不能替代另一项。Schema 访问控制不适用于临时图、内置 Procedure 和内置 Function。更多信息，请参见 [Schema 访问控制](https://dev-docs.yueshu.com.cn/v5.3.2/server-admin/authorization/schema-access-control/)。

## 语法

语法图源码

 describe_edge_type_command  

````
describe_edge_type_command ::=
    ( 'DESCRIBE' | 'DESC' ) 'EDGE TYPE' edge_type_name 'OF' (schema_reference '/')? graph_type_name 

````

## 参数

### `edge_type_name`

待查询的边类型的名称。

### `schema_reference`

所引用的 Schema 路径。此处即待查看边类型所属图类型所在的 Schema 路径。

绝对路径或相对路径均可在命令中使用。若待查看的边类型所属图类型不在当前会话的 Schema 中，则需指定对应 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/)。

### `graph_type_name`

边类型所属图类型的名称。

## 示例

以下示例基于[示例数据集](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/overview/example-dataset/)。

### 查看当前 Schema 中图类型的边类型信息

````
DESCRIBE EDGE TYPE Watch OF movie_type

````

返回：

````
+---------------+-----------+----------------+----------+---------+
| property_name | data_type | multi_edge_key | nullable | default |
+---------------+-----------+----------------+----------+---------+
| rate          | FLOAT     |                | true     | NULL    |
+---------------+-----------+----------------+----------+---------+

````

### 查看指定 Schema 中图类型的边类型信息

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

'''
// 为当前会话设置 Schema
SESSION SET SCHEMA /my_schema
'''

'''
// 查看指定 Schema 中图类型的边类型信息
DESCRIBE EDGE TYPE Watch OF /default_schema/movie_type
'''

````

返回：

````
+---------------+-----------+----------------+----------+---------+
| property_name | data_type | multi_edge_key | nullable | default |
+---------------+-----------+----------------+----------+---------+
| rate          | FLOAT     |                | true     | NULL    |
+---------------+-----------+----------------+----------+---------+

````