Skip to content

Update shared SQL database page for PostgreSQL-only live sync - #668

Open
koppor wants to merge 6 commits into
mainfrom
sqldatabase-postgres
Open

Update shared SQL database page for PostgreSQL-only live sync#668
koppor wants to merge 6 commits into
mainfrom
sqldatabase-postgres

Conversation

@koppor

@koppor koppor commented Aug 31, 2026

Copy link
Copy Markdown
Member

Updates the shared SQL database page for the sync rework in JabRef PR JabRef/jabref#11879: PostgreSQL is the only supported system, changes from other users arrive live (the manual "pull changes" action is gone), the new menu path, and the automatic table migration on first connect.

This is a low-risk documentation update — review and merge can be quick. Ideally merged together with the JabRef PR.

🤖 Generated with Claude Code

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document PostgreSQL-only shared databases and live sync

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Clarifies PostgreSQL as the only supported shared database system.
• Documents automatic legacy-table migration and the revised connection menu path.
• Replaces manual pulling guidance with PostgreSQL notification-based live synchronization.
Diagram

sequenceDiagram
  actor User
  participant Client as JabRef Client
  participant DB as PostgreSQL
  participant Peers as Peer Clients
  User->>Client: Connect shared database
  Client->>DB: Migrate legacy tables
  Client->>DB: Push local changes
  DB-->>Peers: Notify live changes
Loading
High-Level Assessment

Updating the existing shared SQL database guide is the appropriate approach because the change aligns user-facing documentation directly with the revised JabRef workflow; separate migration or synchronization pages would add unnecessary fragmentation.

Files changed (1) +7 / -3

Documentation (1) +7 / -3
README.mdAlign shared database guidance with PostgreSQL live sync +7/-3

Align shared database guidance with PostgreSQL live sync

• Documents PostgreSQL as the sole supported database, the revised connection menu path, and automatic first-connect migration while preserving legacy tables. Removes MySQL SSL guidance and replaces manual pull instructions with notification-driven live synchronization behavior.

en/collaborative-work/sqldatabase/README.md

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented Aug 31, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0) 📎 Requirement gaps (0) 🎨 UX issues (0) 🔗 Cross-repo conflicts (0) 📜 Skill insights (0)

Grey Divider


Remediation recommended

1. Migration support is overstated 🐞 Bug ≡ Correctness
Description
The new text says any database used by an older JabRef is migrated automatically and remains usable
by older clients, but the documented pre-3.6 schema is explicitly unsupported and requires a manual
export/import migration. Users with such databases may expect a safe first-connect migration that
this documentation says is unavailable.
Code

en/collaborative-work/sqldatabase/README.md[13]

+If the database was already used by an older version of JabRef, its content is migrated to the new table structure automatically when the first client connects. The old tables are kept untouched, so older JabRef versions can still be used with them.
Evidence
The dedicated migration page says pre-3.6 SQL structures are unsupported and instructs users to
install JabRef 3.5, import and save locally, then import that file into a newer shared database;
this disproves the unqualified claim that databases from older JabRef versions migrate automatically
on first connection.

en/collaborative-work/sqldatabase/README.md[13-13]
en/collaborative-work/sqldatabase/sqldatabasemigration.md[5-7]
en/collaborative-work/sqldatabase/sqldatabasemigration.md[13-24]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The automatic-migration statement applies without a version or schema boundary, contradicting the documented manual migration requirement for pre-3.6 databases.
## Issue Context
State exactly which prior JabRef versions/table layouts the new migration supports, and retain a clear exception or link for pre-3.6 databases. Reconcile the dedicated migration page if its workflow is no longer applicable.
## Fix Focus Areas
- en/collaborative-work/sqldatabase/README.md[13-13]
- en/collaborative-work/sqldatabase/sqldatabasemigration.md[5-24]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


2. Migration menu path stays stale 🐞 Bug ≡ Correctness
Description
The new menu hierarchy is updated only on the main page, while the published pre-3.6 migration
workflow still sends users to **File → Open shared database**. Users following that indexed workflow
in a current JabRef version will be directed to a command replaced by **File → Shared database →
Connect to shared database**.
Code

en/collaborative-work/sqldatabase/README.md[11]

