# egg-oracledb

> Oracle database plugin for egg

Latest version **3.0.1** (published 2018-12-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-oracledb
pnpm add egg-oracledb
yarn add egg-oracledb
bun add egg-oracledb
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2018-12-27 |
| First published | 2018-12-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 3 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 23 |
| Author | liangyuchao |
| Maintainers | zhuxm |
| Keywords | egg, eggPlugin, egg-plugin, oracledb, database |

## Links

- npm: https://www.npmjs.com/package/egg-oracledb
- Repository: https://github.com/cuyl/egg-oracle
- Homepage: https://github.com/cuyl/egg-oracle#readme
- Issues: https://github.com/cuyl/egg-oracle/issues
- npm.io page: https://npm.io/package/egg-oracledb

## Dependencies (3)

- [aes-js](https://npm.io/package/aes-js.md) ^3.1.2
- [oracledb](https://npm.io/package/oracledb.md) ^3.0.0
- [@types/oracledb](https://npm.io/package/@types/oracledb.md) ^1.11.34

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 3.0.1 (latest) — 2018-12-27
- 3.0.0 — 2018-12-27

## README

# egg-oracle

[![NPM version][npm-image]][npm-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-oracle.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-oracle
[david-image]: https://img.shields.io/david/cuyl/egg-oracle.svg?style=flat-square
[david-url]: https://david-dm.org/cuyl/egg-oracle
[snyk-image]: https://snyk.io/test/npm/egg-oracle/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-oracle
[download-image]: https://img.shields.io/npm/dm/egg-oracle.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-oracle

## Install

See [Quick Start Node-oracledb Installation](https://github.com/oracle/node-oracledb/blob/master/INSTALL.md#quickstart).


```bash
$ npm i egg-oracle --save
```

## Usage

* enable plugin

```js
// {app_root}/config/plugin.js
exports.oracle = {
  enable: true,
  package: 'egg-oracle',
};
```
* oracle connection pool attach in app

```js
// {app_root}/app/service/my_service.js
'use strict';
const Service = require('egg').Service;

class MyService extends Service {
  // example for getConnection
  async foo() {
    const connection = await this.app.oracle.getConnection();
    const result = await connnection.execute('SELECT sysdate AS "date" FROM dual');
    connection.close();
    console.log(result.rows[0].date);
  }
  // deprecated!!
  async foo2() {
    const result = await this.app.oracle.execute('SELECT sysdate AS "date" FROM dual');
    connection.close();
    console.log(result.rows[0].date);
  }
}
module.exports = MyService;

```

## <a name="doc"></a> Documentation

See [Documentation for the Oracle Database Node.js Add-on](https://github.com/oracle/node-oracledb/blob/master/doc/api.md).

## Configuration

```js
// {app_root}/config/config.default.js
exports.oracle = {
  client: {
    user: 'user',
    password: 'password',
    connectString: 'localhost/orcl',
  },
};
```

see [config/config.default.js](config/config.default.js) for more detail.

## Example

<!-- example here -->

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/egg-oracledb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
