Database diagrams
Enable the Database Tools and SQL plugin
This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in PyCharm by default. If the relevant features aren't available, make sure that you didn't disable the plugin.
Press Control+Alt+S to open the IDE settings and then select .
Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.
Database diagrams graphically show the structure of the database and relations between database objects. You can generate a diagram for a data source, a schema, or a table. To create relations between database objects, consider using primary and foreign keys.
You can save the generated diagrams in two formats: UML and PNG. The UML format is an internal format developed specifically for PyCharm. It is not supported by other products. If you want to share the created diagram, consider using PNG.
Also, you can build execution plans. An execution plan is a set of steps that were used to access data in a database. For more information about creating an execution plan, refer to Visualize a query plan.
Generate a diagram for a database object
In the Database tool window ( ) , right-click a database object and select .
View and manage diagrams
Pan and zoom
To pan and zoom the diagram, use your touchpad, scroll bars or the mouse wheel for vertical scrolling and Shift + mouse wheel for horizontal scrolling. You can also use Shift + mouse wheel for zooming.
To use the magnifier tool, keep the Alt key pressed, and hover over the desired areas of the diagram. Use the mouse wheel to extra zoom the diagram area within magnifier tool.
Enable column comments
Generate a diagram. For more information about generating a diagram, refer to Generate a diagram for a database object.
Click the Comments button (
).
Apply colors to diagram objects
In the Database tool window ( ) , right-click an object and select .
Select a color and click OK. Refresh the diagram to apply the color by clicking the Refresh button ().
Save diagrams
Save diagrams in the UML format
This UML format is an internal format supported only by PyCharm.
Right-click a diagram and navigate to .
To open the saved diagram, drag the UML file to the editor.
Save diagrams in the PNG format
Right-click a diagram and select .
Reference
Icons
Possible icon combinations for columns in diagrams:
Icon | Foreign key | Primary key | Indexed | NOT NULL |
|---|---|---|---|---|
| ||||
|
| |||
|
| |||
|
| |||
|
| |||
|
|
| ||
|
|
|
|
|
|
|
|
| |
|
|
|
| |
|
|
| ||
|
|
|
| |
|
|
| ||
|
|
| ||
|
|
|
| |
|
|
| ||
|
|
|
