# mongodb-client

**Repository Path**: mirrors_node-modules/mongodb-client

## Basic Information

- **Project Name**: mongodb-client
- **Description**: A nice API client for MongoDB.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-08-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

mongodb-client
=======

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/mongodb-client.svg?style=flat-square
[npm-url]: https://npmjs.org/package/mongodb-client
[travis-image]: https://img.shields.io/travis/node-modules/mongodb-client.svg?style=flat-square
[travis-url]: https://travis-ci.org/node-modules/mongodb-client
[codecov-image]: https://codecov.io/github/node-modules/mongodb-client/coverage.svg?branch=master
[codecov-url]: https://codecov.io/github/node-modules/mongodb-client?branch=master
[david-image]: https://img.shields.io/david/node-modules/mongodb-client.svg?style=flat-square
[david-url]: https://david-dm.org/node-modules/mongodb-client
[download-image]: https://img.shields.io/npm/dm/mongodb-client.svg?style=flat-square
[download-url]: https://npmjs.org/package/mongodb-client

A nice API client for MongoDB.

## Features

- Make API as same as [MongoDB CRUD Reference](https://docs.mongodb.org/manual/reference/crud/)
- Reading the source codes just like reading the document of MongoDB client.
- Fix native mongodb `insertedIds` data format error on `options.ordered = false`.
- Remove `insert()` method, please use the more clear `insertMany()` and `insertOne()` instead.
- Disable `options.forceServerObjectId` on write methods.
- ...

## Installation

```bash
$ npm install mongodb-client
```

## Quick start

```js
const co = require('co');
const MongoDB = require('mongodb-client');

const db = new MongoDB('mongodb://localhost:27017/myproject');
// listen db connect error event
db.on('error', err => {
  console.error(err);
});
// wait for db connected
db.ready(() => {
  // let's read and write
  co(function*() {
    const result = yield db.collection('user').insertMany([
      { name: 'fengmk2', type: 'JavaScript' },
      { name: 'dead-horse', type: 'JavaScript' },
      { name: 'tj', type: 'go' },
    ]);
    console.log(result);

    const docs = yield db.collection('user').find({ type: 'JavaScript' }).skip(10).toArray();
    console.log(docs);
  }).catch(err => {
    console.error(err);
    console.error(err.stack);
  });
});
```

## License

[MIT](LICENSE)

---

# APIs

## CURD

### Insert Documents

TBD

### Modify Documents

TBD

### Query Documents

TBD

### Remove Documents

## Indexes

TBD

## Aggregation

TBD

## Administration

TBD