Skip to content

Commit

Permalink
Merge 3a5e221 into 55f1f6d
Browse files Browse the repository at this point in the history
  • Loading branch information
qianmoQ authored Apr 24, 2022
2 parents 55f1f6d + 3a5e221 commit 2c4a10d
Show file tree
Hide file tree
Showing 107 changed files with 1,825 additions and 717 deletions.
Empty file added CONTRIBUTING.md
Empty file.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/docs/assets/images/query/img.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/docs/assets/images/query/snippet/img.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/docs/assets/images/query/snippet/img_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 added docs/docs/assets/images/query/snippet/img_2.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/docs/assets/images/query/snippet/img_3.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/docs/assets/images/query/snippet/img_4.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/docs/assets/images/versions/1.15.0/img.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/docs/assets/images/versions/1.15.0/img_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 added docs/docs/assets/images/versions/1.15.0/img_2.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/docs/assets/images/versions/1.15.0/img_3.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/docs/assets/images/versions/1.15.0/img_4.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/docs/assets/images/versions/1.15.0/img_5.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/docs/assets/images/versions/1.15.0/img_6.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/docs/assets/images/versions/1.15.0/img_7.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/docs/assets/images/versions/1.15.0/img_8.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/docs/assets/images/versions/1.15.0/img_9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ template: overrides/main.html
icon: material/gesture-tap-button
---

DBM Version for `1.15.0` is development!
DBM Version for `1.16.0` is development!

!!! danger "Warning"

Expand Down
54 changes: 54 additions & 0 deletions docs/docs/reference/monitor/monitor_query.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
template: overrides/main.html
---

This document mainly introduces how we can use the `Slow query` monitoring function provided by the software.

Move the mouse to the top menu `Monitor` and wait for the drop-down options to appear, click `Query` to enter the query monitoring interface, which is similar to the following page

![img.png](../../assets/images/others/monitor/query/img.png)

The upper part of the page is the data chart display & function configuration area, and the lower part is the detailed data list area

#### Data charting & Feature Configuration

---

The drop-down selection box on the top left is used to select the configured data source. After selection, the software will initiate a request to the service to obtain information, and return a data chart similar to the following

![img_1.png](../../assets/images/others/monitor/query/img_1.png)

There is a `Number` input device at the top right

`Numeric input` is used to mark the maximum time-consuming limit of the query (unit: milliseconds)

#### Details of the data

---

The drop-down selection box on the top left is used to select the configured data source. After selection, the software will initiate a request to the service to obtain information, and return results similar to the following

![img_2.png](../../assets/images/others/monitor/query/img_2.png)

| Property | Description |
|--------------|------------------------------------------------------------|
| user | Query the user used |
| host | Query the client host |
| hash | Query the generated hash data |
| time | Query creation time |
| elapsed(ms) | Query time (ms) |
| memoryUsage | Memory used by query |
| rows | Query the total number of rows |
| bytes | Total number of bytes queried |
| readRows | Query the total number of rows of read metadata |
| bytesRead | Query the total number of bytes of metadata read |
| writtenRows | The total number of bytes of metadata written to the query |
| bytesWritten | The total number of bytes of metadata written to the query |

#### Action

---

:octicons-search-16:{.blue} button To query the DDL statement of the operation

![img_3.png](../../assets/images/others/monitor/query/img_3.png)
22 changes: 16 additions & 6 deletions docs/docs/reference/query/query_history.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ template: overrides/main.html

The query history function is mainly used to mark some of our query records for each data source.

!!! warning

Currently supports up to `100` query history, we will expand this function to support more data storage in the future!

Move the mouse to the top menu `Query` and wait for the drop-down options to appear, click `History` to enter the query history interface, which is similar to the following page

![Query History](/assets/images/query/query_history.png)
Expand All @@ -31,10 +27,24 @@ On the top right side of the page we can see the <img src="/assets/images/query/

In the list, we can see that we use special colors to highlight the records that failed to query

:octicons-search-16: The button is used to view the SQL statement of this query
### Action

---

#### Get query ddl

:octicons-search-16:{ .blue } The button is used to view the SQL statement of this query

![Query DDL](/assets/images/query/query_ddl.png)

:warning: The button is used to view the error information after this execution fails, it only takes effect after the query fails
#### Query error

:warning:{ .red } The button is used to view the error information after this execution fails, it only takes effect after the query fails

![Query Error](/assets/images/query/query_error.png)

