DreamFactory DocumentDB Service

Table of contents

Introducing the DreamFactory DocumentDB Service

DreamFactory 2.4 introduces the DocumentDB NoSQL database service. Now you can easily connect to a local or remote DocumentDB database from your DreamFactory instance and perform operations using the same RESTful API that you already use for other NoSQL databases in DreamFactory.

DocumentDB is a native DreamFactory service and supports role-service-access, lookup usage, live API documentation, and caching. Once your DocumentDB service is configured in DreamFactory, all the configuration details are hidden from your client. They are securely stored on your DreamFactory instance database. This allows for a simple and consistent way to access your DocumentDB database via the DreamFactory REST API.

Configuring a DocumentDB service is as simple as configuring any other database service in the DreamFactory admin console. Start by logging into the admin console, head over to the ‘Services’ tab, and click on the ‘Create’ button on the left sidebar. Use the ‘Service Type’ drop down to select ‘Databases’ -> ‘Azure DocumentDB’, complete the service configuration form and save it to create your service. Here’s what the DocumentDB configuration looks like.

Screen Shot 2016-11-15 at 11.26.12 AM.png

In the ‘Info’ tab, provide basic service information - Name, Label, and Description.

Screen Shot 2016-11-15 at 11.26.23 AM.png

In the ‘Config’ tab, provide the following configuration information:

  • URL - String. Required. Your Azure DocumentDB endpoint.
  • Key - String. Required. Your Azure DocumentDB key.
  • Database - String. Required. Your Azure DocumentDB database to use for this service.

Once your DocumentDB service is configured, head over to the ‘API Docs’ tab and expand your newly created DocumentDB service to see all the available APIs ready for you to use.

Screen Shot 2016-11-15 at 11.30.21 AM.png

Screen Shot 2016-11-15 at 11.30.55 AM.png

It’s easy it is to connect to your DocumentDB database in seconds with DreamFactory’s powerful, auto-generated REST API. If you have feedback or questions, please post in the blog comments or head over to DreamFactory’s community forum to discuss!