Add er.hideDef: for hiding relation definition

README.md

@@ -630,6 +630,9 @@ er:
   # Add table/column comment to ER diagram
   # Default is false
   comment: true
+  # Hide relation definition from ER diagram
+  # Default is false
+  hideDef: true
   # Distance between tables that display relations in the ER
   # Default is 1
   distance: 2

config/config.go

@@ -83,6 +83,7 @@ type ER struct {
 	Skip     bool   `yaml:"skip,omitempty"`
 	Format   string `yaml:"format,omitempty"`
 	Comment  bool   `yaml:"comment,omitempty"`
+	HideDef  bool   `yaml:"hideDef,omitempty"`
 	Distance *int   `yaml:"distance,omitempty"`
 	Font     string `yaml:"font,omitempty"`
 }

output/dot/dot.go

@@ -71,6 +71,7 @@ func (d *Dot) OutputSchema(wr io.Writer, s *schema.Schema) error {
 	err = tmpl.Execute(wr, map[string]interface{}{
 		"Schema":      s,
 		"showComment": d.config.ER.Comment,
+		"showDef":     !d.config.ER.HideDef,
 	})
 	if err != nil {
 		return errors.WithStack(err)
@@ -96,6 +97,7 @@ func (d *Dot) OutputTable(wr io.Writer, t *schema.Table) error {
 		"Tables":      tables[1:],
 		"Relations":   relations,
 		"showComment": d.config.ER.Comment,
+		"showDef":     !d.config.ER.HideDef,
 	})
 	if err != nil {
 		return errors.WithStack(err)

output/dot/dot_test.go

@@ -13,9 +13,11 @@ import (
 
 func TestOutputSchema(t *testing.T) {
 	tests := []struct {
+		hideDef  bool
 		wantFile string
 	}{
-		{"dot_test_schema.dot"},
+		{false, "dot_test_schema.dot"},
+		{true, "dot_test_schema.dot.hidedef"},
 	}
 	for _, tt := range tests {
 		t.Run(tt.wantFile, func(t *testing.T) {
@@ -24,6 +26,7 @@ func TestOutputSchema(t *testing.T) {
 			if err != nil {
 				t.Error(err)
 			}
+			c.ER.HideDef = tt.hideDef
 			if err := c.LoadConfigFile(filepath.Join(testdataDir(), "out_test_tbls.yml")); err != nil {
 				t.Error(err)
 			}

output/mermaid/mermaid.go

@@ -71,6 +71,7 @@ func (m *Mermaid) OutputSchema(wr io.Writer, s *schema.Schema) error {
 	err = tmpl.Execute(wr, map[string]interface{}{
 		"Schema":      s,
 		"showComment": m.config.ER.Comment,
+		"showDef":     !m.config.ER.HideDef,
 	})
 	if err != nil {
 		return errors.WithStack(err)
@@ -95,6 +96,7 @@ func (m *Mermaid) OutputTable(wr io.Writer, t *schema.Table) error {
 		"Tables":      tables[1:],
 		"Relations":   relations,
 		"showComment": m.config.ER.Comment,
+		"showDef":     !m.config.ER.HideDef,
 	})
 	if err != nil {
 		return errors.WithStack(err)

output/mermaid/mermaid_test.go

@@ -13,30 +13,40 @@ import (
 )
 
 func TestOutputSchema(t *testing.T) {
-	s := testutil.NewSchema(t)
-	c, err := config.New()
-	if err != nil {
-		t.Error(err)
-	}
-	if err := c.LoadConfigFile(filepath.Join(testdataDir(), "out_test_tbls.yml")); err != nil {
-		t.Error(err)
-	}
-	if err := c.MergeAdditionalData(s); err != nil {
-		t.Error(err)
-	}
-	o := New(c)
-	got := &bytes.Buffer{}
-	err = o.OutputSchema(got, s)
-	if err != nil {
-		t.Error(err)
-	}
-	f := fmt.Sprintf("mermaid_test_schema")
-	if os.Getenv("UPDATE_GOLDEN") != "" {
-		golden.Update(t, testdataDir(), f, got)
-		return
-	}
-	if diff := golden.Diff(t, testdataDir(), f, got); diff != "" {
-		t.Error(diff)
+	tests := []struct {
+		hideDef  bool
+		wantFile string
+	}{
+		{false, "mermaid_test_schema"},
+		{true, "mermaid_test_schema.hidedef"},
+	}
+	for _, tt := range tests {
+		t.Run(tt.wantFile, func(t *testing.T) {
+			s := testutil.NewSchema(t)
+			c, err := config.New()
+			if err != nil {
+				t.Error(err)
+			}
+			if err := c.LoadConfigFile(filepath.Join(testdataDir(), "out_test_tbls.yml")); err != nil {
+				t.Error(err)
+			}
+			if err := c.ModifySchema(s); err != nil {
+				t.Error(err)
+			}
+			c.ER.HideDef = tt.hideDef
+			o := New(c)
+			got := &bytes.Buffer{}
+			if err := o.OutputSchema(got, s); err != nil {
+				t.Error(err)
+			}
+			if os.Getenv("UPDATE_GOLDEN") != "" {
+				golden.Update(t, testdataDir(), tt.wantFile, got)
+				return
+			}
+			if diff := golden.Diff(t, testdataDir(), tt.wantFile, got); diff != "" {
+				t.Error(diff)
+			}
+		})
 	}
 }
 

output/mermaid/templates/schema.mermaid.tmpl

@@ -1,7 +1,8 @@
 erDiagram
 {{ $sc := .showComment -}}
+{{- $sd := .showDef -}}
 {{- range $j, $r := .Schema.Relations }}
-"{{ $r.Table.Name }}" {{ $r.Cardinality | lcardi }}--{{ $r.ParentCardinality | rcardi }} "{{ $r.ParentTable.Name }}" : "{{ $r.Def | html }}"
+"{{ $r.Table.Name }}" {{ $r.Cardinality | lcardi }}--{{ $r.ParentCardinality | rcardi }} "{{ $r.ParentTable.Name }}" : "{{ if $sd }}{{ $r.Def | html }}{{ end }}"
 {{- end }}
 {{ range $i, $t := .Schema.Tables }}
 "{{ $t.Name }}" {

output/mermaid/templates/table.mermaid.tmpl

@@ -1,7 +1,8 @@
 erDiagram
 {{ $sc := .showComment -}}
+{{ $sd := .showDef -}}
 {{- range $j, $r := .Relations }}
-"{{ $r.Table.Name }}" {{ $r.Cardinality | lcardi }}--{{ $r.ParentCardinality | rcardi }} "{{ $r.ParentTable.Name }}" : "{{ $r.Def | html }}"
+"{{ $r.Table.Name }}" {{ $r.Cardinality | lcardi }}--{{ $r.ParentCardinality | rcardi }} "{{ $r.ParentTable.Name }}" : "{{ if $sd }}{{ $r.Def | html }}{{ end }}"
 {{- end }}
 
 "{{ .Table.Name }}" {

output/plantuml/plantuml.go

@@ -80,6 +80,7 @@ func (p *PlantUML) OutputSchema(wr io.Writer, s *schema.Schema) error {
 	err = tmpl.Execute(wr, map[string]interface{}{
 		"Schema":      s,
 		"showComment": p.config.ER.Comment,
+		"showDef":     !p.config.ER.HideDef,
 	})
 	if err != nil {
 		return errors.WithStack(err)
@@ -110,6 +111,7 @@ func (p *PlantUML) OutputTable(wr io.Writer, t *schema.Table) error {
 		"Tables":      tables[1:],
 		"Relations":   relations,
 		"showComment": p.config.ER.Comment,
+		"showDef":     !p.config.ER.HideDef,
 	})
 	if err != nil {
 		return errors.WithStack(err)

output/plantuml/plantuml_test.go

@@ -13,30 +13,41 @@ import (
 )
 
 func TestOutputSchema(t *testing.T) {
-	s := testutil.NewSchema(t)
-	c, err := config.New()
-	if err != nil {
-		t.Error(err)
-	}
-	if err := c.LoadConfigFile(filepath.Join(testdataDir(), "out_test_tbls.yml")); err != nil {
-		t.Error(err)
-	}
-	if err := c.MergeAdditionalData(s); err != nil {
-		t.Error(err)
-	}
-	o := New(c)
-	got := &bytes.Buffer{}
-	err = o.OutputSchema(got, s)
-	if err != nil {
-		t.Error(err)
-	}
-	f := fmt.Sprintf("plantuml_test_schema.puml")
-	if os.Getenv("UPDATE_GOLDEN") != "" {
-		golden.Update(t, testdataDir(), f, got)
-		return
-	}
-	if diff := golden.Diff(t, testdataDir(), f, got); diff != "" {
-		t.Error(diff)
+	tests := []struct {
+		hideDef  bool
+		wantFile string
+	}{
+		{false, "plantuml_test_schema.puml"},
+		{true, "plantuml_test_schema.puml.hidedef"},
+	}
+	for _, tt := range tests {
+		t.Run(tt.wantFile, func(t *testing.T) {
+			s := testutil.NewSchema(t)
+			c, err := config.New()
+			if err != nil {
+				t.Error(err)
+			}
+			if err := c.LoadConfigFile(filepath.Join(testdataDir(), "out_test_tbls.yml")); err != nil {
+				t.Error(err)
+			}
+			if err := c.ModifySchema(s); err != nil {
+				t.Error(err)
+			}
+			c.ER.HideDef = tt.hideDef
+			o := New(c)
+			got := &bytes.Buffer{}
+			err = o.OutputSchema(got, s)
+			if err != nil {
+				t.Error(err)
+			}
+			if os.Getenv("UPDATE_GOLDEN") != "" {
+				golden.Update(t, testdataDir(), tt.wantFile, got)
+				return
+			}
+			if diff := golden.Diff(t, testdataDir(), tt.wantFile, got); diff != "" {
+				t.Error(diff)
+			}
+		})
 	}
 }
 

output/plantuml/templates/schema.puml.tmpl

@@ -1,5 +1,6 @@
 @startuml
 {{ $sc := .showComment -}}
+{{- $sd := .showDef -}}
 !define table(name, desc) entity name as "desc" << (T,#5DBCD2) >>
 !define view(name, desc) entity name as "desc" << (V,#C6EDDB) >>
 !define column(name, type, desc) name <font color="#666666">[type]</font><font color="#333333">desc</font>
@@ -27,7 +28,7 @@ view("{{ $t.Name }}", "{{ $t.Name }}{{ if $sc }}{{ if ne $t.Comment "" }}\n{{ $t
 
 ' relations
 {{- range $j, $r := .Schema.Relations }}
-"{{ $r.Table.Name }}" {{ $r.Cardinality | lcardi }}--{{ $r.ParentCardinality | rcardi }} "{{ $r.ParentTable.Name }}" : "{{ $r.Def | html }}"
+"{{ $r.Table.Name }}" {{ $r.Cardinality | lcardi }}--{{ $r.ParentCardinality | rcardi }} "{{ $r.ParentTable.Name }}" : "{{ if $sd }}{{ $r.Def | html }}{{ end }}"
 {{- end }}
 
 @enduml

output/plantuml/templates/table.puml.tmpl

@@ -1,5 +1,6 @@
 @startuml
 {{ $sc := .showComment -}}
+{{- $sd := .showDef -}}
 !define table(name, desc) entity name as "desc" << (T,#5DBCD2) >>
 !define view(name, desc) entity name as "desc" << (V,#C6EDDB) >>
 !define column(name, type, desc) name <font color="#666666">[type]</font><font color="#333333">desc</font>
@@ -36,7 +37,7 @@ view("{{ $t.Name }}", "{{ $t.Name }}{{ if $sc }}{{ if ne $t.Comment "" }}\n{{ $t
 
 ' relations
 {{- range $j, $r := .Relations }}
-"{{ $r.Table.Name }}" {{ $r.Cardinality | lcardi }}--{{ $r.ParentCardinality | rcardi }} "{{ $r.ParentTable.Name }}" : "{{ $r.Def | html }}"
+"{{ $r.Table.Name }}" {{ $r.Cardinality | lcardi }}--{{ $r.ParentCardinality | rcardi }} "{{ $r.ParentTable.Name }}" : "{{ if $sd }}{{ $r.Def | html }}{{ end }}"
 {{- end }}
 
 @enduml

testdata/dot_template_test_a.dot.golden

@@ -17,5 +17,5 @@ digraph "a" {
               </table>>];
 
   // Relations
-  "b":"b" -> "a":"a" [dir=back, arrowtail=tee,  taillabel=<<table cellpadding="5" border="0" cellborder="0"><tr><td></td></tr></table>>];
+  "b":"b" -> "a":"a" [dir=back, arrowtail=tee,  taillabel=<<table cellpadding="5" border="0" cellborder="0"><tr><td>FOREIGN KEY (b) REFERENCES a(a)</td></tr></table>>];
 }

testdata/dot_template_test_schema.dot.golden

@@ -17,5 +17,5 @@ digraph "testschema" {
               </table>>];
 
   // Relations
-  "b":"b" -> "a":"a" [dir=back, arrowtail=tee,  taillabel=<<table cellpadding="5" border="0" cellborder="0"><tr><td></td></tr></table>>];
+  "b":"b" -> "a":"a" [dir=back, arrowtail=tee,  taillabel=<<table cellpadding="5" border="0" cellborder="0"><tr><td>FOREIGN KEY (b) REFERENCES a(a)</td></tr></table>>];
 }

testdata/dot_test_a.dot.golden

@@ -17,5 +17,5 @@ digraph "a" {
               </table>>];
 
   // Relations
-  "b":"b" -> "a":"a" [dir=back, arrowtail=crow,  taillabel=<<table cellpadding="5" border="0" cellborder="0"><tr><td></td></tr></table>>];
+  "b":"b" -> "a":"a" [dir=back, arrowtail=crow,  taillabel=<<table cellpadding="5" border="0" cellborder="0"><tr><td>FOREIGN KEY (b) REFERENCES a(a)</td></tr></table>>];
 }

testdata/dot_test_schema.dot.golden

@@ -17,5 +17,5 @@ digraph "testschema" {
               </table>>];
 
   // Relations
-  "b":"b" -> "a":"a" [dir=back, arrowtail=crow,  taillabel=<<table cellpadding="5" border="0" cellborder="0"><tr><td></td></tr></table>>];
+  "b":"b" -> "a":"a" [dir=back, arrowtail=crow,  taillabel=<<table cellpadding="5" border="0" cellborder="0"><tr><td>FOREIGN KEY (b) REFERENCES a(a)</td></tr></table>>];
 }

testdata/dot_test_schema.dot.hidedef.golden

@@ -0,0 +1,21 @@
+digraph "testschema" {
+  // Config
+  graph [rankdir=TB, layout=dot, fontname="Arial"];
+  node [shape=record, fontsize=14, margin=0.6, fontname="Arial"];
+  edge [fontsize=10, labelfloat=false, splines=none, fontname="Arial"];
+
+  // Tables
+  "a" [shape=none, label=<<table border="0" cellborder="1" cellspacing="0" cellpadding="6">
+                 <tr><td bgcolor="#EFEFEF"><font face="Arial Bold" point-size="18">a</font> <font color="#666666">[]</font></td></tr>
+                 <tr><td port="a" align="left">a <font color="#666666">[INTEGER]</font></td></tr>
+                 <tr><td port="a2" align="left">a2 <font color="#666666">[TEXT]</font></td></tr>
+              </table>>];
+  "b" [shape=none, label=<<table border="0" cellborder="1" cellspacing="0" cellpadding="6">
+                 <tr><td bgcolor="#EFEFEF"><font face="Arial Bold" point-size="18">b</font> <font color="#666666">[]</font></td></tr>
+                 <tr><td port="b" align="left">b <font color="#666666">[INTEGER]</font></td></tr>
+                 <tr><td port="b2" align="left">b2 <font color="#666666">[TEXT]</font></td></tr>
+              </table>>];
+
+  // Relations
+  "b":"b" -> "a":"a" [dir=back, arrowtail=crow,  taillabel=<<table cellpadding="5" border="0" cellborder="0"><tr><td></td></tr></table>>];
+}

testdata/json_output_schema.golden

@@ -92,7 +92,7 @@
         "a"
       ],
       "parent_cardinality": "Exactly one",
-      "def": "",
+      "def": "FOREIGN KEY (b) REFERENCES a(a)",
       "virtual": false
     }
   ],

testdata/mermaid_template_test_schema.golden

@@ -1,3 +1,3 @@
 erDiagram
 
-"b" }|--|| "a" : ""
+"b" }|--|| "a" : "FOREIGN KEY (b) REFERENCES a(a)"

testdata/mermaid_test_a.golden

@@ -1,6 +1,6 @@
 erDiagram
 
-"b" }|--|| "a" : ""
+"b" }|--|| "a" : "FOREIGN KEY (b) REFERENCES a(a)"
 
 "a" {
   INTEGER a

testdata/mermaid_test_schema.golden

@@ -1,12 +1,12 @@
 erDiagram
 
-"b" }|--|| "a" : ""
+"b" }|--|| "a" : "FOREIGN KEY (b) REFERENCES a(a)"
 
 "a" {
-  INTEGER a
+  INTEGER a PK
   TEXT a2
 }
 "b" {
-  INTEGER b
+  INTEGER b FK
   TEXT b2
 }

testdata/mermaid_test_schema.hidedef.golden

@@ -0,0 +1,12 @@
+erDiagram
+
+"b" }|--|| "a" : ""
+
+"a" {
+  INTEGER a PK
+  TEXT a2
+}
+"b" {
+  INTEGER b FK
+  TEXT b2
+}

testdata/plantuml_template_test_a.puml.golden

@@ -22,6 +22,6 @@ table("b", "b") {
 }
 
 ' relations
-"b" }-- "a" : ""
+"b" }-- "a" : "FOREIGN KEY (b) REFERENCES a(a)"
 
 @enduml

testdata/plantuml_template_test_schema.puml.golden

@@ -22,6 +22,6 @@ table("b", "b") {
 }
 
 ' relations
-"b" }-- "a" : ""
+"b" }-- "a" : "FOREIGN KEY (b) REFERENCES a(a)"
 
 @enduml

testdata/plantuml_test_a.puml.golden

@@ -22,6 +22,6 @@ table("b", "b") {
 }
 
 ' relations
-"b" }|--|| "a" : ""
+"b" }|--|| "a" : "FOREIGN KEY (b) REFERENCES a(a)"
 
 @enduml