#### Delete

:material-delete-circle-outline:{.red} The button is used to delete this query record

![img.png](../../assets/images/query/img.png)
77 changes: 77 additions & 0 deletions docs/docs/reference/query/snippet/snippet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
template: overrides/main.html
---

The code fragment function is mainly used to customize the reserved code for subsequent quick use of the code.

!!! warning

This feature is launched in the `1.15.0` version.

### Snippet

---

Move the mouse to the top menu `Query` and wait for the drop-down options to appear, click `Snippet` to enter the code snippet interface, which is similar to the following page

![img.png](../../../assets/images/query/snippet/img.png)

#### Field Description

---

| Field | Meaning |
|-------------|---------------------------------------------------------------|
| ID | Unique mark of data record |
| Name | The name of the code fragment, used to mark the code fragment |
| Description | Description information of the code fragment |
| Code | Actual input code fragment |
| Created | Creation time |
| Updated | Updated time |


By default, the content of this page is as follows

![img_1.png](../../../assets/images/query/snippet/img_1.png)

### Create a new snippet

---

Click the blue button in the middle of the page or the blue plus button in the upper left corner to add a new code fragment.

![img_2.png](../../../assets/images/query/snippet/img_2.png)

#### Field Description

---

| Field | Meaning |
|-------------|---------------------------------------------------------------|
| Name | The name of the code fragment, used to mark the code fragment |
| Description | Description information of the code fragment |
| Snippet | Actual input code fragment |

When all the content is entered and the verification is passed, click the blue button at the bottom right to save.

Click the red button to cancel the current operation process.

### Edit data record

---

Click the blue button under the operation column to edit the data record, and it will be automatically filled into the editor, similar to the following page.

![img_3.png](../../../assets/images/query/snippet/img_3.png)

### Delete data record

---

The software provides the function of deleting code fragments. Click the red button under the operation column after the data is recorded, and the following window will pop up.

![img_4.png](../../../assets/images/query/snippet/img_4.png)

Click the blue button to delete the data.

Click the white button to cancel the data deletion operation.
64 changes: 64 additions & 0 deletions docs/docs/release/1.15.0-20220425.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
template: overrides/main.html
icon: material/gesture-tap-button
---

DBM Version for `1.15.0` is released!

Release Time: `2020-04-25`

#### Enhancement

---

- Support metadata management, add column description information <br />
![img.png](../assets/images/versions/1.15.0/img.png)
![img_1.png](../assets/images/versions/1.15.0/img_1.png)
- Support code snippet management <br />
![img.png](../assets/images/versions/1.15.0/img_2.png) <br />
![img_1.png](../assets/images/versions/1.15.0/img_3.png)<br />
![img_1.png](../assets/images/versions/1.15.0/img_4.png)<br />
- Support query reference code snippet <br />
![img.png](../assets/images/versions/1.15.0/img_6.png)<br />
![img_1.png](../assets/images/versions/1.15.0/img_7.png)<br />
- Support to quickly add code snippets after successful query <br />
![img.png](../assets/images/versions/1.15.0/img_8.png)<br />
- The data source supports IndexDB storage

#### UI

---

- Add multiple editor themes <br />
![multiple editor themes](../assets/images/versions/1.15.0/themes.png) <br />
- Quick query unavailable nodes prohibit operations <br />
![img.png](../assets/images/versions/1.15.0/img_5.png) <br />
- It is forbidden to use functions such as quick query if the data source is not selected

#### Optimize

----

- Add data sheet deletion prompt greater than 50GB <br />
![img.png](../assets/images/versions/1.15.0/img_9.png)

#### Docs

---

- Add snippet docs
- Add monitor --> query docs

#### Bug

---

- Fix the problem that invalid metadata management nodes can be clicked
- Fix the exception that the optional parameters of the metadata management creation of the MongoDB data table cannot be constructed
- Fix the error reported by the metadata management data table console

#### Contributors (In no particular order)

---

