5.1. Export a model

v1.2.0 Summary Chapter 5: Export, import and diff 5. Introduction 5.1. Export a model

No documentation was found matching the provided version! Browsing the latest one.

The exporting process consists in translate the database model objects into different formats. Currently, pgModeler is capable of exporting the model to PNG and SVG formats which can be useful for documentation purposes, to SQL script files that can be used in a later execution, to a data dictionary in HTML format, and directly to a database server. For this last modality, it is highly recommended that a backup of the database is made before starting the exporting process because there may be data loss in some circumstances.

Field/Option	Description
`Connection`	This combo holds the connections to be used in the export process.
`PostgreSQL`	This field specifies the PostgreSQL version in which the SQL code should be generated. It is recommended to select this option only when the version of the DBMS, somehow, is not identifiable or if you need to generate a specific version of SQL code for test purposes.
`Drop`	Causes objects to be dropped before or during the process. If `DB` is checked pgModeler will destroy the database if already exists on the server and then start the export. When `Objects` is checked pgModeler will execute the `DROP` command attached to SQL-enabled objects. This option leads to data loss so make sure to have a backup before exporting.
`Force drop`	If the current user has the proper permissions, this option causes the termination of all existing connections to the target database before dropping it. This option takes effect only on PostgreSQL 13+, thus it'll be ignored on older versions.
`Run in a transaction`	Run the generated commands in a single transaction block. In case of errors, all changes are rolled back. NOTE: This option has no effect on roles, tablespace, and database DDL commands.
`Ignore object duplicity`	This option makes pgModeler ignore errors generated by duplicated objects and creates only those that do not exist in the database. This option may be used when an object was created after a previous model export. Note that this option acts differently from the modeldatabase diff because only new objects are created on the server. If some objects were only modified in some attributes they will continue not being created or updated on the server. In that case, you'll need to use the model-database diff feature.
`Ignore error codes`	This advanced option causes pgModeler to ignore extra errors by their numeric codes. These errors must be informed in the input below and separated by space. For the complete list of error codes check the PostgreSQL docs, section Appendix A. PostgreSQL Error Codes. Use this option with extreme care since it can interfere with the final export result.

Field/Option	Description
`Mode`	`Standalone` makes pgModeler generate a single SQL file containing all the commands needed to reproduce the model in the database. `Split` causes the database objects to be split into separate SQL files, in the proper order of execution, so the database can be correctly created just by running each SQL script sequentially. The split mode be performed in three ways: `Original:` generates only the original SQL code for a single object. `Dependencies:` generates the original code including all dependencies needed to properly create a single object. `Children:` generates the original code including all children's SQL code. This option is used only for schemas, tables, and views.
`Output`	The output file or directory that will store the generated DDL commands.
`PostgreSQL`	This option is used to define the PostgreSQL version of the generated SQL file. Unlike exporting to the database server, this option is mandatory here because pgModeler doesn't know how to identify the proper version just from the database model metadata information.

Field/Option	Description
`Type`	The type of graphics being generated: PNG or SVG.
`File`	The output file which will store the graphical representation of the model.
`Zoom`	Causes pgModeler to apply a zoom factor before generating the image file. This option is useful when you need to create a high resolution PNG file by setting up a zoom factor of more than 100%.
`Show grid`	Enables the orientation grid to be included in the output graphics file.
`Show delimiters`	Enables the page delimiters to be included in the output graphics file.
`Page by page`	Exporting the model page by page will generate files with a `_p[n]` suffix where `n` is the page ID. Check if the current user has written permission over the output folder. The page dimensions and amount are directly linked to the current page settings. Refer to section Printing & Code in the previous chapter to get details about page configuration.
`Override background color`	Ignores the original canvas background color and the exported image background will be set to white so the file can be print-ready. The default behavior is to create an output image in which the background follows the canvas background color. In some cases, this behavior may not be desirable mainly if the generated image is for printing.

Field/Option	Description
`Mode`	`Standalone` makes pgModeler generate a single HTML file containing the data dictionaries of all tables in the database model. `Split` causes the data dictionaries to be generated in separate files inside the selected directory. In this mode, the files are named in the format `schema.table.html`.
`Output`	The output file or directory in which the data dictionary will be stored.
`Include index`	pgModeler will generate an index to help navigate through the data dictionary. If split mode is set then a separated file named `index.html` will be saved into the destination folder.

Once selected the export mode and configured all desired options you just need to click the Export button and wait for the progress in the Output tab. If no error was raised you can close the dialog or start a new exporting process.

5.1. Export a model

5.1.1. Export to database server

5.1.2. Export to SQL file

5.1.3. Export to PNG or SVG

5.1.4. Export to data dictionary