mdbe

aim for database developer friendly tool.

created by golang.

Installation

Linux

$ curl -O https://github.com/matsuyoido/mdbe/raw/release/linux/mdbe

Windows

$ Invoke-WebRequest -Uri https://github.com/matsuyoido/mdbe/raw/release/windows/mdbe.exe

Mac

$ curl -O https://github.com/matsuyoido/mdbe/raw/release/mac/mdbe

Usage

basic

$ mdbe

yaml -> ddl

$ mdbe ddl

# if no ask execute
$ mdbe ddl -l ${yamlFilePath} -o ${outputDir}

yaml -> Entity Relation Diagram

# Entity Relation Diagram by plantUML
$ mdbe puml

## if no ask execute
$ mdbe puml -l ${yamlFilePath} -o ${outputDir}

# tables doc by markdown
$ mdbe mdoc

## if no ask execute
$ mdbe mdoc -l ${yamlFilePath} -o ${outputDir}

migration ddl

# generate diff DDL SQL
$ mdbe mgn

## if no ask execute
$ mdbe mgn -r ${DB "mysql" or "postgre"} -l ${yamlFilePath} -d ${DDLFilePath} -o ${outputSQLFilePath}

usage example

1. generate DDL SQL & manage with Git

    $ mdbe ddl -l product.yml -o dist
    $ git add dist/product.sql
    $ git commit ""
   

2. run generated DDL SQL

    $ mysql -u root -p < dist/product.sql
   

3. update yaml file

    $ vi product.yml
    $ git add product.yml
    $ git commit ""
   

4. generate diff SQL

    $ mdbe mgn -r mysql -l product.yml -d dist/product.sql -o dist/20220419-01.sql
   

5. run generated diff DDL SQL

    $ mysql -u root -p < dist/20220419-01.sql
   

database yaml format

※ please <> have to be changed depending on your environment.

minimum

tables:
  <tableName1>:
    columns:
      <columnName1>:
        type: <column_definition>
      <columnName2>:
        type: <column_definition>
  <tableName2>:
    columns:
      <columnName1>:
        type: <column_definition>

Primary Key

tables:
  <tableName1>:
    columns:
      <columnName>:
        type: <column_definition>
      pk:
        name: <primary_name>
        columns:
          - <primary_column_name>

Foreign Key

tables:
  <tableName1>:
    columns:
      <columnName>:
        type: <column_definition>
  <tableName2>:
    columns:
      <columnName>:
        type: <column_definition>
<foreign_key_name>:
  relate:
    - <tableName1>.<columnName>
  to:
    - <tableName2>.<columnName>

table definition

tables:
  <tableName>:
    columns:
      <columnName>:
        type: <column_definition>
      pk:
        name: <primary_name>
        columns:
          - <primary_column_name>
      uq:
        <uniqueKeyName>:
          - <unique_column_name>
      idx:
        <indexKeyName>:
          - <index_column_name>
      check:
        <checkConstraintName>: <constraint>
      logicalName: <logicalName>
      comment: <table_comment>

column definition

tables:
  <tableName>:
    columns:
      <columnName>:
        type: <column_definition>
        notNull: <true or false, default: false>
        logicalName: <logicalName>
        info: <column_comment>
        defaultValueText: <case varchar text>
        defaultValue: <case other>

aggregates the columns required for all tables into one location

commons:
  <columnName>:
    type: <column_definition>
    notNull: <true or false, default: false>
    logicalName: <logicalName>
    info: <column_comment>
    defaultValueText: <case varchar text>
    defaultValue: <case other>

aggregates column types into a single location

domains:
  <column_type_name>: <column_definition>

commons:
  <columnName>:
      type: <settable domains in column_type_name>

tables:
  <tableName>:
    columns:
      <columnName>:
        type: <settable domains in column_type_name>

full

version: <opt. your version>

domains:
  <column_type_name>: <column_definition>

commons:
  <columnName>:
    type: <column_definition>
    notNull: <opt. true or false>
    logicalName: <opt.>
    info: <opt. column_comment>
    defaultValueText: <opt. case varchar text>
    defaultValue: <opt. case other>

tables:
  <tableName>:
    columns:
      <columnName>:
        type: <column_definition>
        notNull: <opt. true or false>
        logicalName: <opt.>
        info: <opt. column_comment>
        defaultValueText: <opt. case varchar text>
        defaultValue: <opt. case other>
      pk:
        name: <opt.primary_name>
        columns:
          - <opt. primary_column_name>
      uq:
        <opt. uniqueKeyName>
          - <unique_column_name>
      idx:
        <opt. indexKeyName>
          - <index_column_name>
      check:
        <opt. checkConstraintName>: <constraint>
      logicalName: <opt.>
      comment: <opt. table_comment>

<opt. foreign_key_name>:
  relate:
    - <parent_table_name>.<parent_colum_name>
  to:
    - <child_table_name>.<child_column_name>

Bug or Request

please create New Issue in Japanese or English. (Japanese is better...)