Juttle MySQL Adapter

MySQL adapter for the Juttle data flow language, with read & write support.

Examples

Read rows from your logs SQL table where the log level is info, with the default limit of 10000:

read mysql -table 'logs' level = 'info'

Perform an equivalent query using the raw option:

read mysql -raw 'select * from "logs" where "level" = "info" limit 10000'

Add a debug option to return the final SQL query instead (before any pagination):

read mysql -table 'logs' -debug true level = 'info'

will output: {query: 'select * from "logs" where "level" = 'info' limit 10000'}.

If you have time series data in your table, indicate the column with the timestamp using the timeField option to paginate and sort data correctly:

read mysql -timeField 'create_time' -table 'logs';
read mysql -timeField 'create_time' -table 'logs -from :2 days ago: -to :1 hour ago:;

The content of the column indicated by timeField will appear as the time field in resulting points.

Installation

Like Juttle itself, the adapter is installed as a npm package. Both Juttle and the adapter need to be installed side-by-side:

$ npm install juttle
$ npm install juttle-mysql-adapter

Configuration

The adapter needs to be registered and configured so that it can be used from within Juttle. To do so, add credentials like the following to your ~/.juttle/config.json file:

{
    "adapters": {
        "mysql": {
            "user": "root",
            "password": "password",
            "host": "localhost",
            "db": "test"
        }
    }
}

More documentation on the connection object can be found in the knex.js documentation

Usage

Read options

Name | Type | Required | Description -----|------|----------|------------- table | string | yes | table to query raw | string | no | send a raw SQL query to MySQL debug | boolean | no | output a query corresponding to current set of options and filters timeField | string | no | assume datetime column, to and from options will use this to limit rows by time fetchSize | integer | no | row limit, defaults to 10000 records from | moment | no | select points after this time (inclusive) to | moment | no | select points before this time (exclusive) db | string | no | select the database name to use in your instance id | string | no | select the config instance to use

Write options

Name | Type | Required | Description -----|------|----------|------------- table | string | yes | table to write points into db | string | no | select the database name to use in your instance id | string | no | select the config instance to use

Contributing

Contributions are welcome! Please file an issue or open a pull request.

To check code style and run unit tests:

npm test

Both are run automatically by Travis.