Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update studio console #652

Merged
merged 1 commit into from
Aug 31, 2021
Merged

update studio console #652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs-2.0/nebula-studio/figs/st-ug-055.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-studio/figs/st-ug-056.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-studio/figs/st-ug-057.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions docs-2.0/nebula-studio/use-console/st-ug-console.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Console

Studio console interface as shown in following.

![console interface](../figs/st-ug-055.png "console")

The following table lists various functions on the console interface.

| number | function | descriptions |
| :----- | :-------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1 | toolbar | Click the **Console** tab to enter the console page. |
| 2 | select a space | Select a space in the Current Graph Space list. <br/> **descriptions**：Studio does not support running the `USE <space_name>` statements directly in the input box. |
| 3 | input box | After inputting the nGQL statements, click the ![run](../figs/st-ug-008.png) button to run the statement. You can input multiple statements and run them at the same time, separated by `;`. |
| 4 | clean input box | Click ![clean](../figs/st-ug-056.png) button to clear the content entered in the input box. |
| 5 | history list | Click ![history](../figs/st-ug-057.png) button representing the statement record. In the statement running record list, click one of the statements, and the statement will be automatically entered in the input box. The list provides the record of the last 15 statements. |
| 6 | run | After inputting the nGQL statement in the input box, click ![run](../figs/st-ug-008.png) button to indicate the operation to start running the statement. |
| 7 | statement running status | After running the nGQL statement, the statement running status is displayed. If the statement runs successfully, the statement is displayed in green. If the statement fails, the statement is displayed in red. |
| 8 | result window | Display the results of the statement execution. If the statement returns results, the results window will display the returned results in tabular form. |
| 9 | export CSV file | After running the nGQL statement and return the result, click the **Export CSV File** button to export the result as a CSV file. |
| 10 | open in explore | According to the running nGQL statement, the user can click the graph exploration function key to import the returned results into graph exploration for visual display, such as [open in explore](../use-console/st-ug-open-in-explore.md) and [view subgraphs](../use-console/st-ug-visualize-subgraph.md). |