包简介

Convert mysql table schema to markdown table

README 文档

README

Sql To Markdown 是一个可以将数据表的建表语句转换为 Markdown 表格的工具。

Installation

通过 Composer 安装

$ composer global require slince/sql-to-markdown

Usage

假设有一张表结构如下，将改sql保存到文件命名为 foo.sql

CREATE TABLE `hello_sql_to_markdown` (
  `id` int unsigned NOT NULL AUTO_INCREMENT default '0' COMMENT 'primary',
  `foo` decimal (20, 2) unsigned NOT NULL default '' COMMENT 'foo field',
  `bar` varchar (20) unsigned NOT NULL default '' COMMENT 'bar field',
  PRIMARY KEY (`id`),
) ENGINE=InnoDB AUTO_INCREMENT=2367038934 DEFAULT CHARSET=utf8mb4 COMMENT='Demo table schema';

执行下面命令：

$ sql2markdown  convert  --source=foo.sql

即可在当前文件夹下生成 foo.sql.md 文件。

name	type	length	default	comment
id	INT		0	primary
foo	DECIMAL	20,2		foo field
bar	VARCHAR	20		bar field

支持在一个文件里添加多个 DDL

查看帮助

$ sql2markdown --help

License

The MIT license. See MIT

slince/sql-to-markdown 适用场景与选型建议

slince/sql-to-markdown 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 97 次下载、GitHub Stars 达 16，最近一次更新时间为 2019 年 08 月 29 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 slince/sql-to-markdown 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 slince/sql-to-markdown 我们能提供哪些服务？

定制开发 / 二次开发

基于 slince/sql-to-markdown 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

slince/sql-to-markdown

包简介