精华内容
下载资源
问答
  • 快速生成数据库文档

    2018-07-30 17:06:12
    通过数据表,自动生成数据表结构文档.可自定义生成模板。mysql oracle msserver等
  • 需要jdk1.8的环境变量。 模板支持自定义,点击“自定义模板?”按钮,将新增的模板复制到该目录下即可。 本人将源码开放出来了,有需要的可以下载下来:https://github.com/JAdmin-JAVA/dbToDoc
  • 神通数据库文档.pdf

    2020-04-09 09:38:30
    本手册的阅读对象为神通数据库用户,用户若对 JAVA 语言和数据库基本概念有一定了 解,将对本手册的理解有很大的帮助。
  • 数据库文档生成工具,可以将数据库中的表属性生成doc文档,快捷方便,解决日常开发中的一些问题,需要jdk1.8的环境变量。源代码https://github.com/JAdmin-JAVA/dbToDoc
  • 根据数据库注释自动生成数据库文档【支持Oracle和Mysql】
  • 基于.net4.0写的数据库文档生成工具, 支持mysql, sql server, oracle, sqlte, access, txt, xml
  • DTCMS开发数据库表结构及字段说明文档,DTcms全名:Departure content management system,DT为Departure缩写,cms则为content management system的缩写。
  • Mysql数据库文档生成工具

    千次下载 热门讨论 2016-02-16 22:21:52
    给大家介绍一款数据库文档生成工具 目前只支持mysql 主要是生成docx的 客户有些时候需要数据库文档,为了方便,于是我就写了这个工具, 通过数据库读取相关表数据,达到输出所有注释到文档中,大大提高了工作效率
  • Greenplum数据库文档(中文),文档为pdf格式,只要介绍greenplum的系统架构和基本语法
  • 把Maticsoft.DbObjects.dll覆盖到动软安装文件夹内即可解决文档中没有备注问题
  • DTCMS数据库文档说明

    2019-04-18 21:21:05
    dtcms数据库说明文档,使用数据库生成工具生成的,DTCMS数据库文档说明
  • 验收时需要数据库设计文档,mysql的话可以用这个生成,配置好连接,安装有JAVA环境就可以,备注信息会自动写入到文档当中,亲测可用。
  • 基于Greenplum官方文档的中文版手册,超级实用,文档结构清晰。Greenplum数据库的最佳实践
  • 金蝶K3WISE文档说明,涉及财务,采购,仓储,合并报表,分销,人力资源,生产,应收应付,MTO等等数据库字段说明,共计67个文档
  • MySQL数据库文档生成工具
  • postgresql 数据库文档

    2015-08-03 20:21:57
    经过长期整理的Postgresq数据库文档,可以很方便查找函数,技巧,常用命令
  • 使用sql,查询出和数据库文档一样的列,用于生成数据库文档.(数据库备注要写清楚,否则出来的结果只有编码)
  • 用于在mysql,postgresq等数据库生成数据库文档,直接在windows,cmd命令框输入必要的数据库相关参数,enter一下就能直接生成你想要的数据库文档,节省了人工编写数据库带来的时间消耗
  • 数据库文档自动生成工具,安装说明,修改数据库名称,账号,密码就能把数据库的数据表信息导出到word文档中,改良后,导出的word更加精美
  • 数据库文档导出

    2018-09-19 15:25:04
    可通过该工具导出数据库文档,填写数据库地址、登录名
  • sql数据库文档

    2016-11-11 18:51:52
    SQL数据库文档,适合想学的人,快速上手
  • screw数据库文档生成工具是一个简洁好用的数据库表结构文档工具。 特点: 简洁、轻量、设计良好 多数据库支持 多种格式文档 灵活扩展 支持自定义模板 数据库支持MySQL、MariaDB、TIDB、Oracle、SqlServer、...
  • 该工具是用于自动生成数据库文档,由于表多,且写文档麻烦,特意整理成一工具。 支持所有支持 JDBC 的数据库,并简单抽象成一个自动化框架,使用者可以自行自定义连接,导出样式等。 另附带一个数据库比较工具,用于...
  • 现在提供C#编写的数据库文档生成工具,可以方便快捷的为现有的数据库自动生成设计文档,文档内容包括字段名称,字段类型,字段大小,主键,允许为空,说明等信息。为ACCESS,SQL SERVER数据库生成设计文档,已经测试...
  • 数据库设计文档

    2018-09-27 20:21:07
    数据库设计文档,适合对一些数据库文档设计不太了解的人参考。
  • java电商开源项目javashop数据库设计文档、sql脚本及操作手册
  • Github上一款一键生成数据库文档的大利器!

    千次阅读 多人点赞 2021-08-07 21:27:03
    文章目录介绍快速开始表结构脚本基于 Java 代码引入 screw 及相关依赖代码编写基于 Maven 插件引入screw及相关依赖配置maven-plugins手动执行生成数据库文档成品地址 介绍 今天看了 Guide老哥 公众号(需要的朋友...

    介绍

    今天看了 Guide老哥 公众号(需要的朋友可以关注一波: JavaGuide)中的一篇文章,发现了一款好用的数据库文档生成工具。

    在项目中开发中,有没有遇到过编写数据库说明文档。一般情况下,数据库说明文档中有着大量的数据库表结构,如果手动进行维护,将会耗费大量时间,这样就不能愉快的进行摸鱼了。

    所以呢,为了解决这个问题,Github 上的大佬开源了一款数据库表结构文档自动生成工具 —— screw
    在这里插入图片描述
    screw项目地址:https://github.com/pingfangushi/screw

    screw 翻译过来的意思就是螺丝钉,作者希望这个工具能够像螺丝钉一样切实地帮助到我们的开发工作。

    目前的话,screw 已经支持市面上大部分常见的数据库比如 MySQL、MariaDB、Oracle、SqlServer、PostgreSQL、TiDB。

    快速开始

    表结构脚本

    为了验证 screw 自动生成数据库表结构文档的效果,我们首先创建一个简单的存放博客数据的数据库表。

    CREATE TABLE `screw-demo-blog` (
      `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
      `title` varchar(255) NOT NULL COMMENT '博客标题',
      `content` longtext NOT NULL COMMENT '博客内容',
      `description` varchar(255) DEFAULT NULL COMMENT '博客简介',
      `cover` varchar(255) DEFAULT NULL COMMENT '博客封面图片地址',
      `views` int(11) NOT NULL DEFAULT '0' COMMENT '博客阅读次数',
      `user_id` bigint(20) DEFAULT '0' COMMENT '发表博客的用户ID',
      `channel_id` bigint(20) NOT NULL COMMENT '博客分类ID',
      `recommend` bit(1) NOT NULL DEFAULT b'0' COMMENT '是否推荐',
      `top` bit(1) NOT NULL DEFAULT b'0' COMMENT '是否置顶',
      `comment` bit(1) NOT NULL DEFAULT b'1' COMMENT '是否开启评论',
      `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
      `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '更新时间',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=16 DEFAULT CHARSET=utf8mb4 COMMENT='博客';
    

    基于 Java 代码

    引入 screw 及相关依赖

    创建一个普通的maven项目,导入以下依赖

    <!--screw-->
    <dependency>
        <groupId>cn.smallbun.screw</groupId>
        <artifactId>screw-core</artifactId>
        <version>1.0.5</version>
    </dependency>
    <!-- HikariCP -->
    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
        <version>3.4.5</version>
    </dependency>
    <!--MySQL-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.20</version>
    </dependency>
    

    你可以通过下面的地址在 mvnrepository 获取最新版本的 screw。

    https://mvnrepository.com/artifact/cn.smallbun.screw/screw-core

    代码编写

    生成数据库文档的代码的整个代码逻辑还是比较简单的,我们只需要经过下面 5 步即可:

    1、获取数据库源

    /**
     * 获取数据库源
     */
    private static DataSource getDataSource() {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/test");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("root");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        return new HikariDataSource(hikariConfig);
    }
    

    2、获取文件生成配置

    /**
     * 获取文件生成配置
     */
    private static EngineConfig getEngineConfig() {
        //生成配置
        return EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("/Users/guide/Documents/代码示例/screw-demo/doc")
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(EngineFileType.HTML)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName("数据库结构文档").build();
    }
    

    注意,如果不配置生成文件路径的话,默认也会存放在项目的 doc 目录下。

    另外,我们这里指定生成的文件格式为 HTML。除了 HTML 之外,screw 还支持 Word 、Markdown 这两种文件格式。

    3、获取数据库表的处理配置
    可以在这里指定只生成哪些表结构(这个是可选项)

    /**
     * 获取数据库表的处理配置,可忽略
     */
    private static ProcessConfig getProcessConfig() {
        return ProcessConfig.builder()
          // 指定只生成 blog 表
          .designatedTableName(new ArrayList<>(Collections.singletonList("screw-demo-blog")))
          .build();
    }
    

    这里进行设置需要忽略生成的表结构(这个也是可选项)

    private static ProcessConfig getProcessConfig() {
        ArrayList<String> ignoreTableName = new ArrayList<>();
        ignoreTableName.add("test_user");
        ignoreTableName.add("test_group");
        ArrayList<String> ignorePrefix = new ArrayList<>();
        ignorePrefix.add("test_");
        ArrayList<String> ignoreSuffix = new ArrayList<>();
        ignoreSuffix.add("_test");
        return ProcessConfig.builder()
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix)
                .build();
    }
    

    如果以上设置都没有注定 ProcessConfig 进行配置的话,就会按照默认配置来!

    4、生成 screw 完整配置

    private static Configuration getScrewConfig(DataSource dataSource, EngineConfig engineConfig, ProcessConfig processConfig) {
        return Configuration.builder()
                //版本
                .version("1.0.0")
                //描述
                .description("数据库设计文档生成")
                //数据源
                .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig)
                .build();
    }
    

    5、调用执行

    private static Configuration getScrewConfig(DataSource dataSource, EngineConfig engineConfig, ProcessConfig processConfig) {
        return Configuration.builder()
                //版本
                .version("1.0.0")
                //描述
                .description("数据库设计文档生成")
                //数据源
                .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig)
                .build();
    }
    

    生成结果效果展示(.html):
    在这里插入图片描述

    基于 Maven 插件

    除了基于 Java 代码这种方式之外,你还可以通过 screw 提供的 Maven 插件来生成数据库文档。个人感觉maven插件的方式更加简单!

    引入screw及相关依赖

    这一步操作还是一样,保持不变

    <!--screw-->
    <dependency>
        <groupId>cn.smallbun.screw</groupId>
        <artifactId>screw-core</artifactId>
        <version>1.0.5</version>
    </dependency>
    <!-- HikariCP -->
    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
        <version>3.4.5</version>
    </dependency>
    <!--MySQL-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.20</version>
    </dependency>
    

    配置maven-plugins

    这里还是在以上的依赖 pom.xml 文件中进行配置:

    <build>
        <plugins>
            <plugin>
                <groupId>cn.smallbun.screw</groupId>
                <artifactId>screw-maven-plugin</artifactId>
                <version>1.0.5</version>
                <dependencies>
                    <!-- HikariCP -->
                    <dependency>
                        <groupId>com.zaxxer</groupId>
                        <artifactId>HikariCP</artifactId>
                        <version>3.4.5</version>
                    </dependency>
                    <!--mysql driver-->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.20</version>
                    </dependency>
                </dependencies>
                <configuration>
                    <!--username-->
                    <username>root</username>
                    <!--password-->
                    <password>root</password>
                    <!--driver-->
                    <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
                    <!--jdbc url-->
                    <jdbcUrl>jdbc:mysql://127.0.0.1:3306/test</jdbcUrl>
                    <!--生成文件类型-->
                    <fileType>MD</fileType>
                    <!--打开文件输出目录-->
                    <openOutputDir>true</openOutputDir>
                    <!--生成模板-->
                    <produceType>freemarker</produceType>
                    <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
                    <fileName>数据库结构文档</fileName>
                    <!--描述-->
                    <description>数据库设计文档生成</description>
                    <!--版本-->
                    <version>${project.version}</version>
                    <!--标题-->
                    <title>数据库文档</title>
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>run</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    

    手动执行生成数据库文档

    在这里插入图片描述
    生成结果效果展示(.md):
    在这里插入图片描述

    成品地址

    这里呢,我已经把以上的示例代码上传到我码云仓库中,需要的朋友直接clone下来就可以运行使用。
    本博客示例代码获取地址:https://gitee.com/zhuziccEE/screw-code.git


    如果感觉文章对你有帮助,就给点个赞吧!

    展开全文
  • 选择数据库类型,配置数据库来源,选择需要生成的表,一键生成数据库文档
  • 数据库文档生成器

    2015-04-22 11:57:15
    快速根据Sql server数据库结构生成数据库CHM文档,

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 882,720
精华内容 353,088
关键字:

数据库文档