Skip to content

Commit

Permalink
Merge branch 'v3.4.1' into merge-from-3.4.1
Browse files Browse the repository at this point in the history
  • Loading branch information
cooper-lzy committed Mar 13, 2023
2 parents 2086cff + f09707f commit 207700b
Show file tree
Hide file tree
Showing 64 changed files with 1,012 additions and 685 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ on:
push:
branches:
# Remember to add v before the following version number unless the version is master.
- master
- v3.4.1

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0 # fetch all commits/branches for gitversion
fetch-depth: 1 # fetch all commits/branches for gitversion

- name: Setup Python
uses: actions/setup-python@v1
Expand All @@ -29,8 +29,8 @@ jobs:
run: |
# mike delete master -p
git fetch origin gh-pages --depth=1 # fix mike's CI update
mike list
mike deploy master -p --rebase
mike deploy 3.4.1 -p --rebase
mike set-default 3.4.1 -p --rebase
mike list
# - name: Deploy
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/1.introduction/3.vid.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# VID

In NebulaGraph, a vertex is uniquely identified by its ID, which is called a VID or a Vertex ID.
In a graph space, a vertex is uniquely identified by its ID, which is called a VID or a Vertex ID.

## Features

Expand Down
37 changes: 33 additions & 4 deletions docs-2.0/2.quick-start/1.quick-start-workflow.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,39 @@
# Quick start workflow
# Getting started with NebulaGraph

The quick start introduces the simplest workflow to use NebulaGraph, including deploying NebulaGraph, connecting to NebulaGraph, and doing basic CRUD.
This topic describes how to use NebulaGraph with Docker Desktop and on-premises deployment workflow to quickly get started with NebulaGraph.

## Steps
## Using NebulaGraph with Docker Desktop

