Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Scout/Tutorial/3.7/Minicrm/Set up SQL Service
The Scout documentation has been moved to https://eclipsescout.github.io/.
This page belongs to the Minicrm Step-by-Step Tutorial. Previous step: Get example database.
We want to connect to a database. In Scout terms, the client might want to fill a table with data from the database. It calls a service on the server which provides the desired data. That service in turn has to get the data from somewhere. In this case, it sends a SQL statement to yet another service, the SQL service. This service will handle connecting to the database and the rest.
Eclipse Scout comes with support for Apache Derby out of the box. Support for PostgreSQL and Oracle is trivial to add (For more information, see: The Scout documentation has been moved to https://eclipsescout.github.io/.). Switching to other solutions like Hibernate is possible, but beyond the scope of the tutorial.
We will use Apache Derby in this tutorial. Derby is an open source relational database implemented entirely in Java and available under the Apache License.
Create a new AbstractDerbySqlService
Go to the server node and open the tree, drill down to Sql Services below Common Services and right-click on it in order to open the wizard to create a new SQL service.
Name your new service DerbySqlService and choose AbstractDerbySqlService from the combobox Super Type then click Finish.
If the Super Type AbstractDerbySqlService doesn't appear within the combobox, you need to organize your server project's plugin.xml. Switch to the Java Perspective, double-click on the server project, open the plugin.xml file, go to the Dependencies tab and add the plug-in org.eclipse.scout.rt.jdbc.derby to the Required Plug-Ins. If the Super Type still does not appear, make sure that the derby.jar is in the lib folder of the Java installation. You can get this library directly from Apache Derby.
Change default configuration settings
Adjust the settings in your DerbySqlService by editing the Jdbc Mapping Name. It should point to the folder where you unzipped the DerbyDb to. That's the example database you downloaded The Scout documentation has been moved to https://eclipsescout.github.io/..
Also make sure you have the right Jdbc Driver Name set.
Use minicrm for both username and password.
Make sure you escape backslashes if you're working on Windows.