Section | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
...
- Stop the Standalone Database Connector
Navigate to the <db-home>\database-connector-2.5.x\config directory.
Create the file <frevvo-home>\config\configuration.xml.
Copy/Paste the following text into configuration.xml. This skeleton defines test querysets named myStore and BIRT to get you started.
Code Block <dbconnector> <queryset name="myStore"> </queryset> <queryset name="BIRT"> </queryset> </dbconnector>
Edit <db-home>\database-connector-2.5.x\config\configuration.xml. The dbconnector.properties file is where you can customize database connection properties (such as server port) and configure datasource definitions.
Copy/Paste one of the two following samples under the server.port property.
Code Block title Use this sample if all querysets use the same database # Customize the DbConnector here logging.file=./logs/database-connector.%d{yyyy-MM-dd}.log server.port=8081 dbconnector.queryset.resource-def.url=<the url to your database> dbconnector.queryset.resource-def.user=<your database username> dbconnector.queryset.resource-def.password=<your database password>
The @myStore and @BIRT in the this sample will be your queryset names in your configuration.xml
Code Block title Use this sample if querysets use different databases # Customize the DbConnector here logging.file=./logs/database-connector.%d{yyyy-MM-dd}.log server.port=8081 dbconnector.queryset@myStore.resource-def.url=<the url to your database #1> dbconnector.queryset@myStore.resource-def.user=<your database username> dbconnector.queryset@myStore.resource-def.password=<your database password> dbconnector.queryset@BIRT.resource-def.url=<the url to your database #2> dbconnector.queryset@BIRT.resource-def.user=<your database username> dbconnector.queryset@BIRT.resource-def.password=<your database password>
Tip You can see more examples of datasource definitions here
Restart the connector using one of these methods:
- Method 1: Using java in a command window
- Navigate to <db-home>\database-connector-2.5.x .Type java -jar database.war
- Method 2: for Windows OS
Double click the <db-home>\database-connector-2.5.x\Install-Service.bat file to install the connector as a Windows service. Click the Startthe Start-DBConnector-Service.bat file to start it
Expand title Click to see standalone bundle content details Excerpt The Standalone Database Connector bundle includes the files shown in the image:
Note the files in the database-connector-2.5.x directory that are used to manage the Database Connector as services on *nix and Windows operating systems: These files should be run as an administrator.
Install-Service.bat - installs the Database Connector on a Windows system as a service named frevvo Database Connector.
Uninstall-service.bat - uninstalls the frevvo Database Connector on a Windows operating system
Start-DB Connector-Service.bat - starts the frevvo Database Connector on a Windows operating system
Start-DBConnector.sh - starts the frevvo Database Connector as a *nix console instance.
Restart-DBConnector-Service.bat - restarts the frevvo Database Connector on a Windows operating system
Restart-DBConnector.sh - restarts the frevvo Database Connector as a *nix console instance.
Stop-DBConnector-Service.bat - stops the frevvo Database Connector on a Windows operating system.
Stop-DbConnector.sh - stops the frevvo Database Connector *nix console instance.
- Method 3 for *nix OS
- Execute the DB Connector.sh shell script for Unix/Linux operating systems.
- Method 4 for Linux
- The Database Connector can also run as a service under Linux systemd
- The Database Connector can also run as a service under Linux systemd
Expand title Click here for the details It is possible to manage the Database Connector using systemd ‘service’ scripts.
- Copy the sample service file located in /bin/dbconnector.service to /etc/systemd/system
- Review it's contents and
- Make sure it is executable.
You can now use systemd to manage the dbconnector service:
systemctl start dbconnector.service
systemctl stop dbconnector.service
systemctl restart dbconnector.service
systemctl status dbconnector.service
To flag the service to start automatically on system boot use the following command:
Code Block systemctl enable dbconnector.service
Consult the service unit configuration man page for more details.
- Method 1: Using java in a command window
Browse http://localhost:8081/database/status
Verify that query validation page is loaded with status Passed and is pointing to your custom configuration.xml file.
- You are now ready to define your SQL Queries.
...
If you prefer to define your datasources on the container level, the recommended approach is to define the datasource in the container and then use a resource-ref in the Database Connector properties file to reference it..
Info |
---|
Using <Resource-ref> to define datasources is not supported if you are running the Database Connector in Standalone mode. Use <Resource-def> instead. |
...
Add the enabled= attribute with a value of false to the <querySet/> or individual <query> elements in the configuration.xml file to completely disable it.
Code Block <dbconnector> <querySet name="BIRT" enabled="false" ...>
The same can be done by adding the enabled property with a value of false as shown below to the dbconnector.properties(standalone bundle) or frevvo-config.properties (tomcat bundle).
Code Block dbconnector.querySet@<queryset name>.enabled=false
This property disables all querysets. Add it to the dbconnector.properties(standalone bundle) or frevvo-config.properties (tomcat bundle).
Code Block dbconnector.querySet.enabled=false
...