https://github.com/lemonde/knex-schema

Bookshelf sync utility.
https://github.com/lemonde/knex-schema

Last synced: 4 months ago
JSON representation

Bookshelf sync utility.

• Host: GitHub
• URL: https://github.com/lemonde/knex-schema
• Owner: lemonde
• License: mit
• Archived: true
• Created: 2014-04-23T09:04:27.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-11-04T09:24:00.000Z (about 8 years ago)
• Last Synced: 2024-08-15T19:06:51.233Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 27.3 KB
• Stars: 7
• Watchers: 51
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# knex-schema

[![Build Status][status]](https://travis-ci.org/lemonde/knex-schema)

[![Dependency Status][deps]](https://david-dm.org/lemonde/knex-schema)

[![devDependency Status][devdeps]](https://david-dm.org/lemonde/knex-schema#info=devDependencies)

[![Coverage Status][coverage]](https://coveralls.io/r/lemonde/knex-schema)

[status]: https://travis-ci.org/lemonde/knex-schema.svg?branch=master

[deps]: https://david-dm.org/lemonde/knex-schema.svg?theme=shields.io

[devdeps]: https://david-dm.org/lemonde/knex-schema/dev-status.svg?theme=shields.io

[coverage]: https://img.shields.io/coveralls/lemonde/knex-schema.svg

Knex sync utility.

## Install

```

npm install knex-schema

```

## Usage

```js

var database = require('knex').initialize({ client: 'pg' });

var Manager = require('knex-schema');

var manager = new Manager(database);

var articles = {

  tableName: 'articles',

  build: function (table) {

    table.increments('id').primary();

    table.string('title');

  },

  populate: function (database) {

    return db.knex('articles').insert([

      { title: 'First article' }

    ]);

  }

};

manager.sync([articles]); // Create / Update tables articles.

manager.populate([articles]); // Populate table articles.

manager.reset([articles]); // Remove all data from articles.

manager.drop([articles]); // Drop table articles.

```

### knexSchema(database)

Create a new manager.

```js

var manager = require('knex-schema')(database);

```

### manager.sync(schemas)

Create and update tables specified in schemas.

```js

manager.sync([articles]);

```

### manager.populate(schemas)

Populate tables specified in schemas.

```js

manager.populate([articles]);

```

### manager.reset(schemas)

Remove all rows in tables specified in schemas.

```js

manager.reset([articles]);

```

### manager.drop(schemas)

Drop tables specified in schemas.

```js

manager.drop([articles]);

```

## License

MIT