Skip to content

Start of considering unique and not null contraints. #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
hydrogen602 wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Start of considering unique and not null contraints. #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
317bf23
add goreleaser write permission
KarnerTh Dec 29, 2024
67069f3
basic consideration of unique and nullable
hydrogen602 Dec 31, 2024
3c9102a
relationManyToMaybeOne
hydrogen602 Dec 31, 2024
52538d8
unit test fixes
hydrogen602 Dec 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/release_build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ on:
push:
tags:
- "*"
permissions:
contents: write
jobs:
goreleaser:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion diagram/diagram.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func (d diagram) Create(wr io.Writer, result *database.Result) error {
continue
}

constraints = append(constraints, getConstraintData(d.config, relationshipLabelMap, constraint))
constraints = append(constraints, getConstraintData(d.config, relationshipLabelMap, result.Tables, constraint))
}

diagramData := ErdDiagramData{
Expand Down
6 changes: 4 additions & 2 deletions diagram/diagram_data.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ package diagram
type ErdRelationType string

const (
relationOneToOne ErdRelationType = "|o--||"
relationManyToOne ErdRelationType = "}o--||"
relationOneToOne ErdRelationType = "|o--||"
relationOneToMaybeOne ErdRelationType = "|o--o|"
relationManyToOne ErdRelationType = "}o--||"
relationManyToMaybeOne ErdRelationType = "}o--o|"
)

type ErdAttributeKey string
Expand Down
27 changes: 24 additions & 3 deletions diagram/diagram_util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,15 @@ import (
"github.com/KarnerTh/mermerd/database"
)

func getRelation(constraint database.ConstraintResult) ErdRelationType {
func getRelation(constraint database.ConstraintResult, isUnique bool, isNullable bool) ErdRelationType {
if constraint.IsPrimary && !constraint.HasMultiplePK {
return relationOneToOne
} else if isUnique && isNullable {
return relationOneToMaybeOne
} else if isUnique {
return relationOneToOne
} else if isNullable {
return relationManyToMaybeOne
} else {
return relationManyToOne
}
Expand Down Expand Up @@ -96,7 +102,7 @@ func shouldSkipConstraint(config config.MermerdConfig, tables []ErdTableData, co
return !(tableNameInSlice(tables, constraint.PkTable) && tableNameInSlice(tables, constraint.FkTable))
}

func getConstraintData(config config.MermerdConfig, labelMap RelationshipLabelMap, constraint database.ConstraintResult) ErdConstraintData {
func getConstraintData(config config.MermerdConfig, labelMap RelationshipLabelMap, tables []database.TableResult, constraint database.ConstraintResult) ErdConstraintData {
pkTableName := getTableName(config, database.TableDetail{Schema: constraint.PkSchema, Name: constraint.PkTable})
fkTableName := getTableName(config, database.TableDetail{Schema: constraint.FkSchema, Name: constraint.FkTable})

Expand All @@ -108,10 +114,25 @@ func getConstraintData(config config.MermerdConfig, labelMap RelationshipLabelMa
constraintLabel = relationshipLabel.Label
}

isUnique := false
isNullable := true
for _, table := range tables {
if table.Table.Name == constraint.FkTable && table.Table.Schema == constraint.FkSchema {
for _, column := range table.Columns {
if column.Name == constraint.ColumnName {
isUnique = column.IsUnique
isNullable = column.IsNullable
goto double_break
}
}
}
}
double_break:

return ErdConstraintData{
PkTableName: pkTableName,
FkTableName: fkTableName,
Relation: getRelation(constraint),
Relation: getRelation(constraint, isUnique, isNullable),
ConstraintLabel: constraintLabel,
}
}
Expand Down
69 changes: 60 additions & 9 deletions diagram/diagram_util_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,26 @@ func TestGetRelation(t *testing.T) {
isPrimary bool
hasMultiplePK bool
expectedRelation ErdRelationType
isUnique bool
isNullable bool
}{
{true, true, relationManyToOne},
{false, true, relationManyToOne},
{false, false, relationManyToOne},
{true, false, relationOneToOne},
{true, true, relationManyToOne, false, false},
{false, true, relationManyToOne, false, false},
{false, false, relationManyToOne, false, false},
{true, false, relationOneToOne, false, false},

{false, false, relationOneToMaybeOne, true, true},
{false, false, relationOneToOne, true, false},
{false, false, relationManyToMaybeOne, false, true},

{true, false, relationOneToOne, true, false},
// if PK is true it should not be nullable (thought technically possible in Sqlite)

{false, true, relationOneToMaybeOne, true, true},
{false, true, relationOneToOne, true, false},
{false, true, relationManyToMaybeOne, false, true},

{true, true, relationOneToOne, true, false},
}

for index, testCase := range testCases {
Expand All @@ -33,9 +48,11 @@ func TestGetRelation(t *testing.T) {
IsPrimary: testCase.isPrimary,
HasMultiplePK: testCase.hasMultiplePK,
}
isUnique := testCase.isUnique
isNullable := testCase.isNullable

// Act
result := getRelation(constraint)
result := getRelation(constraint, isUnique, isNullable)

// Assert
assert.Equal(t, testCase.expectedRelation, result)
Expand Down Expand Up @@ -335,9 +352,10 @@ func TestGetConstraintData(t *testing.T) {
configMock.On("OmitConstraintLabels").Return(false).Once()
configMock.On("ShowSchemaPrefix").Return(false).Twice()
constraint := database.ConstraintResult{ColumnName: "Column1"}
tables := []database.TableResult{}

// Act
result := getConstraintData(&configMock, &relationshipLabelMap{}, constraint)
result := getConstraintData(&configMock, &relationshipLabelMap{}, tables, constraint)

// Assert
configMock.AssertExpectations(t)
Expand All @@ -350,9 +368,10 @@ func TestGetConstraintData(t *testing.T) {
configMock.On("ShowSchemaPrefix").Return(false).Twice()

constraint := database.ConstraintResult{ColumnName: "Column1"}
tables := []database.TableResult{}

// Act
result := getConstraintData(&configMock, &relationshipLabelMap{}, constraint)
result := getConstraintData(&configMock, &relationshipLabelMap{}, tables, constraint)

// Assert
configMock.AssertExpectations(t)
Expand All @@ -377,8 +396,24 @@ func TestGetConstraintData(t *testing.T) {
ColumnName: "Column1",
}

tables := []database.TableResult{
{
Table: database.TableDetail{
Name: "pk",
},
Columns: []database.ColumnResult{
{
Name: "Column1",
IsUnique: false,
IsNullable: false,
},
},
Constraints: database.ConstraintResultList{constraint},
},
}

// Act
result := getConstraintData(&configMock, labelsMap, constraint)
result := getConstraintData(&configMock, labelsMap, tables, constraint)

// Assert
configMock.AssertExpectations(t)
Expand All @@ -403,8 +438,24 @@ func TestGetConstraintData(t *testing.T) {
ColumnName: "Column1",
}

tables := []database.TableResult{
{
Table: database.TableDetail{
Name: "pk",
},
Columns: []database.ColumnResult{
{
Name: "Column1",
IsUnique: false,
IsNullable: false,
},
},
Constraints: database.ConstraintResultList{constraint},
},
}

// Act
result := getConstraintData(&configMock, labelsMap, constraint)
result := getConstraintData(&configMock, labelsMap, tables, constraint)

// Assert
configMock.AssertExpectations(t)
Expand Down