Skip to content

Commit

Permalink
Update (#691)
Browse files Browse the repository at this point in the history
* update

* update
  • Loading branch information
izhuxiaoqing authored Sep 3, 2021
1 parent 8eee607 commit c282569
Show file tree
Hide file tree
Showing 8 changed files with 42 additions and 41 deletions.
16 changes: 7 additions & 9 deletions docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Operate edge types

After a graph space is created in Nebula Graph, you can create edge types. With Studio, you can choose to use the **Console** page or the **Schema** page to create, retrieve, update, or delete edge types. This article only introduces how to use the **Schema** page to operate edge types in a graph space.
After a graph space is created in Nebula Graph, you can create edge types. With Studio, you can choose to use the **Console** page or the **Schema** page to create, retrieve, update, or delete edge types. This topic introduces how to use the **Schema** page to operate edge types in a graph space only.

## Studio version

Expand Down Expand Up @@ -28,27 +28,25 @@ To create an edge type on the **Schema** page, follow these steps:

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

a. **Name**: Specify an appropriate name for the edge type. In this example, `serve` is used.
- **Name**: Specify an appropriate name for the edge type. In this example, `serve` is used.

b. (Optional) If necessary, under the name, click the **Comment** to input content.
- (Optional) If necessary, under the name, click the **Comment** to input content.

c. (Optional) If necessary, in the upper left corner of the **Define Properties** panel, click the check box to expand the panel and do these settings:
- (Optional) If necessary, in the upper left corner of the **Define Properties** panel, click the check box to expand the panel and do these settings:

- To define a property: Enter a property name, a data type, and a default value.

- To add multiple properties: Click the **Add Property** button and define more properties.

- 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").
- To delete 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").

d. (Optional) If no index is set for the edge type, 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").
- (Optional) If no index is set for the edge type, 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.

![Define properties of the `action` edge type](../figs/st-ug-027-1.png "Define an edge type")

7. Confirm the settings and then click the **+ Create** button.

When the edge type is created successfully, the **Define Properties** panel shows all its properties on the list.
7. Confirm the settings and then click the **+ Create** button. When the edge type is created successfully, the **Define Properties** panel shows all its properties on the list.

## Edit an edge type

Expand Down
5 changes: 2 additions & 3 deletions docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Operate Indexes

You can create an index for a Tag and/or an Edge type. An index lets traversal start from vertices or edges with the same property and it can make a query more efficient. You can create two index types: Tag Index and Edge type Index. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, and delete indexes. This article introduces how to use the **Schema** page to operate an index.
You can create an index for a Tag and/or an Edge type. An index lets traversal start from vertices or edges with the same property and it can make a query more efficient. You can create two index types: Tag Index and Edge type Index. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, and delete indexes. This topic introduces how to use the **Schema** page to operate an index only.

!!! note

Expand Down Expand Up @@ -46,8 +46,7 @@ To create an index on the **Schema** page, follow these steps:

![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.
7. Confirm the settings and then click the **+ Create** button. When an index is created, the index list shows the new index.

## View indexes

Expand Down
13 changes: 6 additions & 7 deletions docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ To create a graph space on the **Schema** page, follow these steps:
2. On the **Graph Space List** page, click the **+ Create** button.
3. On the **Create** page, do these settings:

a. **Name**: Specify a name to the new graph space. In this example, `basketballplayer` is used. The name must be distinct in the database. The name cannot be used keywords or reserved keywords as identifiers. For more information, see [keywords](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md).
- **Name**: Specify a name to the new graph space. In this example, `basketballplayer` is used. The name must be distinct in the database. The name cannot be used keywords or reserved keywords as identifiers. For more information, see [keywords](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md).

b. **Vid type**: The data types of VIDs are restricted to `FIXED_STRING(<N>)` or `INT64`; a graph space can only select one VID type, `FIXED_STRING(32)` is used. For more information, see [VID](../../1.introduction/3.vid.md).
- **Vid type**: The data types of VIDs are restricted to `FIXED_STRING(<N>)` or `INT64`. A graph space can only select one VID type. In this example, `FIXED_STRING(32)` is used. For more information, see [VID](../../1.introduction/3.vid.md).

c. **Comment**: The remarks of a certain property or the space itself. The maximum length is 256 bytes. By default, there will be no comments on a space. But in this example, `Statistics of basketball players` is used.
- **Comment**: The remarks of a certain property or the space itself. The maximum length is 256 bytes. By default, there will be no comments on a space. But in this example, `Statistics of basketball players` is used.

d. **Optional Parameters**: Set `partition_num`, `replica_factor`. In this example, these parameters are set to `100` and `1` separately. For more information, see [`CREATE SPACE` syntax](../../3.ngql-guide/9.space-statements/1.create-space.md "Click to go to the Nebula Graph website").
- **Optional Parameters**: Set the values of `partition_num` and `replica_factor` respectively. In this example, these parameters are set to `100` and `1` respectively. For more information, see [`CREATE SPACE` syntax](../../3.ngql-guide/9.space-statements/1.create-space.md "Click to go to the Nebula Graph website").

In the **Equivalent to the following nGQL statement** panel, you can see the statement equivalent to the preceding settings.
In the **Equivalent to the following nGQL statement** panel, you can see the statement equivalent to the preceding settings.

```bash
CREATE SPACE basketballplayer (partition_num = 100, replica_factor = 1, vid_type = FIXED_STRING(32)) COMMENT = "Statistics of basketball players"
Expand All @@ -53,8 +53,7 @@ To delete a graph space on the **Schema** page, follow these steps:
2. In the graph space list, find a graph space and then the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "Delete") in the **Operations** column.

![Graph space list with the graph space to be deleted](./../figs/st-ug-029.png)
3. On the dialog box, confirm the information and then click the **OK** button.
When the graph space is deleted successfully, it is removed from the graph space list.
3. On the dialog box, confirm the information and then click the **OK** button. When the graph space is deleted successfully, it is removed from the **graph space list**.

## Next to do

Expand Down
22 changes: 11 additions & 11 deletions docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Operate tags

After a graph space is created in Nebula Graph, you can create tags. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, update, or delete tags. This article only introduces how to use the **Schema** page to operate tags in a graph space.
After a graph space is created in Nebula Graph, you can create tags. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, update, or delete tags. This topic introduces how to use the **Schema** page to operate tags in a graph space only.

## Studio version

Expand Down Expand Up @@ -28,25 +28,23 @@ To create a tag on the **Schema** page, follow these steps:

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

a. **Name**: Specify an appropriate name for the tag. In this example, `course` is specified.
a. **Name**: Specify an appropriate name for the tag. In this example, `player` and `team` are specified.

b. (Optional) If necessary, in the upper left corner of the **Define Properties** panel, click the check box to expand the panel and do these settings:
b. (Optional) If necessary, in the upper left corner of the **Define Properties** panel, click the check box to expand the panel and do these settings:

- To define a property: Enter a property name, a data type, and a default value.
- To define a property: Enter a property name, a data type, and a default value.

- To add multiple properties: Click the **Add Property** button and define more properties.
- To add multiple properties: Click the **Add Property** button and define more properties.

- 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").
- 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.

![Define properties of the `course` tag](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-028.png "Define a tag")

7. Confirm the settings and then click the **+ Create** button.

When the tag is created successfully, the **Define Properties** panel shows all its properties on the list.
7. Confirm the settings and then click the **+ Create** button. When the tag is created successfully, the **Define Properties** panel shows all its properties on the list.

## Edit a tag

Expand All @@ -62,7 +60,7 @@ 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.

Expand Down Expand Up @@ -95,6 +93,8 @@ To delete a tag on the **Schema** page, follow these steps:

4. Click the **Tag** tab, find a tag and then the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png) in the **Operations** column.

5. CLick **OK**.

## Next to do

After the tag is created, you can use the **Console** page to insert vertex data one by one manually or use the **Import** page to bulk import vertex data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Check Nebula Graph service status. Regarding the operation of viewing services:

- If you use Nebula Graph deployed by Docker Compose and RPM, refer to the [Nebula Graph service status and ports](../deploy-connect/st-ug-deploy.md).

If the Nebula Graph service is normal, proceed to Step4 to continue troubleshooting. Otherwise, please restart Nebula Graph service.
If the Nebula Graph service is normal, proceed to Step 4 to continue troubleshooting. Otherwise, please restart Nebula Graph service.

!!! Note

Expand Down
17 changes: 7 additions & 10 deletions docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
# FAQ

!!! faq "Why can't I use a function?"
**Why can't I use a function?**

If you find that a function cannot be used, it is recommended to troubleshoot the problem according to the following steps:

1. Confirm that Nebula Graph is the latest version. If you use Docker Compose to deploy the Nebula Graph database, it is recommended to run `docker-compose pull && docker-compose up -d` to pull the latest Docker image and start the container.

2. Confirm that Studio is the latest version. For more information, refer to [check updates](../about-studio/st-ug-check-updates.md).

3. Search the [nebula forum](https://discuss.nebula-graph.io/), [nebula](https://github.com/vesoft-inc/nebula) and [nebula-studio](https://github.com/vesoft-inc/nebula-studio) projects on the GitHub to confirm if there are already similar problems.

4. If none of the above steps solve the problem, you can submit a problem on the forum.
If you find that a function cannot be used, it is recommended to troubleshoot the problem according to the following steps:

1. Confirm that Nebula Graph is the latest version. If you use Docker Compose to deploy the Nebula Graph database, it is recommended to run `docker-compose pull && docker-compose up -d` to pull the latest Docker image and start the container.
2. Confirm that Studio is the latest version. For more information, refer to [check updates](../about-studio/st-ug-check-updates.md).
3. Search the [nebula forum](https://discuss.nebula-graph.io/), [nebula](https://github.com/vesoft-inc/nebula) and [nebula-studio](https://github.com/vesoft-inc/nebula-studio) projects on the GitHub to confirm if there are already similar problems.
4. If none of the above steps solve the problem, you can submit a problem on the forum.
4 changes: 4 additions & 0 deletions docs-2.0/nebula-studio/use-console/st-ug-open-in-explore.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

With the **Open in Explore** function, you can run nGQL statements on the **Console** page to query vertex or edge data and then view the result on the **Explore** page in a visualized way.

## Supported versions

Studio of v{{ studio.release }} or later versions supports this function. For more information, see [check updates](../about-studio/st-ug-check-updates.md).

## Prerequisites

To use the **Open in Explore** function, you must do a check of these:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ To use the **View Subgraphs** function, you must do a check of these:

- A dataset exists in the database. In the example of this article, the **basketballplayer** dataset is used. For more information, see [Import data](../quick-start/st-ug-import-data.md).

!!! Note

Users can view subgraphs online in [Studio](https://playground.nebula-graph.com.cn/explore).

## Procedure

To query the paths or subgraph on the **Console** page and then view them on the **Explore** page, follow these steps:
Expand Down

0 comments on commit c282569

Please sign in to comment.