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.

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 and format #1104

Merged
merged 1 commit into from
Feb 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions docs-2.0/nebula-studio/about-studio/st-ug-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ On the **Console** page of Docker-based and RPM-based Studio v3.x, all the nGQL
- `USE <space_name>`: You cannot run such a statement on the **Console** page to choose a graph space. As an alternative, you can click a graph space name in the drop-down list of **Current Graph Space**.
- You cannot use line breaks (\\). As an alternative, you can use the Enter key to split a line.

<!--
For Studio on Cloud, besides the preceding syntax, you cannot run these account and role management statements on the Console page:

- `CREATE USER`
Expand All @@ -56,7 +55,6 @@ For Studio on Cloud, besides the preceding syntax, you cannot run these account
- `REVOKE ROLE`

For more information about the preceding statements, see[User management](../../7.data-security/1.authentication/2.management-user.md)
-->

## Browser

Expand Down
2 changes: 2 additions & 0 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ Before installing Studio, you need to install the following software and ensure
```

2. Make the `nebula-studio` directory the current working directory.

```bash
$ cd nebula-studio
```

3. Assume using release name:`my-studio`, installed Studio in Helm Chart.

```bash
$ helm upgrade --install my-studio --set service.type=NodePort --set service.port=30070 deployment/helm
```
Expand Down
10 changes: 5 additions & 5 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ If the port is occupied and the process on that port cannot be terminated, you c
//Open the configuration file
$ vi config/config.default.js

//Change the port number
//Change the port
web:
# task_id_path:
# upload_dir:
Expand Down Expand Up @@ -183,11 +183,11 @@ Before you deploy DEB-based Studio, you must do a check of these:

2. Use `sudo dpkg -i <deb>` to install DEB package.

For example, install Studio {{studio.release}}, use the following command:
For example, install Studio {{studio.release}}, use the following command:

```bash
$ sudo dpkg -i nebula-graph-studio-{{ studio.release }}.x86_64.deb
```
```bash
$ sudo dpkg -i nebula-graph-studio-{{ studio.release }}.x86_64.deb
```

3. When Studio is started, use `http://ip address:7001` to get access to Studio.

Expand Down
Binary file added docs-2.0/nebula-studio/figs/chaxun.png
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-045.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-046-1.png
Binary file not shown.
Binary file added docs-2.0/nebula-studio/figs/st-ug-046.png
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-055-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-055.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To create an index on the **Schema** page, follow these steps:

6. When the settings are done, the **Equivalent to the following nGQL statement** panel shows the statement equivalent to the settings.

![A page for index creation](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-030.png "Create an index")
![A page for index creation](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-030.png "Create an index")

7. Confirm the settings and then click the **+ Create** button. When an index is created, the index list shows the new index.

Expand Down
16 changes: 8 additions & 8 deletions docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To create a tag on the **Schema** page, follow these steps:

- To cancel a defined property: Besides the **Defaults** column, click the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "Cancel").

c. (Optional) If no index is set for the tag, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to Nebula Graph website").
c. (Optional) If no index is set for the tag, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to Nebula Graph website").

6. When the preceding settings are completed, in the **Equivalent to the following nGQL statement** panel, you can see the nGQL statement equivalent to these settings.

Expand All @@ -60,19 +60,19 @@ To edit a tag on the **Schema** page, follow these steps:

5. On the **Edit** page, do these settings:

- To edit a Comment: Click **Edit** under the **Name**.
- To edit a Comment: Click **Edit** under the **Name**.

- To edit a property: On the **Define Properties** panel, find a property, click **Edit**, and then change the data type or the default value.
- To edit a property: On the **Define Properties** panel, find a property, click **Edit**, and then change the data type or the default value.

- To delete a property: On the **Define Properties** panel, find a property and then click **Delete**.
- To delete a property: On the **Define Properties** panel, find a property and then click **Delete**.

- To add more properties: On the **Define Properties** panel, click the **Add Property** button to add a new property.
- To add more properties: On the **Define Properties** panel, click the **Add Property** button to add a new property.

- To set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box and then set the TTL configuration.
- To set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box and then set the TTL configuration.

- To edit the TTL configuration: On the **Set TTL** panel, click **Edit** and then change the configuration of `TTL_COL` and `TTL_DURATION`.
- To edit the TTL configuration: On the **Set TTL** panel, click **Edit** and then change the configuration of `TTL_COL` and `TTL_DURATION`.

- To delete the TTL configuration: When the **Set TTL** panel is expanded, in the upper left corner of the panel, click the check box to delete the configuration.
- To delete the TTL configuration: When the **Set TTL** panel is expanded, in the upper left corner of the panel, click the check box to delete the configuration.

6. When the configuration is done, in the **Equivalent to the following nGQL statement** panel, you can see the equivalent `ALTER TAG` statement.

Expand Down
13 changes: 7 additions & 6 deletions docs-2.0/nebula-studio/quick-start/st-ug-import-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,21 +36,22 @@ To batch import data, follow these steps:

7. In the **vertexId** section, do these operations:

a. In the **CSV Index** column, click **Mapping**.
![Click "Mapping** in the CSV Index column](../figs/st-ug-032-1.png "Choose the source for vertexId")
a. In the **CSV Index** column, click **Mapping**.
![Click "Mapping** in the CSV Index column](../figs/st-ug-032-1.png "Choose the source for vertexId")

b. In the dialog box, choose a column from the CSV file. In this example, the only one cloumn of `vertex_player.csv` is chosen to generate VIDs representing players and the `playerID` column of `vertex_player.csv` is chosen to generate VIDs representing players.
b. In the dialog box, choose a column from the CSV file. In this example, the only one cloumn of `vertex_player.csv` is chosen to generate VIDs representing players and the `playerID` column of `vertex_player.csv` is chosen to generate VIDs representing players.

!!! Note

In the same graph space, the VID is always unique and cannot be repeated. For VID information, see [VID](../../1.introduction/3.vid.md) "Click to enter the Nebula Graph Manual".

8. In the **TAG 1** section, do these operations:
a. In the **TAG** drop-down list, choose a tag name. In this example, **player** is used for the `vertex_player.csv` file, and **team** is used for the `vertex_team.csv` file.

b. In the property list, click **Mapping** to choose a data column from the CSV file as the value of a property. In this example, for the **player** tag, choose **Column 1** for the `age` property and set its type to **int**. And choose **Column 2** for the `name` property and set its type to **string**.
a. In the **TAG** drop-down list, choose a tag name. In this example, **player** is used for the `vertex_player.csv` file, and **team** is used for the `vertex_team.csv` file.

![Data source for the course vertices](../figs/st-ug-033-1.png "Choose data source for tag properties")
b. In the property list, click **Mapping** to choose a data column from the CSV file as the value of a property. In this example, for the **player** tag, choose **Column 1** for the `age` property and set its type to **int**. And choose **Column 2** for the `name` property and set its type to **string**.

![Data source for the course vertices](../figs/st-ug-033-1.png "Choose data source for tag properties")

9. (Optional) If necessary, repeat Step 5 through Step 8 for more tags.

Expand Down
19 changes: 10 additions & 9 deletions docs-2.0/nebula-studio/use-console/st-ug-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@

Studio console interface as shown in following.

![console interface](../figs/st-ug-055.png "console")
![console interface](../figs/st-ug-055-1.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](st-ug-open-in-explore.md) and [view subgraphs](st-ug-visualize-subgraph.md). |
| 3 | custom parameters display | Click the ![Query](../figs/chaxun.png) button to expand the custom parameters for parameterized query. For details, see [Manage parameters](../../nebula-console.md). |
| 4 | 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 `;`. |
| 5 | clean input box | Click ![clean](../figs/st-ug-056.png) button to clear the content entered in the input box. |
| 6 | 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. |
| 7 | 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. |
| 9 | 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. |
| 9 | 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. |
| 10 | 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. |
| 11 | 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](st-ug-open-in-explore.md) and [view subgraphs](st-ug-visualize-subgraph.md). |
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To query the paths or subgraph on the **Console** page and then view them on the

Take the `FIND ALL PATH` for example, query the path information as shown in this figure.

![The result window shows the queried paths](../figs/st-ug-045.png "The queried PATHs")
![The result window shows the queried paths](../figs/st-ug-045.png)

4. Click the **View Subgraphs** button.

Expand Down