PostgreSQL Database Modeler Docs

This online manual describes in detail all pgModeler features. If you're looking for the installation procedures there's a dedicated page with a quick step-by-step on how to compile and run the tool. Note that this documentation does not replace the official PostgreSQL docs. So if this is your first contact with PostgreSQL and also with pgModeler, we strongly recommend that you start studying the database system first so that pgModeler will be more intuitive for you.

If you have any comments, suggestions, criticisms, or fixes, feel free to send us a message so that the appropriate changes are applied to this document. Due to the extension of this manual, it was intentionally distributed digitally in order to avoid excessive and unnecessary paper usage. In the same way, please consider nature conservation before printing its pages. Our planet appreciates your attitude!

Good reading!

• Legal Notes
• Preface
• I. Overview
• Chapter 1: Main controls overview
• 1. Main window
• 1.1. Welcome view
• 1.2. Design view
• 1.2.1. Model validation
• 1.2.2. Object search
• 1.2.3. Operations history & Model objects
• 1.2.4. Layers management
• 1.2.5. Model changelog
• 1.3. Manage view
• Chapter 2: Modeling basics
• 2. Start modeling
• 2.1. Basic fields
• 2.2. Version specific fields
• 2.3. Data type field
• 2.4. Code completion widget
• 2.5. Custom SQL commands
• 2.6. Source code input fields
• Chapter 3: Database objects
• 3. Introduction
• 3.1. Database
• 3.2. Schemas
• 3.3. Tables
• 3.3.1. Columns
• 3.3.2. Constraints
• 3.4. Indexes
• 3.5. Triggers
• 3.6. Rules
• 3.7. Policies
• 3.8. Views
• 3.9. Functions
• 3.10. Relationships
• 3.11. Aggregates
• 3.12. Casts
• 3.13. Collations
• 3.14. Conversions
• 3.15. Domains
• 3.16. Event triggers
• 3.17. Extensions
• 3.18. Foreign data wrappers
• 3.19. Foreign servers
• 3.20. Foreign tables
• 3.21. Languages
• 3.22. Operators
• 3.23. Operator classes
• 3.24. Operator families
• 3.25. Permissions
• 3.26. Procedures
• 3.27. Roles
• 3.28. Sequences
• 3.29. Tablespaces
• 3.30. Tags
• 3.31. Textboxes
• 3.32. Transforms
• 3.33. User-defined types
• 3.34. User mappings
• 3.35. Generic SQL objects
• Chapter 4: Handling settings
• 4. Introduction
• 4.1. General settings
• 4.2. Appearance settings
• 4.3. Relationships settings
• 4.4. Connections settings
• 4.5. Snippets settings
• 4.6. Plug-ins settings

• Chapter 5: Export, import and diff
• 5. Introduction
• 5.1. Export a model
• 5.2. Import a database
• 5.3. Compare model and database
• Chapter 6: Advanced tools
• 6. Introduction
• 6.1. Model overview
• 6.2. Magnfier tool
• 6.3. Source code preview
• 6.4. Model fix tool
• 6.5. Model objects
• 6.6. Operations history
• 6.7. Model validation
• 6.8. Swap objects ids
• 6.9. Object search
• 6.10. Model restoration
• 6.11. SQL tool
• 6.11.1. Database explorer
• 6.11.2. SQL execution panel
• 6.11.3. Data handling
• 6.12. Objects metadata handling
• 6.13. Command line interface
• 6.14. Crash handler and bug report
• 6.15. Layers management
• 6.16. Model changelog
• Chapter 7: Modeling tips and tricks
• 7. Introduction
• 7.1. Quick actions over objects
• 7.2. New object overlay
• 7.3. Protecting objects
• 7.4. Copy, cut, duplicate and delete objects
• 7.5. Object's dependencies and references
• 7.6. Navigate through canvas area
• 7.7. Select multiple objects at once
• 7.8. Adding children to an object
• 7.9. Zooming and aligning the objects
• 7.10. Converting many-to-many relationships
• 7.11. Creating a sequence from serial type
• 7.12. Creating a serial from integer type
• 7.13. Handling relationship lines, points and labels
• 7.14. Creating dummy objects
• 7.15. Autoarrange objects over the canvas
• 7.16. Attributes pagination and collapsing
• 7.17. Compact view of the model
• 7.18. Managing relationship generated objects
• 7.19. Creating dependencies from editing forms
• 7.20. Managing objects stacking
• 7.21. Expanding and shrinking the canvas
• 7.22. Use scale factors when printing models
• Chapter 8: Plug-ins and UI translations
• 8. Introduction
• 8.1. Extending features with plug-ins
• 8.2. Available pgModeler Plus plug-ins
• 8.2.1. Quick object editing
• 8.2.2. Split database model format
• 8.2.3. Secure connection via SSH tunnel
• 8.2.4. Backup utilities
• 8.2.5. Testing query with parameters
• 8.2.6. Quick objects creation
• 8.2.7. SQL sessions handling
• 8.3. Translating the user interface
• Appendix I: Schema microlanguage
• Appendix II: Shortcut listing
• Appendix III: pgModeler's anatomy