Documenting tables and views
Dataedo imports stored procedures and functions from a database you document.
What gets imported
Dataedo imports the following metadata from the documented database:
- List of tables and views stored in the documented database/schema
- List of columns with their data types and nullability
- Primary and unique keys (constraints and/or indexes)
- Relations (foreign keys)
- Table triggers with trigger event
- Scripts (for views)
- Descriptions (see below)
- Dependencies
Imported descriptions/comments
While importing schema, Dataedo reads descriptions and comments added in DBMS. You can then edit those descriptions in the Dataedo repository using Dataedo Editor. Those descriptions will not be saved to the original documented database.
Imported descriptions include:
- Tables and views description
- Columns description
- Foreign keys description
- Primary and unique keys descriptions
- Trigger descriptions
Read more about importing descriptions.
Documentation scope
When you imported your database schema, you are ready to complete documenting tables and views.
Documentation of tables and views consists of:
- Description of each table/view (rich text with images)
- Optional title of each table/view (more on titles)
- Description of each column (plain text)
- Optional title of each column
- Description of each primary and unique key
- User-defined primary and unique keys
- Description of each relation (foreign key)
- User-defined relations
- Description of each trigger
- User-defined custom fields