Users can quickly deploy and use NebulaGraph in the following steps.
NebulaGraph is available as a [Docker Extension](https://hub.docker.com/extensions/weygu/nebulagraph-dd-ext) that you can easily install and run on your Docker Desktop. You can quickly deploy NebulaGraph using Docker Desktop with just one click.

1. Install Docker Desktop

- [Install Docker Desktop on Mac](https://docs.docker.com/docker-for-mac/install/)
- [Install Docker Desktop on Windows](https://docs.docker.com/docker-for-windows/install/)

!!! caution
To install Docker Desktop, you need to install [WSL 2](https://docs.docker.com/desktop/install/windows-install/#system-requirements) first.

2. In the left sidebar of Docker Desktop, click **Extensions** or **Add Extensions**.
3. On the Extensions Marketplace, search for NebulaGraph and click **Install**.

![docker](https://docs-cdn.nebula-graph.com.cn/figures/docker.png)

Click **Update** to update NebulaGraph to the latest version when a new version is available.

![docker-update](https://docs-cdn.nebula-graph.com.cn/figures/docker-update.png)

4. Click **Open** to navigate to the NebulaGraph extension page.

5. At the top of the page, click **Studio in Browser** to use NebulaGraph.

For more information about how to use NebulaGraph with Docker Desktop, see the following video:

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

## Deploying NebulaGraph on-premises workflow

The following workflow describes how to use NebulaGraph on-premises, including deploying NebulaGraph, connecting to NebulaGraph, and running basic CRUD.

1. [Deploy NebulaGraph](2.install-nebula-graph.md)

Expand Down
6 changes: 6 additions & 0 deletions docs-2.0/20.appendix/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,9 @@
9. 2022.2: NebulaGraph v3.0.0 was released.

10. 2022.4: NebulaGraph v3.1.0 was released.

11. 2022.7: NebulaGraph v3.2.0 was released.

12. 2022.10: NebulaGraph v3.3.0 was released.

13. 2023.2: NebulaGraph v3.4.0 was released.
71 changes: 8 additions & 63 deletions docs-2.0/20.appendix/release-notes/dashboard-comm-release-note.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,12 @@
# NebulaGraph Dashboard Community Edition {{ nebula.release }} release notes

## Feature
## Community Edition 3.4.0

- Support [killing sessions](../../3.ngql-guide/17.query-tuning-statements/2.kill-session.md). [#5146](https://github.com/vesoft-inc/nebula/pull/5146)
- Support [Memory Tracker](../../5.configurations-and-logs/1.configurations/4.storage-config.md) to optimize memory management. [#5082](https://github.com/vesoft-inc/nebula/pull/5082)
- Feature
- Support the built-in [dashboard.service](../../nebula-dashboard/2.deploy-dashboard.md) script to manage the Dashboard services with one-click and view the Dashboard version.
- Support viewing the configuration of Meta services.

## Enhancement

- Optimize job management. [#5212](https://github.com/vesoft-inc/nebula/pull/5212) [#5093](https://github.com/vesoft-inc/nebula/pull/5093) [#5099](https://github.com/vesoft-inc/nebula/pull/5099) [#4872](https://github.com/vesoft-inc/nebula/pull/4872)

- Modify the default value of the Graph service parameter `session_reclaim_interval_secs` to 60 seconds. [#5246](https://github.com/vesoft-inc/nebula/pull/5246)

- Adjust the default level of `stderrthreshold` in the configuration file. [#5188](https://github.com/vesoft-inc/nebula/pull/5188)

- Optimize the full-text index. [#5077](https://github.com/vesoft-inc/nebula/pull/5077) [#4900](https://github.com/vesoft-inc/nebula/pull/4900) [#4925](https://github.com/vesoft-inc/nebula/pull/4925)

- Limit the maximum depth of the plan tree in the optimizer to avoid stack overflows. [#5050](https://github.com/vesoft-inc/nebula/pull/5050)

- Optimize the treatment scheme when the pattern expressions are used as predicates. [#4916](https://github.com/vesoft-inc/nebula/pull/4916)

## Bugfix

- Fix the bug about query plan generation and optimization. [#4863](https://github.com/vesoft-inc/nebula/pull/4863) [#4813](https://github.com/vesoft-inc/nebula/pull/4813)

- Fix the bugs related to indexes:

- Full-text indexes [#5214](https://github.com/vesoft-inc/nebula/pull/5214) [#5260](https://github.com/vesoft-inc/nebula/pull/5260)
- String indexes [5126](https://github.com/vesoft-inc/nebula/pull/5126)

- Fix the bugs related to query statements:

- Variables [#5192](https://github.com/vesoft-inc/nebula/pull/5192)
- Filter conditions and expressions [#4952](https://github.com/vesoft-inc/nebula/pull/4952) [#4893](https://github.com/vesoft-inc/nebula/pull/4893) [#4863](https://github.com/vesoft-inc/nebula/pull/4863)
- Properties of vertices or edges [#5230](https://github.com/vesoft-inc/nebula/pull/5230) [#4846](https://github.com/vesoft-inc/nebula/pull/4846) [#4841](https://github.com/vesoft-inc/nebula/pull/4841) [#5238](https://github.com/vesoft-inc/nebula/pull/5238)
- Functions and aggregations [#5135](https://github.com/vesoft-inc/nebula/pull/5135) [#5121](https://github.com/vesoft-inc/nebula/pull/5121) [#4884](https://github.com/vesoft-inc/nebula/pull/4884)
- Using illegal data types [#5242](https://github.com/vesoft-inc/nebula/pull/5242)
- Clauses and operators [#5241](https://github.com/vesoft-inc/nebula/pull/5241) [#4965](https://github.com/vesoft-inc/nebula/pull/4965)

- Fix the bugs related to DDL and DML statements:

- ALTER TAG [#5105](https://github.com/vesoft-inc/nebula/pull/5105) [#5136](https://github.com/vesoft-inc/nebula/pull/5136)
- UPDATE [#4933](https://github.com/vesoft-inc/nebula/pull/4933)

- Fix the bugs related to other functions:

- TTL [#4961](https://github.com/vesoft-inc/nebula/pull/4961)
- Authentication [#4885](https://github.com/vesoft-inc/nebula/pull/4885)
- Services [#4896](https://github.com/vesoft-inc/nebula/pull/4896)

## Change

- The added property name can not be the same as an existing or deleted property name, otherwise, the operation of adding a property fails. [#5130](https://github.com/vesoft-inc/nebula/pull/5130)
- Limit the type conversion when modifying the schema. [#5098](https://github.com/vesoft-inc/nebula/pull/5098)
- The default value must be specified when creating a property of type `NOT NULL`. [#5105](https://github.com/vesoft-inc/nebula/pull/5105)
- Add the multithreaded query parameter `query_concurrently` to the configuration file with a default value of `true`. [#5119](https://github.com/vesoft-inc/nebula/pull/5119)
- Remove the parameter `kv_separation` of the KV separation storage function from the configuration file, which is turned off by default. [#5119](https://github.com/vesoft-inc/nebula/pull/5119)
- Modify the default value of `local_config` in the configuration file to `true`. [#5119](https://github.com/vesoft-inc/nebula/pull/5119)
- Consistent use of `v.tag.property` to get property values, because it is necessary to specify the Tag. Using `v.property` to access the property of a Tag on `v` was incorrectly allowed in the previous version. [#5230](https://github.com/vesoft-inc/nebula/pull/5230)
- Remove the column `HTTP port` from the command `SHOW HOSTS`. [#5056](https://github.com/vesoft-inc/nebula/pull/5056)
- Disable the queries of the form `OPTIONAL MATCH <pattern> WHERE <condition>`. [#5273](https://github.com/vesoft-inc/nebula/pull/5273)
- Disable TOSS. [#5119](https://github.com/vesoft-inc/nebula/pull/5119)
- Rename Listener's pid filename and log directory name. [#5119](https://github.com/vesoft-inc/nebula/pull/5119)

## Legacy versions

[Release notes of legacy versions](https://nebula-graph.io/posts/)
- Enhancement
- Adjust the directory structure and simplify the [deployment steps](../../nebula-dashboard/2.deploy-dashboard.md).
- Display the names of the monitoring metrics on the overview page of `machine`.
- Optimize the calculation of monitoring metrics such as `num_queries`, and adjust the display to time series aggregation.
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# NebulaGraph Dashboard Enterprise Edition release notes

## Enterprise Edition 3.4.1

- Bugfix

- Fix the bug that the RPM package cannot execute `nebula-agent` due to permission issues.
- Fix the bug that the cluster import information can not be viewed due to the `goconfig` folder permission.
- Fix the page error when the license expiration time is less than `30` days and `gracePeriod` is greater than `0`.

## Enterprise Edition 3.4.0

- Feature
Expand Down
68 changes: 4 additions & 64 deletions docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,15 @@
# NebulaGraph {{ nebula.release }} release notes

## Enhancement

- Optimized the performance of k-hop. [#4560](https://github.com/vesoft-inc/nebula/pull/4560) [#4736](https://github.com/vesoft-inc/nebula/pull/4736) [#4566](https://github.com/vesoft-inc/nebula/pull/4566) [#4582](https://github.com/vesoft-inc/nebula/pull/4582) [#4558](https://github.com/vesoft-inc/nebula/pull/4558) [#4556](https://github.com/vesoft-inc/nebula/pull/4556) [#4555](https://github.com/vesoft-inc/nebula/pull/4555) [#4516](https://github.com/vesoft-inc/nebula/pull/4516) [#4531](https://github.com/vesoft-inc/nebula/pull/4531) [#4522](https://github.com/vesoft-inc/nebula/pull/4522) [#4754](https://github.com/vesoft-inc/nebula/pull/4754) [#4762](https://github.com/vesoft-inc/nebula/pull/4762)

- Optimized `GO` statement join performance. [#4599](https://github.com/vesoft-inc/nebula/pull/4599) [#4750](https://github.com/vesoft-inc/nebula/pull/4750)

- Supported using `GET SUBGRAPH` to filter vertices. [#4357](https://github.com/vesoft-inc/nebula/pull/4357)

- Supported using `GetNeighbors` to filter vertices. [#4671](https://github.com/vesoft-inc/nebula/pull/4671)

- Optimized the loop handling of `FIND SHORTEST PATH`. [#4672](https://github.com/vesoft-inc/nebula/pull/4672)

- Supported the conversion between timestamp and date time. [#4626](https://github.com/vesoft-inc/nebula/pull/4526)

- Supported the reference of local variable in pattern expressions. [#4498](https://github.com/vesoft-inc/nebula/pull/4498)

- Optimized the job manager. [#4446](https://github.com/vesoft-inc/nebula/pull/4446) [#4442](https://github.com/vesoft-inc/nebula/pull/4442) [#4444](https://github.com/vesoft-inc/nebula/pull/4444) [#4460](https://github.com/vesoft-inc/nebula/pull/4460) [#4500](https://github.com/vesoft-inc/nebula/pull/4500) [#4633](https://github.com/vesoft-inc/nebula/pull/4633) [#4654](https://github.com/vesoft-inc/nebula/pull/4654) [#4663](https://github.com/vesoft-inc/nebula/pull/4663) [#4722](https://github.com/vesoft-inc/nebula/pull/4722) [#4742](https://github.com/vesoft-inc/nebula/pull/4742)

- Added flags of experimental features, `enable_data_balance` for `BALANCE DATA`. [#4728](https://github.com/vesoft-inc/nebula/pull/4728)

- Stats log print to console when the process is started. [#4550](https://github.com/vesoft-inc/nebula/pull/4550)

- Supported the `JSON_EXTRACT` function. [#4743](https://github.com/vesoft-inc/nebula/pull/4743)

## Bugfix

- Fixed the crash of variable types collected. [#4724](https://github.com/vesoft-inc/nebula/pull/4724)

- Fixed the crash in the optimization phase of multiple `MATCH`. [#4780](https://github.com/vesoft-inc/nebula/pull/4780)

- Fixed the bug of aggregate expression type deduce. [#4706](https://github.com/vesoft-inc/nebula/pull/4706)

- Fixed the incorrect result of the `OPTIONAL MATCH` statement. [#4670](https://github.com/vesoft-inc/nebula/pull/4670)

- Fixed the bug of parameter expression in the `LOOKUP` statement. [#4664](https://github.com/vesoft-inc/nebula/pull/4664)
- Fix the crash caused by encoding parameter expressions to the storage layer for execution. [#5336](https://github.com/vesoft-inc/nebula/pull/5336)

- Fixed the bug that `YIELD DISTINCT` returned a distinct result set in the `LOOKUP` statement. [#4651](https://github.com/vesoft-inc/nebula/pull/4651)
- Fix some crashes for the list function. [#5383](https://github.com/vesoft-inc/nebula/pull/5383)

- Fixed the bug that `ColumnExpression` encode and decode are not matched. [#4413](https://github.com/vesoft-inc/nebula/pull/4413)

- Fixed the bug that `id($$)` filter was incorrect in the `GO` statement. [#4768](https://github.com/vesoft-inc/nebula/pull/4768)

- Fixed the bug that full scan of `MATCH` statement when there is a relational `In` predicate. [#4748](https://github.com/vesoft-inc/nebula/pull/4748)

- Fixed the optimizer error of `MATCH` statement.[#4771](https://github.com/vesoft-inc/nebula/pull/4771)

- Fixed wrong output when using `pattern` expression as the filter in `MATCH` statement. [#4778](https://github.com/vesoft-inc/nebula/pull/4778)

- Fixed the bug that tag, edge, tag index and edge index display incorrectly. [#4616](https://github.com/vesoft-inc/nebula/pull/4616)

- Fixed the bug of date time format. [#4524](https://github.com/vesoft-inc/nebula/pull/4524)

- Fixed the bug that the return value of the date time vertex was changed. [#4448](https://github.com/vesoft-inc/nebula/pull/4448)

- Fixed the bug that the startup service failed when the log directory not existed and `enable_breakpad` was enabled. [#4623](https://github.com/vesoft-inc/nebula/pull/4623)

- Fixed the bug that after the metad stopped, the status remained online. [#4610](https://github.com/vesoft-inc/nebula/pull/4610)

- Fixed the corruption of the log file. [#4409](https://github.com/vesoft-inc/nebula/pull/4409)

- Fixed the bug that `ENABLE_CCACHE` option didn't work. [#4648](https://github.com/vesoft-inc/nebula/pull/4648)

- Abandoned uppercase letters in full-text index names. [#4628](https://github.com/vesoft-inc/nebula/pull/4628)
## Legacy versions

- Disable `COUNT(DISTINCT *)` . [#4553](https://github.com/vesoft-inc/nebula/pull/4553)
[Release notes of legacy versions](https://nebula-graph.io/posts/)

### Change

- Vertices without tags are not supported by default. If you want to use the vertex without tags, add `--graph_use_vertex_key=true` to the configuration files (`nebula-graphd.conf`) of all Graph services in the cluster, add `--use_vertex_key=true` to the configuration files (`nebula-storaged.conf`) of all Storage services in the cluster. [#4629](https://github.com/vesoft-inc/nebula/pull/4629)

## Legacy versions

[Release notes of legacy versions](https://nebula-graph.io/posts/)
85 changes: 3 additions & 82 deletions docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md
Original file line number Diff line number Diff line change
@@ -1,90 +1,11 @@
# NebulaGraph {{ nebula.release }} release notes

## Feature

- Support [incremental backup](../../backup-and-restore/nebula-br-ent/1.br-ent-overview.md).
- Support [fine-grained permission management]((../../7.data-security/1.authentication/3.role-list.md)) at the Tag/Edge type level.
- Support [killing sessions](../../3.ngql-guide/17.query-tuning-statements/2.kill-session.md).
- Support [Memory Tracker](../../5.configurations-and-logs/1.configurations/4.storage-config.md) to optimize memory management.
- Support [black-box monitoring](../../6.monitor-and-metrics/3.bbox/3.1.bbox.md).
- Support function [json_extract](../../3.ngql-guide/6.functions-and-expressions/2.string.md).
- Support function [extract](../../3.ngql-guide/6.functions-and-expressions/2.string.md).

## Enhancement

- Support using `GET SUBGRAPH` to filter vertices.
- Support using `GetNeighbors` to filter vertices.
- Support the conversion between timestamp and date time.
- Support the reference of local variable in pattern expressions.
- Optimize job management.
- Optimize the full-text index.
- Optimize the treatment scheme when the pattern expressions are used as predicates.
- Optimize the join performance of the GO statement.
- Optimize the performance of k-hop.
- Optimize the performance of the shortest path query.
- Optimize the push-down of the filtering of the vertex property.
- Optimize the push-down of the edge filtering.
- Optimize the loop conditions of the subgraph query.
- Optimize the rules of the property cropping.
- Remove the invalid `Project` operators.
- Remove the invalid `AppendVertices` operators.
- Reduce the amount of data replication for connection operations.
- Reduce the amount of data replication for `Traverse` and `AppendVertices` operators.
- Modify the default value of the Graph service parameter `session_reclaim_interval_secs` to 60 seconds.
- Adjust the default level of `stderrthreshold` in the configuration file.
- Get the property values by subscript to reduce the time of property query.
- Limit the maximum depth of the plan tree in the optimizer to avoid stack overflows.

## Bugfix

- Fix the bug about query plan generation and optimization.

- Fix the bugs related to indexes:

- Full-text indexes
- String indexes

- Fix the bugs related to query statements:

- Variables
- Filter conditions and expressions
- Properties of vertices or edges
- parameters
- Functions and aggregations
- Using illegal data types
- Time zone, date, time, etc
- Clauses and operators

- Fix the bugs related to DDL and DML statements:

- ALTER TAG
- UPDATE

- Fix the bugs related to other functions:

- TTL
- Synchronization
- Authentication
- Services
- Logs
- Monitoring and statistics

## Change
- Fix the crash caused by encoding parameter expressions to the storage layer for execution.

- If you want to upgrade NebulaGraph from version 3.1 to 3.4, please follow the instructions in the [upgrade document](../../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md).
- The added property name can not be the same as an existing or deleted property name, otherwise, the operation of adding a property fails.
- Limit the type conversion when modifying the schema.
- The default value must be specified when creating a property of type `NOT NULL`.
- Add the multithreaded query parameter `query_concurrently` to the configuration file with a default value of `true`.
- Remove the parameter `kv_separation` of the KV separation storage function from the configuration file, which is turned off by default.
- Modify the default value of `local_config` in the configuration file to `true`.
- Consistent use of `v.tag.property` to get property values, because it is necessary to specify the Tag. Using `v.property` to access the property of a Tag on `v` was incorrectly allowed in the previous version.
- Remove the column `HTTP port` from the command `SHOW HOSTS`.
- Disable the queries of the form `OPTIONAL MATCH <pattern> WHERE <condition>`.
- Disable the functions of the form `COUNT(DISTINCT *)`.
- Disable TOSS.
- Rename Listener's pid filename and log directory name.
- Fix some crashes for the list function.

## Legacy versions

[Release notes of legacy versions](https://nebula-graph.io/posts/)
[Release notes of legacy versions](https://www.nebula-graph.io/tags/release-notes)
Loading

0 comments on commit 207700b

Please sign in to comment.