# restbase-mod-table-mysql

**Repository Path**: mirrors_wikimedia/restbase-mod-table-mysql

## Basic Information

- **Project Name**: restbase-mod-table-mysql
- **Description**: MySQL back-end for RESTBase storage
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-07-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# restbase-mod-table-mysql [![Build Status](https://travis-ci.org/wikimedia/restbase-mod-table-mysql.svg?branch=master)](https://travis-ci.org/wikimedia/restbase-mod-table-mysql)

An MySQL back-end module for [RESTBase](https://github.com/wikimedia/restbase)
conforming to the [RESTBase storage
specification](https://github.com/wikimedia/restbase-mod-table-spec).

## 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](https://github.com/wikimedia/restbase/blob/master/config.example.yaml).
While complete configuration of RESTBase is beyond the scope of this document, (see the
[RESTBase docs](https://github.com/wikimedia/restbase) for that), this section covers the
[restbase-mod-table-mysql](https://github.com/wikimedia/restbase-mod-table-mysql) specifics.

```yaml
    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.

```yaml
    host: localhost
```

### Database
Name of the database used by RESTBase

```yaml
    database: somedatabase
```

### Credentials
Password credentials to use in authenticating with MySQL.

```yaml
    username: someuser
    password: somepass
```

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

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