Document Entities | Oracle Magazine
Learn how to install/configure Oracle SQL Developer Data Modeler In particular, entity relationship diagrams (ERDs) are a popular way to. Create a diagram for existing database schema or its subset as follows: . The process of generating Entity-Relationship diagram in Oracle SQL Developer has been described in Oracle Magazine by Jeff . As the Data Modeler tutorial states: . Entity Relationship Diagrams tell a story. An employee is assigned one department. A location can house one or more departments.
When the process is complete, a log file will be displayed with the results. Click Close to close the View Log window. The diagram will be displayed in a pane on the right side of the application window.
There are a number of options you can choose for modifying the appearance of the diagram. All of the details of the tables table name, column names, data types, and keys are displayed initially. By right-clicking on the diagram and choosing View Details, you can limit what information is displayed. Buttons at the top of the screen allow you to zoom in and out and fit the diagram to the screen.
By right-clicking on an object on the diagram and choosing Format, you can further refine the appearance of objects in the diagram changing color, font, sizing, and so on. Modifying Diagrams With a diagram of our database before us, we can modify the diagram in a number of ways.
The following actions are available to add more objects and modify the objects already displayed. Button Description Select Used to select existing objects.
Once an object is selected, it can be moved or resized. You can also right-click for additional options. New Table Used to create a new database table. New View Used to create a new database view. Split Tables Used to split a table into two separate tables.
How to generate an entity-relationship (ER) diagram using Oracle SQL Developer - Stack Overflow
Merge Tables Used to merge to separate tables into a single table. After you press the Next button, you will see a summary on how many objects were imported by their type. As you can see below, I have imported seven tables and one view. To end process of importing objects press the Finish button.
After that, you will see import log, press Close to finish the import. Customize ER diagram For now, you connected to the database and imported objects from it.
After import, objects are added to your Relational Model, and the database ER diagram will be automatically created.
How to generate database documentation with Oracle SQL Developer
If you would like to modify the appearance of the model just move objects on the pane. In my example I moved around some tables: Handling this case is a material for the next tutorial. Create smaller diagrams for large databases Data Modeler has an option called SubViews. SubViews, as the name suggests, is part of the whole model. If you imported a lot of tables and views, you might want to break your diagram into smaller, more manageable diagrams.
This is where SubViews come into play. I have added two tables to my SubView. Objects which you moved to SubView are the same instance as an object in the Relational Model so you can edit comments in both Relational Model and any SubView.
Comments in RDBMS - holds information imported from the database if you update this field you will be able to export descriptions back to your database - this is a material for another tutorial. This field has not limited length but if you exceed characters and will try to save descriptions back to the database the script will throw an error. Comments - holds descriptions which are saved only in the design file you are working with at this very moment.
Notes - are used to add additional information, and they will not be included in the exported documentation.
How to generate database documentation with Oracle SQL Developer - Oracle SQL Developer Tutorials
Export includes only one description field - by default, it is Comments field. When using Comments in RDBMS keep in mind that you should not insert text longer than characters as it will cause an error.
- Oracle SQL Developer
- 1. Introduction
- Importing Your Data Dictionary
Unfortunately the tool doesn't cant handle it properly nor tells you that you exceeded this length. Once you have added a description for a table, it is time to describe columns. To see a list of columns select Columns on the left menu. You choose columns in the middle pane on the Details tab and provide descriptions of the text fields on the right pane. Or from Overview tab. Comment as many elements as you need.
When you finish with the table close it with OK button. Note that your changes in your model file are not saved yet. After you modify table descriptions, they will be highlighted in a browser window in red.
Save the file to keep your changes, if you close Oracle SQL Developer Data Modeler without saving it, you will lose all the changes made. When you finish documenting your database, you are ready to export the documentation.
I will describe how to do it in another article. Try all types of exports to see which one suit you best. Most important options which you need to set are: Other is used to generate documentation of other models available in SQL Developer Data Modeler like Logical Model, but this is not part of this tutorial. Tables - only tables and diagrams will be included in the documentation. Table Views — only views and diagrams will be included.