restbase-mod-table-mysql

An MySQL back-end module for RESTBase conforming to the RESTBase storage specification.

Installation

Firstly, install RESTBase. The MySQL back-end module should be pulled in automatically as a dependency. If you cannot find restbase-mod-table-mysql in RESTBase's node_modules/ directory, install it using:

npm install restbase-mod-table-mysql

Configuration

Configuration of this module takes place from within an x-modules stanza in the YAML-formatted RESTBase configuration file. While complete configuration of RESTBase is beyond the scope of this document, (see the RESTBase docs for that), this section covers the restbase-mod-table-mysql specifics.

    backend: mysql
    host: localhost
    database: restbase
    username: mysql
    password: mysql
    show_sql: false
    storage_groups:
      - name: local
        domains: /./

Host

Database host name or IP address.

    host: localhost

Database

Name of the database used by RESTBase

    database: somedatabase

Credentials

Password credentials to use in authenticating with MySQL.

    username: someuser
    password: somepass

Storage Groups

Storage groups are used to map tables to one or more hosts/domains.

    storage_groups:
      - name: default.group.local
        domains: /./