# @koikorn/adapter-mongoose

> KeystoneJS Mongoose Database adapter.

Latest version **8.1.3** (published 2020-07-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @koikorn/adapter-mongoose
pnpm add @koikorn/adapter-mongoose
yarn add @koikorn/adapter-mongoose
bun add @koikorn/adapter-mongoose
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.1.3 |
| Published | 2020-07-13 |
| First published | 2020-07-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 9 |
| Unpacked size | 60.6 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Author | The KeystoneJS Development Team |
| Maintainers | lorenhaim |

## Links

- npm: https://www.npmjs.com/package/@koikorn/adapter-mongoose
- Repository: https://github.com/keystonejs/keystone/tree/master/packages/adapter-mongoose
- npm.io page: https://npm.io/package/@koikorn/adapter-mongoose

## Dependencies (9)

- [mongoose](https://npm.io/package/mongoose.md) ^5.9.11
- [p-settle](https://npm.io/package/p-settle.md) ^3.1.0
- [pluralize](https://npm.io/package/pluralize.md) ^7.0.0
- [@koikorn/utils](https://npm.io/package/@koikorn/utils.md) ^5.4.1
- [@koikorn/logger](https://npm.io/package/@koikorn/logger.md) ^5.1.2
- [@koikorn/keystone](https://npm.io/package/@koikorn/keystone.md) ^11.0.0
- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) ^0.11.0
- [@koikorn/fields-mongoid](https://npm.io/package/@koikorn/fields-mongoid.md) ^6.0.0
- [@koikorn/mongo-join-builder](https://npm.io/package/@koikorn/mongo-join-builder.md) ^7.1.0

## Recent versions

- 8.1.3 (latest) — 2020-07-13

## README

<!--[meta]
section: api
subSection: database-adapters
title: Mongoose adapter
[meta]-->

# Mongoose database adapter

[![View changelog](https://img.shields.io/badge/changelogs.xyz-Explore%20Changelog-brightgreen)](https://changelogs.xyz/@koikorn/adapter-mongoose)

## Usage

```javascript
const { MongooseAdapter } = require('@koikorn/adapter-mongoose');

const keystone = new Keystone({
  adapter: new MongooseAdapter({...}),
});
```

## Config

### `mongoUri` (required)

This is used as the `uri` parameter for `mongoose.connect()`.

_**Default:**_ Environment variable (see below) or `'mongodb://localhost/<DATABASE_NAME>'`

If not specified, KeystoneJS will look for one of the following environment variables:

- `CONNECT_TO`
- `DATABASE_URL`
- `MONGO_URI`
- `MONGODB_URI`
- `MONGO_URL`
- `MONGODB_URL`
- `MONGOLAB_URI`
- `MONGOLAB_URL`

### Mongoose options (optional)

Additional Mongoose config options are passed directly through to `mongoose.connect()`.

_**Default:**_

```javascript
{
  useNewUrlParser: true,
  useFindAndModify: false,
  useUnifiedTopology: true,
}
```

See the [Mongoose docs](https://mongoosejs.com/docs/api.html#mongoose_Mongoose-connect) for a detailed list of options.

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