# mongodb-schema-finder

> MongoDB-Schema-Finder guesses the schema for each of your collections in mongoose

Latest version **0.1.0** (published 2015-05-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install mongodb-schema-finder
pnpm add mongodb-schema-finder
yarn add mongodb-schema-finder
bun add mongodb-schema-finder
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-05-14 |
| First published | 2015-05-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+9 in 1 direct dependencies) |
| Install scripts | no |
| Author | TourConnect Engineering Team |
| Maintainers | chapinkapa |
| Keywords | mongoose, schema, collections, definer, finder, helper, model, mongodb |

## Links

- npm: https://www.npmjs.com/package/mongodb-schema-finder
- Repository: git@github.com:TourConnect/MongoDB-Schema-Finder
- Homepage: http://www.tourconnect.com/
- Issues: https://github.com/TourConnect/MongoDB-Schema-Finder/issues
- npm.io page: https://npm.io/package/mongodb-schema-finder

## Dependencies (1)

- [mongoose](https://npm.io/package/mongoose.md) 3.8.25

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 0.1.0 (latest) — 2015-05-14

## README

# MongoDB-Schema-Finder

MongoDB-Schema-Finder is a Node tool that guesses what the schema is for each collection from a mongo connection.

MongoDB-Schema-Finder does this by querying a sample from each Connection from the MongoDB connection and validates the types from the sample, then it writes a json formatted document for each collection.

### Installation



```sh
$ npm install mongodb-schema-finder
```

### How to Use
```js
var CreateDocumentation = require('mongodb-schema-finder');

new CreateDocumentation({
  mongoConnectionURI: 'mongodb://[username:password@]host1[:port1]',
  limit: 100,
  documentDir: '/documentation'
});
```

### Customization

The following options are supported:
- mongoConnectionURI - your MongoDB connection string
- limit - how many documents to sample from each collection
- documentDir - where to place the found schemas. This must be writeable, and only one directory deep.

### Version
0.1.0

License
----

MIT

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