Connecting to SQL

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsConnecting to SQL

With DreamFactory you can REST-enable and connect to any SQL database in just a few easy steps. This tutorial explains how to configure DreamFactory to make connections to various types of SQL databases.

    1. SQLite

All DreamFactory instances now come with a pre-created SQLite service named 'db' that you can use for development. To create a new SQLite service follow these steps.

  • Go to the Services tab in the admin console.
  • Click Create.
  • Set the Service Type to 'SQL DB.'
  • Enter a name and label for the service. Name will be part of the URL for accessing the service via the REST API.
  • Go to the Config tab for the new service.
  • Set the Driver to 'SQLite.'
  • Set the file name in the connection string to something unique. The entire database is stored in this file, which can be found in /storage/databases of your DreamFactory installation.
  • No credentials are required, just click Create Service to save your new service.
  • Go to the API Docs tab in the admin console to test your new service.
    1. MySQL, PostgreSQL, Oracle

Connecting to other SQL types is similar to SQLite, except for the connection string which varies depending on which db type you are targeting. Bitnami installs come with a pre-configured mySQL db that you can access without any additional setup.

  • Go to the Services tab in the admin console.
  • Click Create.
  • Set the Service Type to 'SQL DB.'
  • Enter a name and label for the service. Name will be part of the URL for accessing the service via the REST API.
  • Go to the Config tab for the new service.
  • Set the Driver to according to your desired db type.
  • An example connection string will be generated based on your Driver selection. Tailor this to suit your actual service.
  • Click Create Service to save your new service. If the proper PHP driver is not installed, an error will be displayed with information on what is missing.
  • Go to the API Docs tab in the admin console to test your new service.