Skip to content

Commit

Permalink
Merge branch 'master' into deploy-dashboard-community-with-docker-com…
Browse files Browse the repository at this point in the history
…pose
  • Loading branch information
abby-cyber authored Jul 7, 2022
2 parents a5067bc + c0abed0 commit a47b35f
Show file tree
Hide file tree
Showing 63 changed files with 1,422 additions and 241 deletions.
1 change: 1 addition & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ name: Publish docs via GitHub Pages
on:
push:
branches:
# Remember to add v before the following version number unless the version is master.
- master

jobs:
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@
| Statement | Syntax | Example | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| [CREATE TAG](../3.ngql-guide/10.tag-statements/1.create-tag.md) | `CREATE TAG [IF NOT EXISTS] <tag_name> ( <prop_name> <data_type> [NULL | NOT NULL] [DEFAULT <default_value>] [COMMENT '<comment>'] [{, <prop_name> <data_type> [NULL | NOT NULL] [DEFAULT <default_value>] [COMMENT '<comment>']} ...] ) [TTL_DURATION = <ttl_duration>] [TTL_COL = <prop_name>] [COMMENT = '<comment>'] ` | `CREATE TAG woman(name string, age int, married bool, salary double, create_time timestamp) TTL_DURATION = 100, TTL_COL = "create_time"` | Creates a tag with the given name in a graph space. |
| [DROP TAG](../3.ngql-guide/10.tag-statements/2.drop-tag.md) | `DROP TAG [IF EXISTS] <tag_name>` | `CREATE TAG test(p1 string, p2 int)` | Drops a tag with the given name in the current working graph space. |
| [DROP TAG](../3.ngql-guide/10.tag-statements/2.drop-tag.md) | `DROP TAG [IF EXISTS] <tag_name>` | `DROP TAG test;` | Drops a tag with the given name in the current working graph space. |
| [ALTER TAG](../3.ngql-guide/10.tag-statements/3.alter-tag.md) | `ALTER TAG <tag_name> <alter_definition> [, alter_definition] ...] [ttl_definition [, ttl_definition] ... ] [COMMENT = '<comment>']` | `ALTER TAG t1 ADD (p3 int, p4 string)` | Alters the structure of a tag with the given name in a graph space. You can add or drop properties, and change the data type of an existing property. You can also set a [TTL](../3.ngql-guide/8.clauses-and-options/ttl-options.md) (Time-To-Live) on a property, or change its TTL duration. |
| [SHOW TAGS](../3.ngql-guide/10.tag-statements/4.show-tags.md) | `SHOW TAGS` | `SHOW TAGS` | Shows the name of all tags in the current graph space. |
| [DESCRIBE TAG](../3.ngql-guide/10.tag-statements/5.describe-tag.md) | `DESC[RIBE] TAG <tag_name>` | `DESCRIBE TAG player` | Returns the information about a tag with the given name in a graph space, such as field names, data type, and so on. |
Expand Down
38 changes: 2 additions & 36 deletions docs-2.0/20.appendix/0.FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ By nGQL, you CAN NOT directly getting all the vertices without specifying the ta

E.g., You CAN NOT run `MATCH (n) RETURN (n)`. An error like `Scan vertices or edges need to specify a limit number, or limit number can not push down.` will be returned.

You can use [Nebula Algorithm](../nebula-algorithm.md).
You can use [Nebula Algorithm](../graph-computing/nebula-algorithm.md).

Or get vertices by each tag, and then group them by yourself.

Expand All @@ -301,7 +301,7 @@ This is a very slow operation to get the out/in degree since no accelaration can

There is no such command.

You can use [Nebula Algorithm](../nebula-algorithm.md).
You can use [Nebula Algorithm](../graph-computing/nebula-algorithm.md).

## About operation and maintenance

