https://github.com/Txiaozhe/egg-cockroach

CockroachDB 的 eggjs 插件。
https://github.com/Txiaozhe/egg-cockroach

cockroachdb egg-plugin eggjs javascript plugin

Last synced: 3 months ago
JSON representation

CockroachDB 的 eggjs 插件。

• Host: GitHub
• URL: https://github.com/Txiaozhe/egg-cockroach
• Owner: Txiaozhe
• License: mit
• Created: 2017-08-22T00:39:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-18T11:46:05.000Z (about 6 years ago)
• Last Synced: 2024-07-24T06:44:33.815Z (6 months ago)
• Topics: cockroachdb, egg-plugin, eggjs, javascript, plugin
• Language: JavaScript
• Size: 69.3 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-egg - egg-cockroach - CockroachDB 的 eggjs 插件 (Plugins)

README

        
# egg-cockroach

[![NPM version][npm-image]][npm-url]

[![build status][travis-image]][travis-url]

[![Test coverage][codecov-image]][codecov-url]

[![David deps][david-image]][david-url]

[![Known Vulnerabilities][snyk-image]][snyk-url]

[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-cockroach.svg?style=flat-square

[npm-url]: https://npmjs.org/package/egg-cockroach

[travis-image]: https://img.shields.io/travis/eggjs/egg-cockroach.svg?style=flat-square

[travis-url]: https://travis-ci.org/eggjs/egg-cockroach

[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-cockroach.svg?style=flat-square

[codecov-url]: https://codecov.io/github/eggjs/egg-cockroach?branch=master

[david-image]: https://img.shields.io/david/eggjs/egg-cockroach.svg?style=flat-square

[david-url]: https://david-dm.org/eggjs/egg-cockroach

[snyk-image]: https://snyk.io/test/npm/egg-cockroach/badge.svg?style=flat-square

[snyk-url]: https://snyk.io/test/npm/egg-cockroach

[download-image]: https://img.shields.io/npm/dm/egg-cockroach.svg?style=flat-square

[download-url]: https://npmjs.org/package/egg-cockroach

* A cockroachdb plugin of eggjs.

* [GitHub](https://github.com/Txiaozhe/egg-cockroach)

## Direction

### egg version

| egg-cockroach | egg 2.x |

| ------------- | ------- |

| 2.x           | 😁      |

## Get

```shell

$ npm install egg-cockroach --save

```

## Open Plugin

```js

// config/plugin.js

exports.cockroach = {

  enable: true,

  package: 'egg-cockroach',

};

```

## Config

```javascript

exports.cockroach = {

  client: {

    user: 'root',

    host: '127.0.0.1',

    database: 'user',

    port: 26257,

  },

  app: true,

  agent: false,

};

```

## Using

```javascript

// controller/home.js

// it is can only execute SQL  Statements now.

class HomeController extends Controller {

  async index() {

    const [err, conn, done] = await this.app.cockroach;

    if(err) {

      console.log(err);

    } else {

      const time = await conn.query('select now() as currentTime;');

      console.log(time.rows[0].currenttime);

      const res = await conn.query('SELECT * FROM accounts;');

      console.log(res);

      await done();

    }

    this.ctx.body = 'hi, egg';

  }

}

```

## Q & A

[egg-cockroach issues](https://github.com/Txiaozhe/egg-cockroach/issues)

## License

[MIT](LICENSE)