{"id":19322190,"url":"https://github.com/seddryck/ermine","last_synced_at":"2025-06-28T18:36:31.838Z","repository":{"id":76728427,"uuid":"55283219","full_name":"Seddryck/ERMine","owner":"Seddryck","description":"ERMine is a library to parse text files describing a conceptual Entity Relationship model and create an object representation of this model.","archived":false,"fork":false,"pushed_at":"2024-02-29T20:22:29.000Z","size":2923,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-14T19:35:40.552Z","etag":null,"topics":["erd","graphviz","sql"],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Seddryck.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-02T07:30:41.000Z","updated_at":"2024-09-26T11:32:20.000Z","dependencies_parsed_at":"2024-02-29T21:34:36.477Z","dependency_job_id":null,"html_url":"https://github.com/Seddryck/ERMine","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/Seddryck/ERMine","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Seddryck%2FERMine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Seddryck%2FERMine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Seddryck%2FERMine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Seddryck%2FERMine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Seddryck","download_url":"https://codeload.github.com/Seddryck/ERMine/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Seddryck%2FERMine/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262477557,"owners_count":23317508,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["erd","graphviz","sql"],"created_at":"2024-11-10T01:40:29.577Z","updated_at":"2025-06-28T18:36:31.821Z","avatar_url":"https://github.com/Seddryck.png","language":"C#","readme":"# ERMine\nERMine is a library to parse text files describing a conceptual Entity Relationship model and create an object representation of this model.\n\n[![Build status](https://ci.appveyor.com/api/projects/status/037mxfssp1fr0y4r?svg=true)](https://ci.appveyor.com/project/Seddryck/ermine) \n![Still maintained](https://img.shields.io/maintenance/yes/2018.svg)\n![nuget](https://img.shields.io/nuget/v/ERMine.svg) \n![nuget pre](https://img.shields.io/nuget/vpre/ERMine.svg)\n[![License](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](https://opensource.org/licenses/Apache-2.0)\n\n# Notation:\n## Entities\nThe name of an entity must be written between brackets:\n[ *entity_name* ]\n\n**Expl:**\n\n* ``` [Customer] ```\n* ``` [Date and Time] ```\n* ``` [Country] ```\n\n### Attributes \n\nAttributes must follow the name of the entity\n\n[[ * | PK ] | [ ~ | PPK ]] *attribute_name* [ *sql-type* ] [ ? | NULL | ?? | SPARSE] [^ | IMMUTABLE] [ # | MV ] [ % | CALC ] [{% *derived_formula* %}] [ = | DEFAULT ] [{= *default_formula* =}]\n\n**Expl:**\n\n* ``` firstName ``` attribute *firstName* exists\n* ``` firstName varchar(50) ``` attribute *firstName* is a *varchar(50)*\n* ``` email varchar(120)? ``` attribute *email* is a *varchar(120)* and is nullable\n* ``` email varchar(120)?? ``` attribute *email* is a *varchar(120)* and is sparse\n* ``` * customerNr  char(10)``` attribute *customerNr* is a *char(10)* and is part of the primary key\n* ``` lastName varchar(50)^ ``` attribute *lastName* is a *varchar(50)* and is immutable\n* ``` address varchar(250) # ``` attribute *address* is a *varchar(250)* and must support multiple values\n* ``` fullName varchar(250) {% firstName + ' ' + lastName %} ``` attribute *fullName* is derived and the formula is *firstName + ' ' + lastName*\n* ``` category char(1) {='A'=} ``` attribute *category* has a default value equal to 'A'\n\n#### Before the name of the attribute\nPrimary key is noted with a star (*). An alternative notation is \"PK\".\nPartial keys are noted with a tilt (~). An alternative notation is \"PPK\".\n#### After the name of the attribute\n\n* The sql-type of the attribute must follow the name of the attribute.\n* Nullable attributes must postfix the sql-type with an question mark (?). An alternative notation is \"NULL\".\n* Sparse attributes must postfix the sql-type with an question mark (??). An alternative notation is \"SPARSE\".\n* Immutable attributes must postfix the sql-type with a circumflex accent (^). An alternative is the notation \"IMMUTABLE\"\n* Multivalued attributes are noted with a cardinal (#). An alternative is the notation \"MV\"\n* Derivated attributes are noted with a percentage (%). An alternative is the notation \"CALC\"\n  * Formula for implementation of derivated attributes must be specified between the curly braces and percentages symbols ({% ... %})\n* An attribute with a default value is noted with a equal (=). An alternative is the notation \"DEFAULT\"\n  * Formula for implementation of default values must be specified between the curly braces and equal symbols ({= ... =})\n\n### Domains \n\n\u003c*name_of_domain*\u003e\n*first_value*\n*second_value*\n...\n*last_value*\n\nA domain is a set of valid values for one or more attributes. A domain is defined with between angle brackets (\u003c\u003e) and the list of valid values is enlisted with one value by line. If a value contains many words then it should be written between quotes. At the moment, domains can only be a list of strings.\n\n**Expl:**\n```\n\u003cWeekday\u003e\nMonday\nTuesday\nWednesday\n'Later in the week'\n```\nTo specify that an attribute is enforced by a domain you must replace the sql-type by the name of the domain. \n\n**Expl:**\n```\n[Restaurant]\n* RestaurantCode varchar(20)\nClosingDay Weekday\n```\nIn this example the ```ClosingDay``` of a ```restaurant``` is constrained to be one of the four values defined in the domain ```Weekday```. \n\n## Relationships\n\n*first_entity_name* [ ? | 1 | * | + ] - *relationship_name* - [ ? | 1 | * | + ] *second_entity_name*\n\nfor unary relationships the name of the first and second entities must be identical.\n\nTernary (or more) relationships are noted differently\n\n*relationship_name* *first_entity_name* [ ? | 1 | * | + ] *second_entity_name* [ ? | 1 | * | + ] *third_entity_name* [ ? | 1 | * | + ]\n\n### Cardinalities\n\n* ```?``` stands for 0..1\n* ```1``` stands for 1..1\n* ```*``` stands for 0..*\n* ```+``` stands for 1..n\n\n**Expl:**\n\n* ``` [Customer] +-owns-1 [Account] ``` a *customer* has one or more *accounts* and each *account* belongs to exactly one *customer*\n* ``` [City] 1-located-* [Country] ``` a *city* is located in excatly one *country* and a *country* incorporates zero or n cities\n* ```-located- [City]1 [Country]* ``` a *city* is located in excatly one *country* and a *country* incorporates zero or n cities (alternate notation)\n* ``` -deal- [Vendor]+ [Customer]+ [Location]1 ``` a deal involves many vendors and customers in a unique location.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseddryck%2Fermine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseddryck%2Fermine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseddryck%2Fermine/lists"}