+To use this feature you have to connect to a remote database. To do so you have to open **File** in the menu bar and then click **Shared database** and **Connect to shared database**. The **Connect to shared database** dialog will open and you will have to fill in the shared's database connection settings. Then, you have to fill out the remaining fields with the according information. If you like you can save your password by clicking the **Remember password?** checkbox.
Evidence
The repository publishes the migration page in its navigation, and that page still names **Open
shared database**, whereas this PR establishes **Shared database → Connect to shared database** as
the current path.

en/collaborative-work/sqldatabase/README.md[11-11]
en/collaborative-work/sqldatabase/sqldatabasemigration.md[20-23]
en/SUMMARY.md[43-43]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The main page documents the new nested shared-database menu, but the dedicated migration instructions retain the prior command name.
## Issue Context
Update the migration workflow to distinguish the menu path required in historical JabRef 3.6 from the path in current JabRef, or replace the stale path if the workflow is intended for current clients.
## Fix Focus Areas
- en/collaborative-work/sqldatabase/README.md[11-11]
- en/collaborative-work/sqldatabase/sqldatabasemigration.md[20-23]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Tip of the day
💡 Did you know, you can copy the agent prompt from any finding and feed it to your IDE agent

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

To use this feature you have to connect to a remote database. To do so you have to open **File** in the menu bar and then click the **Connect to shared database** item. The **Connect to shared database** dialog will open and you will have to fill in the shared's database connection settings. Then, you have to fill out the remaining fields with the according information. If you like you can save your password by clicking the **Remember password?** checkbox.
To use this feature you have to connect to a remote database. To do so you have to open **File** in the menu bar and then click **Shared database** and **Connect to shared database**. The **Connect to shared database** dialog will open and you will have to fill in the shared's database connection settings. Then, you have to fill out the remaining fields with the according information. If you like you can save your password by clicking the **Remember password?** checkbox.

If the database was already used by an older version of JabRef, its content is migrated to the new table structure automatically when the first client connects. The old tables are kept untouched, so older JabRef versions can still be used with them.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remediation recommended

1. Migration support is overstated 🐞 Bug ≡ Correctness

The new text says any database used by an older JabRef is migrated automatically and remains usable
by older clients, but the documented pre-3.6 schema is explicitly unsupported and requires a manual
export/import migration. Users with such databases may expect a safe first-connect migration that
this documentation says is unavailable.
Agent Prompt
## Issue description
The automatic-migration statement applies without a version or schema boundary, contradicting the documented manual migration requirement for pre-3.6 databases.

## Issue Context
State exactly which prior JabRef versions/table layouts the new migration supports, and retain a clear exception or link for pre-3.6 databases. Reconcile the dedicated migration page if its workflow is no longer applicable.

## Fix Focus Areas
- en/collaborative-work/sqldatabase/README.md[13-13]
- en/collaborative-work/sqldatabase/sqldatabasemigration.md[5-24]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

## Usage

To use this feature you have to connect to a remote database. To do so you have to open **File** in the menu bar and then click the **Connect to shared database** item. The **Connect to shared database** dialog will open and you will have to fill in the shared's database connection settings. Then, you have to fill out the remaining fields with the according information. If you like you can save your password by clicking the **Remember password?** checkbox.
To use this feature you have to connect to a remote database. To do so you have to open **File** in the menu bar and then click **Shared database** and **Connect to shared database**. The **Connect to shared database** dialog will open and you will have to fill in the shared's database connection settings. Then, you have to fill out the remaining fields with the according information. If you like you can save your password by clicking the **Remember password?** checkbox.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remediation recommended

2. Migration menu path stays stale 🐞 Bug ≡ Correctness

The new menu hierarchy is updated only on the main page, while the published pre-3.6 migration
workflow still sends users to **File → Open shared database**. Users following that indexed workflow
in a current JabRef version will be directed to a command replaced by **File → Shared database →
Connect to shared database**.
Agent Prompt
## Issue description
The main page documents the new nested shared-database menu, but the dedicated migration instructions retain the prior command name.

## Issue Context
Update the migration workflow to distinguish the menu path required in historical JabRef 3.6 from the path in current JabRef, or replace the stale path if the workflow is intended for current clients.

## Fix Focus Areas
- en/collaborative-work/sqldatabase/README.md[11-11]
- en/collaborative-work/sqldatabase/sqldatabasemigration.md[20-23]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant