テーブル定義書が欲しいと思いSQLでMarkdownを出力するようにしました。
ちなみに普通にテーブル定義書を出力するA5:SQL Mk-2というソフトがありますが、こちらはエクセルになります。
出力情報
- テーブル定義
- INDEX定義
必要に応じて機能を追加していきます。
SQL
使用方法は簡単です。
下記SQLを実行して出力結果がMarkdownなので貼り付けるだけ。
クライアントの結果によっては調整などが必要になるかも知れないのでご注意ください。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | -- Mysql テーブル、INDEX定義マークダウン出力SELECT CONCAT( COLUMN_NAME , COLUMN_DEFAULT , IS_NULLABLE , COLUMN_TYPE , COLUMN_KEY , EXTRA , COLUMN_COMMENT ) AS Markdown FROM ( SELECT '' AS TABLE_NAME , CONCAT('\r\n# ', schema_name) AS COLUMN_NAME , '' AS COLUMN_DEFAULT , '' AS IS_NULLABLE , '' AS COLUMN_TYPE , '' AS COLUMN_KEY , '' AS EXTRA , '' AS COLUMN_COMMENT , '-99' AS ORDINAL_POSITION FROM information_schema.schemata WHERE schema_name = database() UNION ALL SELECT TABLE_NAME , CONCAT('\r\n## ', TABLE_NAME) AS COLUMN_NAME , IF(LENGTH(TABLE_COMMENT) > 0, CONCAT('（', TABLE_COMMENT, '）'), '' ) AS COLUMN_DEFAULT , '\r\n### テーブル定義' AS IS_NULLABLE , '' AS COLUMN_TYPE , '' AS COLUMN_KEY , '' AS EXTRA , '' AS COLUMN_COMMENT , '-2' AS ORDINAL_POSITION FROM information_schema.tables WHERE table_schema = database() UNION ALL SELECT TABLE_NAME , '| 列名 ' AS COLUMN_NAME , '| デフォルト ' AS COLUMN_DEFAULT , '| NULL ' AS IS_NULLABLE , '| 型 ' AS COLUMN_TYPE , '| キー ' AS COLUMN_KEY , '| その他 ' AS EXTRA , '| コメント ' AS COLUMN_COMMENT , '-1' AS ORDINAL_POSITION FROM information_schema.tables WHERE table_schema = database() UNION ALL SELECT TABLE_NAME , '|---' AS COLUMN_NAME , '|---' AS COLUMN_DEFAULT , '|---' AS IS_NULLABLE , '|---' AS COLUMN_TYPE , '|---' AS COLUMN_KEY , '|---' AS EXTRA , '|---|' AS COLUMN_COMMENT , '0' AS ORDINAL_POSITION FROM information_schema.tables WHERE table_schema = database() UNION ALL SELECT TABLE_NAME , CONCAT('| ', COLUMN_NAME) , CONCAT('| ', IFNULL(COLUMN_DEFAULT, '')) , CONCAT('| ', IS_NULLABLE) , CONCAT('| ', COLUMN_TYPE) , CONCAT('| ', COLUMN_KEY) , CONCAT('| ', EXTRA) , CONCAT('| ', COLUMN_COMMENT, '|') , ORDINAL_POSITION FROM information_schema.columns WHERE table_schema = database() UNION ALL SELECT DISTINCT TABLE_NAME , '\r\n### INDEX情報\r\n| INDEX名 ' AS COLUMN_NAME , '| INDEX列 ' AS COLUMN_DEFAULT , '| UNIQUE ' AS IS_NULLABLE , '|コメント |' AS COLUMN_TYPE , '' AS COLUMN_KEY , ' ' AS EXTRA , '' AS COLUMN_COMMENT , '1001' AS ORDINAL_POSITION FROM information_schema.statistics WHERE table_schema = database() UNION ALL SELECT DISTINCT TABLE_NAME , '|---' AS COLUMN_NAME , '|---' AS COLUMN_DEFAULT , '|---' AS IS_NULLABLE , '|---|' AS COLUMN_TYPE , '' AS COLUMN_KEY , '' AS EXTRA , '' AS COLUMN_COMMENT , '1002' AS ORDINAL_POSITION FROM information_schema.statistics WHERE table_schema = database() UNION ALL SELECT TABLE_NAME , CONCAT('| ', INDEX_NAME) AS COLUMN_NAME , CONCAT( '| ' , GROUP_CONCAT(COLUMN_NAME ORDER BY SEQ_IN_INDEX) ) AS COLUMN_DEFAULT , CONCAT('| ', IF (NON_UNIQUE = 0, 'UNIQUE', '')) AS IS_NULLABLE , CONCAT('| ', COMMENT, '|') AS COLUMN_TYPE , '' AS COLUMN_KEY , '' AS EXTRA , '' AS COLUMN_COMMENT , '1003' AS ORDINAL_POSITION FROM information_schema.statistics WHERE table_schema = database() GROUP BY TABLE_NAME , INDEX_NAME ) tempORDER BY TABLE_NAME , CAST(ORDINAL_POSITION AS SIGNED); |
出力結果
こちらが出力結果になります。
サンプルとしてMysql公式のサンプルのworldDBで使用した出力結果になります。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | # world## city### テーブル定義| 列名 | デフォルト | NULL | 型 | キー | その他 | コメント |---|---|---|---|---|---|---|| ID| | NO| int(11)| PRI| auto_increment| || Name| | NO| char(35)| | | || CountryCode| | NO| char(3)| MUL| | || District| | NO| char(20)| | | || Population| 0| NO| int(11)| | | |### INDEX情報| INDEX名 | INDEX列 | UNIQUE |コメント | |---|---|---|---|| CountryCode| CountryCode| | || PRIMARY| ID| UNIQUE| |## country### テーブル定義| 列名 | デフォルト | NULL | 型 | キー | その他 | コメント |---|---|---|---|---|---|---|| Code| | NO| char(3)| PRI| | || Name| | NO| char(52)| | | || Continent| Asia| NO| enum('Asia','Europe','North America','Africa','Oceania','Antarctica','South America')| | | || Region| | NO| char(26)| | | || SurfaceArea| 0.00| NO| decimal(10,2)| | | || IndepYear| | YES| smallint(6)| | | || Population| 0| NO| int(11)| | | || LifeExpectancy| | YES| decimal(3,1)| | | || GNP| | YES| decimal(10,2)| | | || GNPOld| | YES| decimal(10,2)| | | || LocalName| | NO| char(45)| | | || GovernmentForm| | NO| char(45)| | | || HeadOfState| | YES| char(60)| | | || Capital| | YES| int(11)| | | || Code2| | NO| char(2)| | | |### INDEX情報| INDEX名 | INDEX列 | UNIQUE |コメント | |---|---|---|---|| PRIMARY| Code| UNIQUE| |## countrylanguage### テーブル定義| 列名 | デフォルト | NULL | 型 | キー | その他 | コメント |---|---|---|---|---|---|---|| CountryCode| | NO| char(3)| PRI| | || Language| | NO| char(30)| PRI| | || IsOfficial| F| NO| enum('T','F')| | | || Percentage| 0.0| NO| decimal(4,1)| | | |### INDEX情報| INDEX名 | INDEX列 | UNIQUE |コメント | |---|---|---|---|| CountryCode| CountryCode| | || PRIMARY| CountryCode,Language| UNIQUE| | |
0 件のコメント :
コメントを投稿