Skip to main content

Connecting WSO2 API Manager with different databases

With WSO2 API Manager GA 1.0.0 release,we have tested it with H2 ,My SQL and Oracle databases.The default database used by API Manager is embedded H2 database.
But in-case if you want to change the database to either other database,following steps have to be followed.

With Carbon 4.0.0 release,it's introduced an unified place to store  all the database data sources related configurations called master-datasources.xml which can be found from {API_Manager_Home}/repository/conf/datasources directory.

Open the 'master-datasources.xml' file and you'll notice there are already defined three datasources as; 

  • WSO2_CARBON_DB-The datasource used for registry and user manager
  • WSO2AM_STATS_DB-The datasource used for getting statistics to API Manager
  • WSO2AM_DB-The datasource used for API Manager database

If you are going to;
  1. Change the database for API Manager 
  • First create a database and run the relevant script which can be found from here,to generate database tables.You can find same scripts under the below location of your extracted APIManager pack.
         {API_Manager_Home}/dbscripts/apimgt
  • Navigate to 'WSO2AM_DB' section of master-datasources.xml file and edit url,username,password and driverClassName accordingly.
  • You can ignore 'validationQuery' entry by removing,if you don't need to validate each query running from the created data-source as it'll effect performance.
  • Remarks:
          If you are going to point 'WSO2AM_DB'  in master-datasources.xml to a mysql database,you  
          need to add its jdbc url configuration as below.         
           
         <url>jdbc:mysql://localhost:3306/APIMANAGERDB?
   
         Note that, you must specify ?autoReconnect=true&relaxAutoCommit=true in the jdbc url.
  • Download the related driver and copy it to {API_Manager_Home}/repository/components/lib folder.
  • Start the server with the parameter -Dsetup as below;
          ./wso2server.sh -Dsetup [or wso2server.bat -Dsetup]
     
    2.  Additionally if you want to change the JNDI lookup datasource name of the datasource used for 
         API Manager
  • Change the entry  <name> under <jndiConfig>  section for the API Manager database in master-datasources.xml file.
  • Then open api-manager.xml and change the  <DataSourceName>  under root entry  <APIManager> as similar value to the above edited jndiConfig name value of master-datasources.xml file.

Comments

Post a Comment

Popular posts from this blog

Passing end-user details from client to real backend endpoint via JWT token

In real-world business system,WSO2 API Manager useful on exposing company APIs, in a secured and controlled manner with the features provided by APIManager as; OAuth support [To secure API invocations] Throttling support [To control API invocations] Monitoring support [To track API usage] More technically what happening is when a user sends a particular API request,it will goes to WSO2 APIManager node and from there,the request will route to the real implemented back-end endpoint of the particular API and get back the response and returned it to the API invoked user. There can be a use-case,that this back-end endpoint may expect the details of API invoked user as to pass those details to some internal company usage  as; Additional authentication/authorization Track usage data from an internal system. So how to support above requirement from WSO2 AM. There comes the use of JSON Web Token[JWT] implementation done inside WSO2 AM. JWT is a means of representing claims to...
7 comments
Read more

How to rollback/commit processing messages from WSO2 ESB when enabled JMS transaction

This blog post describes the below use-case where WSO2 ESB 4.6.0 act as the intermediate channel in-between two JMS queues. The Use-case First messages will be de-queue to a proxy service deployed in WSO2 ESB from an queue in ActiveMQ message broker. Then inside ESB,the incoming messages will undergo with some message mediation flow and then the message will be send to another JMS queue deployed in JBoss server. Inside the ESB,following failures could be happen;            a) Failures during message mediation process failure inside ESB [for example if you                use   dbreportmediator/lookup mediator inside mediation flow,some times failures can                happen due  to database connection failures]          b) Message sending failure,due to endpoint is unavailability.[For example,the JBoss  ...
4 comments
Read more

TPP Journey through WSO2 Open Banking

Introduction 2018 is all set to be a game-changing year for European banking. The Revised Payment Services Directive (PSD2) has opened the door to new third party providers [TPPs] to connect with banks and manage finances of bank customers on behalf of them. The PSD2 regulation has mandated banks to expose their core-banking account data and payment services to authorized TPPs to consume. Thus as a bank it’s essential to have a solution which will securely expose their internal banking services to third party providers in a trusted manner. WSO2 Open Banking solution provides all required components to expose bank APIs in a well secured manner in order to become PSD2 compliant. This article explains about the importance of the TPP role in PSD2 domain, the requirements set that banks need to provide for TPPs by PSD2 regulations and how WSO2 Open Banking solution supports these requirements.  From my last blog ,I have given an introduction for PSD2 and WSO2 Open Banking soluti...
4 comments
Read more