Summary
This is the manual of pgModeler, the PostgreSQL database modeler. It describes every feature of the tool. Note that it does not replace the official PostgreSQL documentation: knowing PostgreSQL makes pgModeler more intuitive.
Where do you want to start?
- I am new to pgModeler. Read Getting started: the main concepts, a first model step by step and the shortcuts worth learning first. Installing from source? See Installation.
- I already have a PostgreSQL database. (Plus) Import it and pgModeler builds the model for you.
- My database is in another system (MySQL, SQLite, SQL Server, Oracle...). See Migrating from other tools.
- I want to keep a model and a database in sync. (Plus) Use the model and database comparison, which generates the SQL of the differences.
- I want to automate tasks. The command-line interface exports, imports, compares and fixes models without the graphical interface.
- I am looking for a specific object or field. Use the search box at the top, or go to Database objects.
If you have comments, suggestions or fixes for this manual, feel free to send us a message so the appropriate changes are applied.
The whole manual
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 guide to pgModeler.
Installation
A quick step-by-step on how to build, install and run pgModeler 2.x from source on all supported platforms.
Getting started
New to pgModeler? Start here: the main concepts, a first model step by step, and the shortcuts you will use every day.
Chapter 1: Main controls overview
In this chapter, the main controls of the tool will be quickly introduced, so that, later in this documentation, the most relevant ones can 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
This chapter will present all advanced tools offered by pgModeler in detail.
Chapter 7: Advanced tips and tricks
This chapter is aimed at those who want to uncover a good set of 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 the user's language.
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 group all available shortcut keys that trigger the features available in pgModeler.
Appendix III: pgModeler's anatomy
The image below shows a little about pgModeler's modular construction and how all the pieces are tied together to make the whole application as we know it.
Appendix IV: FAQ and troubleshooting
Short answers to the questions that come up most when using pgModeler: editions, modeling, validation, export, import and recovery.
Appendix V: Glossary
The meaning of the terms used in this manual: the ones of pgModeler and the ones of PostgreSQL and data modeling.