Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/autohomecorp/dbtree

网页查看表结构，修改注释，导出markdown,对表进行有意义的目录分类, mybatis-generator界面的工具，支持mysql, sqlserver。使用springboot2 + vue-element-template
https://github.com/autohomecorp/dbtree

mybatis-generator mysql phpmyadmin springboot2 vue-element-admin

Last synced: 14 days ago
JSON representation

网页查看表结构，修改注释，导出markdown,对表进行有意义的目录分类, mybatis-generator界面的工具，支持mysql, sqlserver。使用springboot2 + vue-element-template

Awesome Lists containing this project

README 

        
## DBTree Introduction



English | [简体中文](./README.md)



DBTree is a light web tool for browsing database table definitions. Compared to phpMyAdmin, DBTree only 

focus on browsing table information and maintaining comment. You can use it to classify your tables as folders and 

update comment handily.  



## Features



* organize tables as folders

* browse important schema information

* show only one table delegate if the table is split into hundreds or thousands.

* update table comment, column comment online handily.

* support mysql, sql server

* export table schema as markdown



## Demo






## Why this tool



In daily development, database communication is one of the most important and frequent part, our team found that no matter database 

client like MSS Management Studio, phpMyAdmin or database design software like Power Designer, it is not convenient to browse or share 

table definition and comment. Especially when there are thousands of sub-tables, it is really tough. So we design this tool and we 

love this tool, hope it would help you too. 



comment friendly and classify your table as folders is good for all.



## config



* database server config



dbtree-backend/src/main/resources/dbconfig/db-server.json

```json

{

  "mysql-127.0.0.1": {

    "db_type": "mysql",

    "host": "127.0.0.1",

    "port": 3306,

    "user": "root",

    "password": "123456"

  },

  "sqlserver-127.0.0.2": {

    "db_type": "sqlserver",

    "host": "127.0.0.2",

    "port": 1433,

    "user": "root",

    "password":"123456"

  }

}

```

the password is plain.



* database config



dbtree-backend/src/main/resources/dbconfig/db-config.json

```json

{

  "db_1": {

    "db_name": "db_1",

    "db_server": "mysql-127.0.0.1",

    "split_table_rules": [

      {

        "delegate_table": "rule",

        "table_pattern": "rule_%"

      }

    ]

  },

  "db_2": {

     "db_name": "db_2",

     "db_server": "sqlserver-127.0.0.2"

  }

}

```

db-config.json is a json map content, the key must be as same as database name(db_name). You can use split_table_rules to specify the 

table split pattern, the example means using rule to represent all rule_% tables.



* mybatis.base.folder



the store folder for mybatis generated code file



* mybatis.mysql.connector



the location of mysql jdbc jar. you can copy dbtree/connector/mysql-connector-java-5.1.36.jar to your own folder.



* mybatis.sqlserver.connector



the location of sqlserver jdbc jar. you can copy dbtree/connector/sqljdbc42.jar to your own folder



## Debug



Requirements

* jdk 1.8+

* node.js



open and run the springboot project，visit：http://localhost:8080  



for better debug experience, you should use VS Code to open the dbtree-vue folder. execute the following command:



```bash

# install dependency

npm install



# develop

npm run dev

```



This will automatically open http://localhost:9528



## Deploy



This project use springboot2.x + vue-element-template + mybatis。dbtree-vue resources will be package into dbtree-backend/src/main/resources/public. 

You need only deploy dbtree-backend/target/dbtree.jar.  



mysql schema folder：dbtree-backend/doc/schema



JDK version 1.8



The tool only deploy in develop environment, you don't need to deploy it in production, it is not safe.



## Thanks To



- [vue-admin-template](https://github.com/PanJiaChen/vue-admin-template)