- @qianmoQ
8 changes: 6 additions & 2 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ plugins:
Datasource: 数据源
Query: 查询
History: 历史
Snippet: 片段
Management: 管理
Monitor: 监控
Processor: 进程
Expand All @@ -151,14 +152,17 @@ nav:
- Query:
- Query: reference/query/query_query.md
- History: reference/query/query_history.md
- Snippet: reference/query/snippet/snippet.md
- Management:
- Datasource: reference/management/management_datasource.md
- Monitor:
- Processor: reference/Monitor-Processor.md
- Connection: reference/monitor/monitor_connection.md
- Mutations: reference/monitor/monitor_mutations.md
- Query: reference/monitor/monitor_query.md
- Release Note:
- 1.14.0 (latest): release/1.14.0-20220410.md
- 1.15.0 (latest): release/1.15.0-20220425.md
- 1.14.0: release/1.14.0-20220410.md
- 1.13.0: release/1.13.0-20220329.md
- 1.12.0: release/1.12.0-20220318.md
- 1.11.0: release/1.11.0-20220222.md
Expand All @@ -173,7 +177,7 @@ nav:
- 1.2.0-SNAPSHOT: release/1.2.0-SNAPSHOT.md
- 1.1.0-SNAPSHOT: release/1.1.0-SNAPSHOT.md
- 1.0.0-SNAPSHOT: release/1.0.0-SNAPSHOT.md
- Development Version: development/version/1.15.0-development.md
- Development Version: development/version/1.16.0-development.md
- Development:
- Contribution:
- Document: development/document.md
29 changes: 14 additions & 15 deletions electron-builder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,41 +10,40 @@ releaseInfo:
---
- Support visual build of MongoDB tables
- Supports adding the TTL of the table visually
- Support data source copy
- Supports remove the TTL of the table visually
- Supports metadata management to change database names
- Query history supports IndexDB storage
- Supports deleting a single query history
- Support metadata management to add columns
- Support metadata management, add column description information
- Support code snippet management
- Support query reference code snippet
- Support to quickly add code snippets after successful query
- The data source supports IndexDB storage
#### Docs
---
- Optimize data source management documentation
- Add Monitor --> Connection docs
- Add Monitor --> Mutations docs
- Add snippet docs
- Add monitor --> query docs
#### Optimize
----
- Optimize the prompt message when deleting only one column in the data table
- Add data sheet deletion prompt greater than 50GB
#### Bug
---
- Fix the error condition of deleting existing columns
- Fix the problem that invalid metadata management nodes can be clicked
- Fix the exception that the optional parameters of the metadata management creation of the MongoDB data table cannot be constructed
- Fix the error reported by the metadata management data table console
#### UI
---
- Unavailable data source disallows click action
- Add multiple editor themes
- Quick query unavailable nodes prohibit operations
- It is forbidden to use functions such as quick query if the data source is not selected
directories:
output: ./release
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dbm",
"version": "1.14.0",
"version": "1.15.0",
"author": "qianmoQ <[email protected]>",
"description": "ClickHouse DataBase GUI",
"github": "https://github.com/EdurtIO/dbm.git",
Expand Down Expand Up @@ -59,11 +59,12 @@
"highcharts": "^9.3.2",
"jsstore": "^4.3.8",
"lodash": "^4.17.21",
"moment": "^2.29.1",
"moment": "^2.29.2",
"ng-zorro-antd": "^12.1.0",
"ngx-clipboard": "^14.0.2",
"ngx-easy-table": "^15.2.0",
"ngx-markdown": "^13.1.0",
"ngx-moment": "^6.0.2",
"node-sql-parser": "^4.1.1",
"rxjs": "~6.6.0",
"sass-loader": "^12.3.0",
Expand Down
12 changes: 9 additions & 3 deletions src/renderer/app/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,20 @@ import { AppComponent } from './app.component';
import { CommonModule, HashLocationStrategy, LocationStrategy } from '@angular/common';
import { HttpClientModule } from '@angular/common/http';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
import { NzConfig, NZ_CONFIG } from 'ng-zorro-antd/core/config';
import { NZ_CONFIG, NzConfig } from 'ng-zorro-antd/core/config';

const ngZorroConfig: NzConfig = {
card: {
nzSize: 'small'
},
button: {
nzSize: 'small'
},
table: {
nzSize: 'small'
},
modal: {
nzMaskClosable: false
}
};

Expand All @@ -32,8 +38,8 @@ const ngZorroConfig: NzConfig = {
provide: LocationStrategy,
useClass: HashLocationStrategy
},
{ provide: NZ_CONFIG, useValue: ngZorroConfig }
],
{provide: NZ_CONFIG, useValue: ngZorroConfig}
],
bootstrap: [AppComponent]
})
export class AppModule {
Expand Down
Loading

0 comments on commit 2c4a10d

Please sign in to comment.