DESCRIBE NODE TYPE command¶

The DESCRIBE NODE TYPE command returns detailed information about a node type in a table that consists of the following columns:

Column	Description
`property_name`	The name of the property of the node type.
`data_type`	The value type of the property of the node type.
`primary_key`	Indicates whether the property of the node type is used to form the primary key. If yes, the value is `Y`; otherwise, the value is empty.
`nullable`	Indicates whether the property of the node type can be `NULL`. Valid values: `true` and `false`.
`default`	The default value of the property of the node type.

Note

An operation involving a non-default schema or an object in it requires access to the schema, either implicitly or through an explicit USAGE grant, as well as the privilege required for the operation. The schema access check and the privilege check for the requested operation are independent; satisfying one does not satisfy the other. Schema access control does not apply to temporary graphs or built-in procedures and functions. For more information, see Schema access control.

Syntax¶

diagramsource

describe_node_type_command

describe_node_type_command ::=
    ( 'DESCRIBE' | 'DESC' ) 'NODE TYPE' node_type_name 'OF' (schema_reference '/')? graph_type_name

Parameters¶

`node_type_name`¶

The name of the node type that you want to know details about.

`schema_reference`¶

The reference to the path of the schema. It specifies the schema path of the graph type that contains the node type here.

Both absolute and relative schema paths can be used in the command. To view detailed information about a node type in a graph type that resides outside the schema in the current session, the schema path must be specified. For information about setting and viewing the schema for the current session, see SESSION SET and SHOW CURRENT_SCHEMA.

`graph_type_name`¶

The name of the graph type that contains the node type.

Examples¶

The following examples are based on the example dataset.

Describe a node type¶

DESCRIBE NODE TYPE Actor OF movie_type

Return:

+---------------+-----------+-------------+----------+---------+
| property_name | data_type | primary_key | nullable | default |
+---------------+-----------+-------------+----------+---------+
| id            | INT64     | Y           | false    |         |
| name          | STRING    |             | true     | NULL    |
| birthDate     | DATE      |             | true     | NULL    |
+---------------+-----------+-------------+----------+---------+

Describe a node type of a graph type in the specified schema¶

'''
// Create a schema
CREATE SCHEMA IF NOT EXISTS /my_schema 
'''

'''
// Set the schema for the current session
SESSION SET SCHEMA /my_schema
'''

'''
// Describe a node type of a graph type in the specified schema
DESCRIBE NODE TYPE Actor OF /default_schema/movie_type
'''

Return:

+---------------+-----------+-------------+----------+---------+
| property_name | data_type | primary_key | nullable | default |
+---------------+-----------+-------------+----------+---------+
| id            | INT64     | Y           | false    |         |
| name          | STRING    |             | true     | NULL    |
| birthDate     | DATE      |             | true     | NULL    |
+---------------+-----------+-------------+----------+---------+

DESCRIBE NODE TYPE command¶

Syntax¶

Parameters¶

node_type_name¶

schema_reference¶

graph_type_name¶