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

# DESCRIBE GRAPH TYPE

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

 | 列 | 描述
 | `entity_type` | 图元素的类型。有效值：`Node`和`Edge`。
 | `type_name` | 图元素类型的名称。
 | `type_pattern` | 图元素类型的模式。
如果图元素是点，模式格式为`(node_type_name)`。
如果图元素是有向边，模式格式为`(source_node_type_name)-[edge_type_name]->(destination_node_type_name)`。
如果图元素是无向边，模式格式为`(node_type_name_1)~[edge_type_name]~(node_type_name_2)`。
 | `labels` | 图元素的标签。
 | `primary_key/multiedge_key` | 图元素的主键或多边键。更多信息，请参见 [CREATE GRAPH TYPE](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/ddl/graph-type/create/)。
 | `properties` | 图元素的属性名称。

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_graph_type_command  

````
describe_graph_type_command ::=
    ( 'DESCRIBE' | 'DESC' ) 'GRAPH TYPE' (schema_reference '/')? graph_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 GRAPH TYPE movie_type

````

返回：

````
+-------------+-----------+------------------------------+-------------+---------------------------+---------------------+
| entity_type | type_name | type_pattern                 | labels      | primary_key/multiedge_key | properties          |
+-------------+-----------+------------------------------+-------------+---------------------------+---------------------+
| Node        | Actor     | (Actor)                      | [Person]    | [id]                      | [id,name,birthDate] |
| Node        | Director  | (Director)                   | [Person]    | [id]                      | [id,name,birthDate] |
| Node        | User      | (User)                       | [Person]    | [id]                      | [id]                |
| Node        | Movie     | (Movie)                      | [Movie]     | [id]                      | [id,name]           |
| Node        | Genre     | (Genre)                      | [Genre]     | [id]                      | [id,name]           |
| Edge        | Act       | (Actor)-[Act]->(Movie)       | [Act]       | Unique                    | []                  |
| Edge        | Direct    | (Director)-[Direct]->(Movie) | [Direct]    | Unique                    | []                  |
| Edge        | Watch     | (User)-[Watch]->(Movie)      | [Watch]     | Unique                    | [rate]              |
| Edge        | WithGenre | (Movie)-[WithGenre]->(Genre) | [WithGenre] | Unique                    | []                  |
+-------------+-----------+------------------------------+-------------+---------------------------+---------------------+

````

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

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

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

'''
// 查看指定 Schema 中图类型信息
DESCRIBE GRAPH TYPE /default_schema/movie_type
'''

````

返回：

````
+-------------+-----------+------------------------------+-------------+---------------------------+---------------------+
| entity_type | type_name | type_pattern                 | labels      | primary_key/multiedge_key | properties          |
+-------------+-----------+------------------------------+-------------+---------------------------+---------------------+
| Node        | Actor     | (Actor)                      | [Person]    | [id]                      | [id,name,birthDate] |
| Node        | Director  | (Director)                   | [Person]    | [id]                      | [id,name,birthDate] |
| Node        | User      | (User)                       | [Person]    | [id]                      | [id]                |
| Node        | Movie     | (Movie)                      | [Movie]     | [id]                      | [id,name]           |
| Node        | Genre     | (Genre)                      | [Genre]     | [id]                      | [id,name]           |
| Edge        | Act       | (Actor)-[Act]->(Movie)       | [Act]       | Unique                    | []                  |
| Edge        | Direct    | (Director)-[Direct]->(Movie) | [Direct]    | Unique                    | []                  |
| Edge        | Watch     | (User)-[Watch]->(Movie)      | [Watch]     | Unique                    | [rate]              |
| Edge        | WithGenre | (Movie)-[WithGenre]->(Genre) | [WithGenre] | Unique                    | []                  |
+-------------+-----------+------------------------------+-------------+---------------------------+---------------------+

````