Merge pull request #191 from EdurtIO/develop

Release notes for 1.18.0

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,36 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  schedule:
+    - cron: '39 13 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript', 'TypeScript' ]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2

.github/workflows/dependency-review.yml

@@ -0,0 +1,14 @@
+name: 'Dependency Review'
+on: [ pull_request ]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v3
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v1

README.md

@@ -74,9 +74,10 @@ DBM can query data from any SQL-speaking datastore or data engine (ClickHouse an
 Here are some of the major database solutions that are supported:
 
 <p align="center">
-  <img src="./src/shared/assets/integrate/clickhouse.png" alt="clickhouse" border="0" width="133" height="34" />
-  <img src="./src/shared/assets/integrate/trino.png" alt="trino" border="0" width="46" height="46"/>
-  <img src="./src/shared/assets/integrate/presto.png" alt="presto" border="0" width="152" height="46"/>
+  <img src="./src/shared/assets/integrate/clickhouse.png" alt="ClickHouse" border="0" width="133" height="34" />
+  <img src="./src/shared/assets/integrate/trino.png" alt="Trino" border="0" width="46" height="46"/>
+  <img src="./src/shared/assets/integrate/presto.png" alt="Presto" border="0" width="152" height="46"/>
+  <img src="./src/shared/assets/integrate/mysql.png" alt="MySQL" border="0" width="auto" height="50"/>
 </p>
 
 ## Features

SECURITY.md

@@ -0,0 +1,15 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version  | Supported          |
+|----------| ------------------ |
+| > 1.18.0 | :white_check_mark: |
+| < 1.18.0 | :x:                |
+
+## Reporting a Vulnerability
+
+If you find a software vulnerability, please submit Issues. We will fix it after review. It will generally be fixed in the next version!

docs/docs/download.md

@@ -0,0 +1,93 @@
+---
+template: overrides/main.html
+
+hide:
+- navigation
+- toc
+---
+
+<style>
+.md-typeset h1 {
+  text-align: center;
+  font-weight: 1000;
+}
+</style>
+
+<div class="font-center">
+The current Trino release is version <img src="https://img.shields.io/github/v/release/EdurtIO/dbm.svg" />. Learn more details from the <a href="/release-latest.html">release notes</a>.
+</div>
+
+<div class="grid cards" markdown style="margin-top: 30px; padding: 50px;">
+
+- :fontawesome-brands-app-store-ios: __Mac App package__
+
+    ---
+
+    See [Installation dbm](./reference/get_started/install.md) for complete install instructions.
+
+    <br />
+
+    [Download latest](https://github.com/EdurtIO/dbm/releases/latest){ .md-button .md-button-primary }
+
+- :fontawesome-brands-windows: __Windows App package__
+
+    ---
+
+    See [Installation dbm](./reference/get_started/install.md) for complete install instructions.
+
+    <br />
+
+    [Download latest](https://github.com/EdurtIO/dbm/releases/latest){ .md-button .md-button-primary }
+
+- :material-more: __More App package__
+
+    ---
+
+    See [The source code to install](./reference/get_started/install.md#the-source-code-to-install) for complete install instructions.
+
+    <br />
+
+    [Source Code](https://github.com/EdurtIO/dbm){ .md-button .md-button-primary }
+
+</div>
+
+<div class="grid cards" markdown style="padding: 0 50px 30px 50px;">
+
+- __Community resources__
+
+    ---
+
+    * **Chat On Slack**: [edurtio.slack.com](https://edurtio.slack.com/archives/C02EU2YM2N8)
+    * **Issues**: [GitHub issues](https://github.com/EdurtIO/dbm/issues)
+    * **DingTalk**: [44559111](https://gitee.com/EdurtIO/dbm/raw/master/src/shared/common/dingtalk.jpg)
+
+- __Getting help__
+
+    ---
+
+    If you need help using or running dbm, please ask a question on [Slack](https://edurtio.slack.com/archives/C02EU2YM2N8). Please [report](https://github.com/EdurtIO/dbm/issues/new/choose) any issue you find with dbm.
+
+</div>
+
+# External resources
+
+<div class="grid cards" markdown style="padding: 0 50px 30px 50px;">
+
+- __ClickHouse__
+
+    ---
+
+    * **Documentation**: [clickhouse.com](https://clickhouse.com/docs)
+    * **Issues**: [GitHub issues](https://github.com/ClickHouse/ClickHouse/issues)
+    * **Source Code**: [Code](https://github.com/ClickHouse/ClickHouse)
+    * **YouTube channel** [YouTube channel](https://www.youtube.com/c/ClickHouseDB)
+
+- __Trino__
+
+    ---
+
+    * **Documentation**: [trino.io](https://trino.io/docs/current/)
+    * **Issues**: [GitHub issues](https://github.com/trinodb/trino/issues)
+    * **Source Code**: [Code](https://github.com/trinodb/trino)
+    * **YouTube channel** [YouTube channel](https://www.youtube.com/c/trinodb)
+</div>

docs/docs/powered_by.md

@@ -0,0 +1,50 @@
+---
+template: overrides/main.html
+
+hide:
+- navigation
+- toc
+---
+
+<style>
+.md-typeset h1 {
+  text-align: center;
+  font-weight: 1000;
+}
+</style>
+
+<div class="font-center" style="margin-top: -30px; margin-left: -30px;">
+  <a href="https://github.com/EdurtIO/dbm/blob/master/docs/docs/powered_by.md"> <i class="fa fa-plus"> </i> Add Your or Company</a>
+</div>
+
+!!! note
+
+    There are many companies, individuals and open source organizations that use this program. Some of them are listed below.
+
+<div class="grid cards" markdown>
+
+- <span class="twemoji"><img src="./assets/powered_by/dbm.png" width="30"></span> __DBM developer__
+
+    ---
+
+    All DBM-related developers, who use the software and develop and debug it, have released a new version.
+
+    [:octicons-arrow-right-24: Getting started](https://github.com/EdurtIO/dbm)
+
+- <span class="twemoji"><img src="./assets/powered_by/qianmoq.png" width="30"></span> __qianmoQ__
+
+    ---
+
+    DBM-related developers, who use the software and develop and debug it, have released new versions.
+
+    [:octicons-arrow-right-24: Visit me](https://github.com/qianmoQ)
+
+- <span class="twemoji"><img src="./assets/powered_by/ClickVisual.png" width="30"></span> __ClickVisual__
+
+    ---
+
+    ClickVisual is a lightweight browser-based data analytics and data search platform for ClickHouse.
+
+    [:octicons-arrow-right-24: Getting started](https://github.com/clickvisual/clickvisual)
+
+</div>

docs/docs/reference/management/datasource/mysql.md

@@ -0,0 +1,61 @@
+---
+template: overrides/main.html
+---
+
+!!! note "MySQL"
+
+    It is mainly used to describe how the software builds the MySQL data source for subsequent operations.
+
+!!! warning "System requirements"
+
+    \>= `1.18.0`
+
+### Supported Versions
+
+---
+
+| Version | Tested?                                     |
+|---------|---------------------------------------------|
+| `5.6.x` | :material-checkbox-marked-circle:{.success} |
+| `5.7.x` | :material-checkbox-marked-circle:{.success} |
+
+!!! note "Supported versions"
+
+    Most versions have been tested, please submit issues for non-adapted versions.
+
+### Created a Source
+
+---
+
+After entering the data source management page, click the Add data source button.
+
+![img.png](../../../assets/images/others/management/datasource/datasource_type.png)
+
+Select the MySQL icon in the `Experimental` type (the third).
+
+After selecting the type, click the `Next` button at the bottom to configure the relevant information.
+
+![img.png](../../../assets/images/others/management/datasource/mysql/img.png)
+
+!!! note "Supported protocols"
+
+    - [x] `HTTP`
+
+#### HTTP Protocol
+
+---
+
+!!! note "HTTP Protocol"
+
+    Use the HTTP interface provided by MySQL to connect to the service.
+
+| Parameter   | Description                                                                                         | Required | Unique | Default |
+|-------------|-----------------------------------------------------------------------------------------------------|----------|--------|---------|
+| `Alias`     | The alias of the data source, which will be displayed later in the selected data source on the page | Yes      | Yes    |         |
+| `Host`      | The host of the MySQL server                                                                        | Yes      | Yes    |         |
+| `Port`      | The port of the MySQL server                                                                        | Yes      | Yes    | `3306`  |
+| `User Name` | The user name of the MySQL server                                                                   | Yes      | Yes    |         |
+| `Password`  | The password of the MySQL server                                                                    | Yes      | Yes    |         |
+| `Database`  | The database of the MySQL server                                                                    | Yes      | Yes    |         |
+
+When we have configured the above parameters, click the `Test` button at the bottom. If the service can be accessed normally, the `OK` button can be used. Click it and it will be saved.

docs/docs/release/1.18.0-20220610.md

@@ -0,0 +1,57 @@
+---
+template: overrides/main.html
+icon: material/gesture-tap-button
+---
+
+DBM Version for `1.18.0` is released!
+
+Release Time: `2022-06-10`
+
+#### General
+
+---
+
+- Split multiple data sources and configure them as separate components
+- Add code analysis ci
+- Add dependency review ci
+- Add dependabot ci
+- Add comments system to docs
+- Add powered by page
+- Add download page
+- Support tray function
+- Fix the exception of Presto using quick query
+- Support metadata host filtering
+- Support query history reference to the editor
+- Fix the error message that the query history cannot be viewed
+
+#### Security
+
+---
+
+- Upgrade electron to `13.6.6`
+- Add `SECURITY.md` file
+
+#### ClickHouse
+
+---
+
+- Support specifying a database when building a data source
+
+#### Trino & Presto
+
+---
+
+- Support specifying a database and catalog when building a data source [issues-158](https://github.com/EdurtIO/dbm/issues/158)
+- Support metadata source management Trino & Presto service information [issues-158](https://github.com/EdurtIO/dbm/issues/158)
+- Support metadata source management Trino & Presto create database [issues-158](https://github.com/EdurtIO/dbm/issues/158)
+
+#### MySQL
+
+---
+
+- Support MySQL (custom query and data source management) [issues-180](https://github.com/EdurtIO/dbm/issues/180)
+- Add MySQL docs [issues-180](https://github.com/EdurtIO/dbm/issues/180)
+
+---
+
+- @qianmoQ