#2270: External DB Support #2457

DarioGii · 2024-12-15T13:20:59Z

Description

Please provide a summary of the changes, including relevant motivation and context.

Closes #(issue_number)

Checklist

I have read the Contribution Guidelines
I have performed a self-review of my own code
I have attached images of the change if it is UI based
I have commented my code, particularly in hard-to-understand areas
If my code has heavily changed functionality I have updated relevant docs on Stirling-PDFs doc repo
My changes generate no new warnings
I have read the section Add New Translation Tags (for new translation tags only)

DarioGii · 2024-12-15T13:26:40Z

src/main/java/stirling/software/SPDF/SPDFApplication.java

+        logger.info("Navigate to {}", url);
+    }
+
+    private static String[] getActiveProfile(String[] args) {


Sets the active profile(s). Will be set to default if nothing is selected

DarioGii · 2024-12-15T13:29:26Z

src/main/java/stirling/software/SPDF/config/security/database/DatabaseConfig.java

This class sets the DB configuration. All other classes will use this to connect to the DB

DarioGii · 2024-12-15T13:31:32Z

src/main/java/stirling/software/SPDF/model/ApplicationProperties.java

+        private Datasource datasource;
+    }
+
+    @Data


New Datasource class. Will pick up configuration from the settings.yml

DarioGii · 2024-12-15T13:31:49Z

src/main/java/stirling/software/SPDF/model/ApplicationProperties.java

