Skip to content

Add support for formatting .pgerd ERD project file. #8912 #9299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adityatoshniwal merged 1 commit into from
Oct 29, 2025
Merged

Add support for formatting .pgerd ERD project file. #8912 #9299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/en_US/images/preferences_erd_options.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/en_US/preferences.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,12 @@ Use the fields on the *Options* panel to manage ERD preferences.
* Use *Cardinality Notation* to change the cardinality notation format
used to present relationship links.

* Use *Format ERD Project File?* if you want to format the .pgerd ERD
project file. It's a JSON file which will be formatted.

* Use *Image Download Resolution* to change the ERD image download
resolution. Higher values will use higher memory and slower rendering.

* When the *SQL With DROP Table* switch is set to *True*, the SQL
generated by the ERD Tool will add DROP table DDL before each CREATE
table DDL.
Expand Down
13 changes: 13 additions & 0 deletions web/pgadmin/tools/erd/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,19 @@ def register_preferences(self):
)
)

self.preference.register(
'options',
'format_pgerd',
gettext('Format ERD Project File?'),
'boolean',
False,
category_label=PREF_LABEL_OPTIONS,
help_str=gettext(
'If enabled, the .pgerd project file of the ERD tool will '
'be formatted before saving.'
)
)


blueprint = ERDModule(MODULE_NAME, __name__, static_url_path='/static')

Expand Down
3 changes: 2 additions & 1 deletion web/pgadmin/tools/erd/static/js/erd_tool/components/ERDTool.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,9 +677,10 @@ export default class ERDTool extends React.Component {

saveFile(fileName) {
this.setLoading(gettext('Saving...'));
const serialFile = this.diagram.serialize(this.props.pgAdmin.Browser.utils.app_version_int);
this.apiObj.post(url_for('file_manager.save_file'), {
'file_name': decodeURI(fileName),
'file_content': JSON.stringify(this.diagram.serialize(this.props.pgAdmin.Browser.utils.app_version_int)),
'file_content': JSON.stringify(serialFile, null, this.state.preferences.format_pgerd ? 4 : null),
}).then(()=>{
this.props.pgAdmin.Browser.notifier.success(gettext('Project saved successfully.'));
this.setState({
Expand Down
Loading