Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

See the topics given below.

Table of Contents
maxLevel3
minLevel3

About custom datasources

Custom datasources allow you to interface data services with your own datasource implementation. There  There are two options for writing a custom datasource, and these two options cover most of the common business use cases as follows:

  • Custom tabular datasources: Used to represent data in tables, where a set of named tables contain data rows that can be queried later. A tabular datasource is typically associated with an SQL data services query. This is done by internally using our own SQL parser to execute SQL against the custom datasource. You can use the org.wso2.carbon.dataservices.core.custom.datasource.TabularDataBasedDS interface to implement tabular datasources. For a sample implementation of a tabular custom datasource, see org.wso2.carbon.dataservices.core.custom.datasource.InMemoryDataSource. Also, this is supported in Carbon datasources with the following datasource reader implementation: org.wso2.carbon.dataservices.core.custom.datasource.CustomTabularDataSourceReader.
  • Custom query datasources: Used when the datasource has some form of query expression support. Custom query datasources are implemented using the org.wso2.carbon.dataservices.core.custom.datasource.CustomQueryBasedDS interface. You can create any non-tabular datasource using the query-based approach. Even if the target datasource does not have a query expression format, you can create your own. For example, you can support any NoSQL type datasource this way. For a sample implementation of a query-based custom datasource, see org.wso2.carbon.dataservices.core.custom.datasource.EchoDataSource. This is supported in Carbon datasources with the following datasource reader implementation: org.wso2.carbon.dataservices.core.custom.datasource.CustomQueryDataSourceReader
Info
titleSample custom datasourceSamples

InMemoryDSSample is a sample data service (shipped with DSS by default), which contains both datasource implementations (InMemoryDataSource and EchoDataSource) explained above. See a demonstration of this sample here.

Also, you can find a sample configuration file containing the InMemoryDSSample in the <PRODUCT_HOME>\repository\conf\datasources\custom-datasources.xml file.

Adding custom datasources to data service

You can create a custom data source as you create your data service as shown below.

...