+        private String password;
+    }
+
+    public enum Driver {


New Driver class

DarioGii · 2024-12-15T13:34:47Z

src/main/resources/settings.yml.template

@@ -85,6 +86,11 @@ system:
  customHTMLFiles: false # enable to have files placed in /customFiles/templates override the existing template HTML files
  tessdataDir: /usr/share/tessdata # path to the directory containing the Tessdata files. This setting is relevant for Windows systems. For Windows users, this path should be adjusted to point to the appropriate directory where the Tessdata files are stored.
  enableAnalytics: undefined # set to 'true' to enable analytics, set to 'false' to disable analytics; for enterprise users, this is set to true
+  datasource:


Configure the DB connection here

Frooodle · 2024-12-15T23:25:49Z

src/main/resources/application.properties

@@ -41,19 +39,21 @@ spring.mvc.async.request-timeout=${SYSTEM_CONNECTIONTIMEOUTMILLISECONDS:1200000}
 #spring.thymeleaf.prefix=file:/customFiles/templates/,classpath:/templates/
 #spring.thymeleaf.cache=false

-spring.datasource.url=jdbc:h2:file:./configs/stirling-pdf-DB-2.3.232;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE


We should support and still default to using a DB file for ease of adoption and use of users,
We should still allow H2 file connection and ensure this is the default type
But still offer it to users for postgres etc

Frooodle · 2024-12-15T23:26:34Z

src/main/resources/settings.yml.template

@@ -85,6 +86,11 @@ system:
  customHTMLFiles: false # enable to have files placed in /customFiles/templates override the existing template HTML files
  tessdataDir: /usr/share/tessdata # path to the directory containing the Tessdata files. This setting is relevant for Windows systems. For Windows users, this path should be adjusted to point to the appropriate directory where the Tessdata files are stored.
  enableAnalytics: undefined # set to 'true' to enable analytics, set to 'false' to disable analytics; for enterprise users, this is set to true
+  datasource:
+    url: jdbc:postgresql://db:5432/stirling_pdf
+    driver: postgresql


add comment stating the other driver types, example URLs etc

Frooodle · 2024-12-15T23:27:43Z

src/main/java/stirling/software/SPDF/model/ApplicationProperties.java

+        private String url;
+        private Driver driver;
+        private String username;
+        private String password;


password needs @ToString.Exclude to avoid logging

github-actions · 2024-12-20T13:58:14Z

🚀 Translation Verification Summary

🔄 Reference Branch: `pr-branch`

📃 File Check: `messages_ar_AR.properties`

Test Status: ✅ Passed
Test Status: ✅ Passed

📃 File Check: `messages_az_AZ.properties`

Test Status: ✅ Passed
Test Status: ✅ Passed

📃 File Check: `messages_bg_BG.properties`

Test Status: ✅ Passed
Test Status: ✅ Passed

📃 File Check: `messages_ca_CA.properties`

Test Status: ✅ Passed
Test Status: ✅ Passed

📃 File Check: `messages_cs_CZ.properties`

Test Status: ✅ Passed
Test Status: ✅ Passed

📃 File Check: `messages_da_DK.properties`

Test Status: ✅ Passed
Test Status: ✅ Passed

📃 File Check: `messages_de_DE.properties`

Test Status: ✅ Passed
Test Status: ✅ Passed

📃 File Check: `messages_el_GR.properties`

Test Status: ✅ Passed
Test Status: ✅ Passed

📃 File Check: `messages_en_US.properties`

Test Status: ✅ Passed
Test Status: ✅ Passed

📃 File Check: `messages_es_ES.properties`

Test Status: ✅ Passed
Test Status: ✅ Passed

✅ Overall Check Status: Success

Thanks @DarioGii for your help in keeping the translations up to date.

DarioGii requested a review from Frooodle as a code owner December 15, 2024 13:20

DarioGii linked an issue Dec 15, 2024 that may be closed by this pull request

[Feature Request]: External DB support #2270

Open

1 task

dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Dec 15, 2024

dosubot bot added the enhancement New feature or request label Dec 15, 2024

DarioGii commented Dec 15, 2024

View reviewed changes

This was referenced Dec 15, 2024

Hardening suggestions for Stirling-PDF / 2270-feature-request-external-db-support #2458

Merged

Hardening suggestions for Stirling-PDF / 2270-feature-request-external-db-support #2459

Merged

DarioGii commented Dec 15, 2024

View reviewed changes

Frooodle requested changes Dec 15, 2024

View reviewed changes

github-actions bot added Documentation Improvements or additions to documentation Translation Github labels Dec 20, 2024

DarioGii force-pushed the 2270-feature-request-external-db-support branch from d0e3ae9 to 46da009 Compare December 20, 2024 17:22

dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Dec 20, 2024

github-actions bot removed Documentation Improvements or additions to documentation Front End Issues or pull requests related to front-end development Docker Pull requests that update Docker code Translation API API-related issues or pull requests labels Dec 20, 2024

github-actions bot removed the Github label Dec 20, 2024

DarioGii added 2 commits December 22, 2024 09:02

2270: Adding postgresql

6b07439

2270: cleaning up

3584156

DarioGii force-pushed the 2270-feature-request-external-db-support branch from 46da009 to 3584156 Compare December 22, 2024 09:03

DarioGii requested review from reecebrowne and Ludy87 as code owners December 22, 2024 09:03

dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Dec 22, 2024

github-actions bot added Front End Issues or pull requests related to front-end development Docker Pull requests that update Docker code API API-related issues or pull requests labels Dec 22, 2024

DarioGii added 2 commits December 22, 2024 09:17

#2270: updating docker-compose files

3918a5e

#2270: clean up

2ec6c98

DarioGii force-pushed the 2270-feature-request-external-db-support branch from 7dad36c to 2ec6c98 Compare December 22, 2024 13:44

Merge branch 'main' into 2270-feature-request-external-db-support

ad8dd68

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#2270: External DB Support #2457

#2270: External DB Support #2457

DarioGii commented Dec 15, 2024

DarioGii Dec 15, 2024

DarioGii Dec 15, 2024 •

edited

Loading

DarioGii Dec 15, 2024 •

edited

Loading

DarioGii Dec 15, 2024

DarioGii Dec 15, 2024

Frooodle Dec 15, 2024

Frooodle Dec 15, 2024

Frooodle Dec 15, 2024

github-actions bot commented Dec 20, 2024

#2270: External DB Support #2457

Are you sure you want to change the base?

#2270: External DB Support #2457

Conversation

DarioGii commented Dec 15, 2024

Description

Checklist

DarioGii Dec 15, 2024

Choose a reason for hiding this comment

DarioGii Dec 15, 2024 • edited Loading

Choose a reason for hiding this comment

DarioGii Dec 15, 2024 • edited Loading

Choose a reason for hiding this comment

DarioGii Dec 15, 2024

Choose a reason for hiding this comment

DarioGii Dec 15, 2024

Choose a reason for hiding this comment

Frooodle Dec 15, 2024

Choose a reason for hiding this comment

Frooodle Dec 15, 2024

Choose a reason for hiding this comment

Frooodle Dec 15, 2024

Choose a reason for hiding this comment

github-actions bot commented Dec 20, 2024

🚀 Translation Verification Summary

🔄 Reference Branch: pr-branch

📃 File Check: messages_ar_AR.properties

📃 File Check: messages_az_AZ.properties

📃 File Check: messages_bg_BG.properties

📃 File Check: messages_ca_CA.properties

📃 File Check: messages_cs_CZ.properties

📃 File Check: messages_da_DK.properties

📃 File Check: messages_de_DE.properties

📃 File Check: messages_el_GR.properties

📃 File Check: messages_en_US.properties

📃 File Check: messages_es_ES.properties

✅ Overall Check Status: Success

DarioGii Dec 15, 2024 •

edited

Loading

DarioGii Dec 15, 2024 •

edited

Loading

🔄 Reference Branch: `pr-branch`

📃 File Check: `messages_ar_AR.properties`

📃 File Check: `messages_az_AZ.properties`

📃 File Check: `messages_bg_BG.properties`

📃 File Check: `messages_ca_CA.properties`

📃 File Check: `messages_cs_CZ.properties`

📃 File Check: `messages_da_DK.properties`

📃 File Check: `messages_de_DE.properties`

📃 File Check: `messages_el_GR.properties`

📃 File Check: `messages_en_US.properties`

📃 File Check: `messages_es_ES.properties`