Expand Down Expand Up @@ -414,37 +414,3 @@ Trying 192.168.1.10...
telnet: connect to address 192.168.1.10: Connection refused
```

## About license

### Are the Dashboard/Explorer/Nebula Graph Enterprise Edition licenses the same?

No, the licenses of Dashboard, Explorer, and Nebula Graph Enterprise Editions are independent of each other and cannot be used interchangeably.

### During the validity period of the Nebula Graph Enterprise Edition license, after replacing the enterprise edition Meta with the community edition Meta, can the community edition Meta be used with the enterprise edition Graph and Storage?

No, mixed deployments of the enterprise edition services and the community edition services are not supported.

### After the Nebula Graph Enterprise Edition license expires, is it possible that copy the data in the `data` directory and paste it to the same directory of Nebula Graph Community Edition, and then use Nebula Graph services as normal?

Yes, it is possible. The data of the Enterprise Edition can be used in the Community Edition. The pasted data will only work properly in the services deployed in the Community Edition. Mixed deployments of the enterprise edition services and the community edition services are not supported. For example, the mixed deployment of the enterprise edition Meta service and the community edition Graph and Storage services is not supported.

### Is there any message before the license expires, and how to renew the license after it expires?

The system will send expiration notifications before the license expires.

The notification time before the license expires is different for the full version license and the trial version license.

- For the full version license:

- Within 30 days before the license expires or on the day the license expires, there is an expiration reminder when Nebula Graph/Dashboard/Explorer is started.

- There is a 14-day buffer period after expiration. During the buffer period, you will receive expiration notifications and can continue using Nebula Graph/Dashboard/Explorer. After the buffer period ends, the corresponding service will be down and cannot be started.

- For the trial version license:

- Within 7 days before the license expires or on the day the license expires, there is an expiration reminder when Nebula Graph/Dashboard/Explorer is started.

- There is no buffer period after expiration. Once the license expires, the corresponding service will be down and cannot be started.


After your license expires, contact us via [[email protected]](mailto:[email protected]) to renew it.
4 changes: 2 additions & 2 deletions docs-2.0/20.appendix/6.eco-tool-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,15 @@ Nebula Flink Connector is a connector that helps Flink users quickly access Nebu

## Nebula Algorithm

Nebula Algorithm (Algorithm for short) is a Spark application based on [GraphX](https://spark.apache.org/graphx/), which uses a complete algorithm tool to analyze data in the Nebula Graph database by submitting a Spark task To perform graph computing, use the algorithm under the lib repository through programming to perform graph computing for DataFrame. For details, see [What is Nebula Algorithm](../nebula-algorithm.md).
Nebula Algorithm (Algorithm for short) is a Spark application based on [GraphX](https://spark.apache.org/graphx/), which uses a complete algorithm tool to analyze data in the Nebula Graph database by submitting a Spark task To perform graph computing, use the algorithm under the lib repository through programming to perform graph computing for DataFrame. For details, see [What is Nebula Algorithm](../graph-computing/nebula-algorithm.md).

|Nebula Graph version|Algorithm version|
|:---|:---|
| {{ nebula.tag }} | {{algorithm.tag}}|

## Nebula Analytics

Nebula Analytics is an application that integrates the open-source Plato Graph Computing Framework, with which Nebula Analytics performs graph computations on Nebula Graph database data. For details, see [What is Nebula Analytics](../nebula-analytics.md).
Nebula Analytics is an application that integrates the open-source Plato Graph Computing Framework, with which Nebula Analytics performs graph computations on Nebula Graph database data. For details, see [What is Nebula Analytics](../graph-computing/nebula-analytics.md).

|Nebula Graph version|Analytics version|
|:---|:---|
Expand Down
60 changes: 60 additions & 0 deletions docs-2.0/20.appendix/8.about-license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# About Nebula Graph licenses

A license is an official permission or permit that defines and restricts the rights of users to use the software. Nebula Graph licenses are used to restrict the use of the Enterprise Edition software. This document describes the Nebula Graph products that require a license and information about the license.

## Nebula Graph Enterprise Edition

Nebula Graph Enterprise Edition is scalable software with high availability and high performance.

A Nebula Graph Enterprise Edition license is required to deploy a Nebula Graph Enterprise Edition cluster. For more information, see [Deploy a license for Nebula Graph Enterprise Edition](../4.deployment-and-installation/deploy-license.md).

## Nebula Dashboard Enterprise Edition

Nebula Dashboard Enterprise Edition is an out-of-the-box visualization tool that monitors and manages the status of cluster machines and services.

A Nebula Dashboard Enterprise Edition license is required to deploy Nebula Dashboard Enterprise Edition. For more information, see [Nebula Dashboard Enterprise Edition license](../nebula-dashboard-ent/11.dashboard-ent-license.md).

## Nebula Explorer

Nebula Explorer, which has the Enterprise Edition only, is a browser-based visualization tool. It is used with the Nebula Graph core to visualize interaction with graph data. Even if there is no experience in graph databases, you can quickly become a graph exploration expert.

A Nebula Explorer license is required to deploy Nebula Explorer. For more information, see [Nebula Explorer license](../nebula-explorer/deploy-connect/3.explorer-license.md).


## FAQ about Nebula Graph licenses

### Are the Dashboard/Explorer/Nebula Graph Enterprise Edition licenses the same?

No, the licenses of Dashboard, Explorer, and Nebula Graph Enterprise Editions are independent of each other and cannot be used interchangeably.

### During the validity period of the Nebula Graph Enterprise Edition license, after replacing the enterprise edition Meta with the community edition Meta, can the community edition Meta be used with the enterprise edition Graph and Storage?

No, mixed deployments of the enterprise edition services and the community edition services are not supported.

### After the Nebula Graph Enterprise Edition license expires, is it possible that copy the data in the `data` directory and paste it to the same directory of Nebula Graph Community Edition, and then use Nebula Graph services as normal?

Yes, it is possible. The data of the Enterprise Edition can be used in the Community Edition. The pasted data will only work properly in the services deployed in the Community Edition. Mixed deployments of the enterprise edition services and the community edition services are not supported. For example, the mixed deployment of the enterprise edition Meta service and the community edition Graph and Storage services is not supported.

### Is there any message before the license expires, and how to renew the license after it expires?

The system will send expiration notifications before the license expires.

The notification time before the license expires is different for the full version license and the trial version license.

- For the full version license:

- Within 30 days before the license expires or on the day the license expires, there is an expiration reminder when Nebula Graph/Dashboard/Explorer is started.

- There is a 14-day buffer period after expiration. During the buffer period, you will receive expiration notifications and can continue using Nebula Graph/Dashboard/Explorer. After the buffer period ends, the corresponding service will be down and cannot be started.

- For the trial version license:

- Within 7 days before the license expires or on the day the license expires, there is an expiration reminder when Nebula Graph/Dashboard/Explorer is started.

- There is no buffer period after expiration. Once the license expires, the corresponding service will be down and cannot be started.


After your license expires, contact us via [[email protected]](mailto:[email protected]) to renew it.



20 changes: 19 additions & 1 deletion docs-2.0/20.appendix/learning-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,11 @@ This topic is for anyone interested in learning more about Nebula Graph. You can
| ------------------------------------------------------------ |
|[Create snapshots](../backup-and-restore/3.manage-snapshot.md)|

- Backup & Restore

| Document |
| ------------------------------------------------------------ |
|[Backup&Restore](../backup-and-restore/nebula-br/1.what-is-br.md)|
<!--
- Resource isolation
Expand Down Expand Up @@ -238,6 +243,19 @@ You can check if you have mastered Nebula Graph by completing the following prac
| Compile the source code of Nebula Graph | [Install Nebula Graph by compiling the source code](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) |
| Deploy Studio, Dashboard, and Explorer | [Deploy Studio](../nebula-studio/deploy-connect/st-ug-deploy.md), [Deploy Dashboard](../nebula-dashboard/2.deploy-dashboard.md), and [Deploy Explorer](../nebula-explorer/deploy-connect/ex-ug-deploy.md) |
| Load test Nebula Graph with K6 | [Nebula Bench](../nebula-bench.md) |
| Import LDBC data | [Nebula Graph 1.0 Benchmark Report based on the LDBC Dataset](https://nebula-graph.io/posts/nebula-graph-1.0-benchmark-report/) |
| Query LDBC data (such as queries for vertices, paths, or subgraphs.) | [LDBC](chrome-extension://gfbliohnnapiefjpjlpjnehglfpaknnc/pages/pdf_viewer.html?r=http://ldbcouncil.org/ldbc_snb_docs/ldbc-snb-specification.pdf) and [interactive-short-1.cypher](https://github.com/ldbc/ldbc_snb_interactive/blob/main/cypher/queries/interactive-short-1.cypher) |


## 8. Get Nebula Graph Certifications

Now you could get Nebula Graph Certifications from [Nebula Academy](https://academic.nebula-graph.io).

- Nebula Graph Certified Insider(NGCI): The NGCI certification provides a birdview to graph databases and the Nebula Graph database. Passing NGCI shows that you have a good understanding of Nebula Graph.

- Nebula Graph Certified Professional(NGCP): The NGCP certification drives you deep into the Nebula Graph database and its ecosystem, providing a 360-degree view of the leading-edge graph database. Passing NGCP proves that you are a professional with a profound understanding of Nebula Graph.

### Video

- [An Intro to Nebula Graph Certifications](https://www.youtube.com/watch?v=dZUKyw8L7uA)(4 minutes 17 seconds)

<iframe width="560" height="315" src="https://www.youtube.com/embed/dZUKyw8L7uA" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Loading

0 comments on commit a47b35f

Please sign in to comment.