Summary
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
This documentation is licensed under Creative Commons License terms.
Preface
This document is an effort to create consistent and easy-to-read documentation and intends to be the official pgModeler's guide.
Chapter 1: Main controls overview
In this chapter, the main controls of the tool will be quickly introduced so further in this documentation the most relevant ones will be fully detailed in separate chapters.
Chapter 2: Modeling basics
The main goal of this chapter is to present to the user some basic concepts adopted by pgModeler in its interface when creating database model objects.
Chapter 3: Database objects
In this chapter, all supported objects will be detailed through their respective editing forms.
Chapter 4: Handling settings
This chapter intends to describe all the configurations available and how they make pgModeler fully customizable.
Chapter 5: Export, import and diff
In this chapter, the three most important auxiliary features introduced by pgModeler will be fully detailed.
Chapter 6: Advanced tools
In this chapter, all advanced tools offered by pgModeler will be presented in detail.
Chapter 7: Modeling tips and tricks
This chapter is aimed at those who want to uncover a good set of the pgModeler's secrets that lead to good productivity.
Chapter 8: Plug-ins and UI translations
The goal of this chapter is to briefly describe how the user can take advantage of the Qt framework and pgModeler's codebase to extend its features and how the UI can be properly translated into th...
Appendix I: Schema microlanguage
One of the most important features available in pgModeler is code generation.
Appendix II: Shortcut listing
The goal of this appendix is to reunite all available shortcut keys that trigger the features available in pgModeler.
Appendix III: pgModeler's anatomy
The image below shows a little about pgModele's modular construction and how all the pieces are tied together to make the whole application as we know it.