pon-task-db
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/realglobe-Inc/pon-task-db
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/pon-task-db
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/pon-task-db.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/pon-task-db
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/pon-task-db.svg?token=
[bd_license_url]: https://github.com/realglobe-Inc/pon-task-db/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/pon-task-db
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/pon-task-db.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/pon-task-db.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/pon-task-db
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/pon-task-db.svg
[bd_npm_url]: http://www.npmjs.org/package/pon-task-db
[bd_npm_shield_url]: http://img.shields.io/npm/v/pon-task-db.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

DB task set for pon

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install pon-task-db --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const pon = require('pon')
const {setup, seed, dump, migrate} = require('pon-task-db')

async function tryExample () {
  const createDB = () => {/*...*/}

  const run = pon({
    'db:setup': setup(createDB),
    'db:seed': seed(createDB, 'db/seeds/:env/*.seed.json')
  })

  run('db:seed')
}

tryExample()

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Signature.md.hbs" Start -->

<a name="section-doc-guides-03-signature-md"></a>

Signatures
---------


### `define(options) -> function`

Define task

| Param | type | Description |
| ---- | --- | ----------- |
| options | Object |  Optional settings |


### `drop(db, options) -> function`

Define task to drop database

| Param | type | Description |
| ---- | --- | ----------- |
| db | function&amp;#124;ClayLump |  DB instance or it's creator |
| options | Object |  Optional settings |
| options.unless | string |  NODE_ENV to skip |


### ``



| Param | type | Description |
| ---- | --- | ----------- |


### `exec(db, options) -> function`

Define task to exec database

| Param | type | Description |
| ---- | --- | ----------- |
| db | function&amp;#124;ClayLump |  DB instance or it's creator |
| options | Object |  Optional settings |


### `migrate(db, handlers) -> function`

Define task

| Param | type | Description |
| ---- | --- | ----------- |
| db | function&amp;#124;ClayLump |  DB instance or it's creator |
| handlers | Object |  Migration handlers |


### `refresh(db, options) -> function`

Define task to refresh database

| Param | type | Description |
| ---- | --- | ----------- |
| db | function&amp;#124;ClayLump |  DB instance or it's creator |
| options | Object |  Optional settings |


### `setup(db, options) -> function`

Define task to setup database

| Param | type | Description |
| ---- | --- | ----------- |
| db | function&amp;#124;ClayLump |  DB instance or it's creator |
| options | Object |  Optional settings |



<!-- Section from "doc/guides/03.Signature.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [Apache-2.0 License](https://github.com/realglobe-Inc/pon-task-db/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [Pon][pon_url]
+ [Realglobe, Inc.][realglobe,_inc__url]

[pon_url]: https://github.com/realglobe-Inc/pon
[realglobe,_inc__url]: http://realglobe.jp

<!-- Links End -->