Zepster implements Model-Driven Engineering (MDE) for data. It creates a consistent set of data-related artifacts to drive development with
- better alignment among business stakeholders and developers
- fewer bugs
- increased productivity
Zepster lets you:
- Use Entity-Relationship Modeling to describe entitites, attributes, and the relationships between entities in an Entity-Relationship Diagram (ERD)
- Convert ERDs into Entity-Relationship Markup Language (ERML) files
- Generate data-related files from the ERML, such as:
- Relational database schema
- Database catalog
- Python enum definitions
First, create an ERD for your business use case, using yEd graph editor. The yEd application is free and is available for MacOS, Linux, and Windows.
With yEd you can create a diagram that shows
- business entities
- their attributes
- how entities are related to each other
The resulting diagram is saved as a GraphML file, which is an industry-standard format for graphs.
Next, generate an Entity-Relationship Markup Language (ERML) file from the
saved GraphML diagram file. To do this, use the generml script:
Usage: generml.py [OPTIONS]
Read an Entity-Relationship diagram created by the yEd graph editor and
convert it into Entity-Relationship Markup Language
References:
yEd - https://www.yworks.com/products/yed
GraphML - http://graphml.graphdrawing.org/index.html
Options:
--input TEXT Input GraphML file (default is standard input, also
represented by a dash "-")
--output TEXT Output ERML file (default is standard output, also
represented by a dash "-")
--overwrite If specified, overwrite the output file if it already exists
--logging TEXT Set logging to the specified level: NOTSET, DEBUG, INFO,
WARNING, ERROR, CRITICAL
--help Show this message and exit.
The ERML is an intermediate language that decouples downstream tools (such as the relational database schema generator) from the specific graph editor tool (yEd). In theory, any tool that creates ERML can serve as an input source for generating downstream files.
After generating the ERML file, you can generate a number of things, described below.
Next, you can generate the schema definitions that define the tables for
a relational database, using SQL. To do this, use the genschema script:
Usage: genschema.py [OPTIONS]
Read an Entity-Relationship Markup Language file and write a database
schema SQL file
Options:
--input TEXT Input Entity-Relationship Markup Language file (default is
standard input, also represented by a dash "-")
--output TEXT Output schema definition file (default is standard output,
also represented by a dash "-")
--overwrite If specified, overwrite the output file if it already exists
--logging TEXT Set logging to the specified level: NOTSET, DEBUG, INFO,
WARNING, ERROR, CRITICAL
--dialect TEXT Set the database dialect: (currently only "crdb")
--help Show this message and exit.
You can also generate a database catalog to document the database for users.
The catalog is created using GitHub-flavored
Markdown
format. To do this, use the gencatalog script:
Usage: gencatalog.py [OPTIONS]
Read an Entity-Relationship Markup Language
file and write a data catalog output file
Options:
--input TEXT Input Entity-Relationship Markup Language file (default is
standard input, also represented by a dash "-")
--output TEXT Output catalog file (default is standard output, also
represented by a dash "-")
--overwrite If specified, overwrite the output file if it already exists
--logging TEXT Set logging to the specified level: NOTSET, DEBUG, INFO,
WARNING, ERROR, CRITICAL
--format TEXT Set the catalog format: (currently only "md")
--help Show this message and exit.
You can also generate Python enum definitions from the ERML file. This can
reduce application bugs. To do this, use the genpyenums script:
Usage: genpyenums.py [OPTIONS]
Generate Python enum declarations from an Entity-Relationship Markup
Language (ERML) file
Options:
--input TEXT Input Entity-Relationship Markup Language file (default is
standard input, also represented by a dash "-")
--output TEXT Output schema definition file (default is standard output,
also represented by a dash "-")
--overwrite If specified, overwrite the output file if it already exists
--logging TEXT Set logging to the specified level: NOTSET, DEBUG, INFO,
WARNING, ERROR, CRITICAL
--help Show this message and exit.
Copyright 2020 Cisco Systems, Inc. and its affiliates.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent