mongoose/docs/schematypes.html at refactor-8554 · JavaScriptBach/mongoose

History

539 lines (480 loc) · 42.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"><title>Mongoose v5.6.0: SchemaTypes</title><link rel="apple-touch-icon" sizes="57x57" href="images/favicon/apple-icon-57x57.png"><link rel="apple-touch-icon" sizes="60x60" href="images/favicon/apple-icon-60x60.png"><link rel="apple-touch-icon" sizes="72x72" href="images/favicon/apple-icon-72x72.png"><link rel="apple-touch-icon" sizes="76x76" href="images/favicon/apple-icon-76x76.png"><link rel="apple-touch-icon" sizes="114x114" href="images/favicon/apple-icon-114x114.png"><link rel="apple-touch-icon" sizes="120x120" href="images/favicon/apple-icon-120x120.png"><link rel="apple-touch-icon" sizes="144x144" href="images/favicon/apple-icon-144x144.png"><link rel="apple-touch-icon" sizes="152x152" href="images/favicon/apple-icon-152x152.png"><link rel="apple-touch-icon" sizes="180x180" href="images/favicon/apple-icon-180x180.png"><link rel="icon" type="image/png" sizes="192x192" href="images/favicon/android-icon-192x192.png"><link rel="icon" type="image/png" sizes="32x32" href="images/favicon/favicon-32x32.png"><link rel="icon" type="image/png" sizes="96x96" href="images/favicon/favicon-96x96.png"><link rel="icon" type="image/png" sizes="16x16" href="images/favicon/favicon-16x16.png"><link rel="stylesheet" href="https://unpkg.com/[email protected]/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous"><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans"><link rel="stylesheet" href="/docs/css/github.css"><link rel="stylesheet" href="/docs/css/mongoose5.css"><link rel="apple-touch-icon" sizes="57x57" href="images/favicon/apple-icon-57x57.png"><link rel="apple-touch-icon" sizes="60x60" href="images/favicon/apple-icon-60x60.png"><link rel="apple-touch-icon" sizes="72x72" href="images/favicon/apple-icon-72x72.png"><link rel="apple-touch-icon" sizes="76x76" href="images/favicon/apple-icon-76x76.png"><link rel="apple-touch-icon" sizes="114x114" href="images/favicon/apple-icon-114x114.png"><link rel="apple-touch-icon" sizes="120x120" href="images/favicon/apple-icon-120x120.png"><link rel="apple-touch-icon" sizes="144x144" href="images/favicon/apple-icon-144x144.png"><link rel="apple-touch-icon" sizes="152x152" href="images/favicon/apple-icon-152x152.png"><link rel="apple-touch-icon" sizes="180x180" href="images/favicon/apple-icon-180x180.png"><link rel="icon" type="image/png" sizes="192x192" href="images/favicon/android-icon-192x192.png"><link rel="icon" type="image/png" sizes="32x32" href="images/favicon/favicon-32x32.png"><link rel="icon" type="image/png" sizes="96x96" href="images/favicon/favicon-96x96.png"><link rel="icon" type="image/png" sizes="16x16" href="images/favicon/favicon-16x16.png"><link rel="manifest" href="images/favicon/manifest.json"><meta name="msapplication-TileColor" content="#ffffff"><meta name="msapplication-TileImage" content="images/favicon/ms-icon-144x144.png"><meta name="theme-color" content="#ffffff"><link rel="stylesheet" href="/docs/css/inlinecpc.css"><script type="text/javascript" src="/docs/js/native.js"></script></head><body><div id="layout"><div id="mobile-menu"><a class="menu-link" id="menuLink" href="#menu"></a><div id="mobile-logo-container"><a href="/"><img id="logo" src="/docs/images/mongoose5_62x30_transparent.png">mongoose</a></div></div><div id="menu"><div class="pure-menu"><div class="pure-menu-heading" id="logo-container"><a href="/"><img id="logo" src="/docs/images/mongoose5_62x30_transparent.png">mongoose</a></div><ul class="pure-menu-list" id="navbar"><li class="pure-menu-horizontal pure-menu-item pure-menu-has-children pure-menu-allow-hover version"><a class="pure-menu-link" href="#">Version 5.6.0</a><ul class="pure-menu-children"><li class="pure-menu-item"><a class="pure-menu-link" href="/docs/4.x">Version 4.13.18</a></li><li class="pure-menu-item"><a class="pure-menu-link" href="/docs/3.8.x">Version 3.8.40</a></li></ul></li><li class="pure-menu-item search"><input id="search-input-nav" type="text" placeholder="Search"><button id="search-button-nav"><img src="/docs/images/search.svg"></button></li><li class="pure-menu-item"><a class="pure-menu-link" href="/docs/index.html">Quick Start</a></li><li class="pure-menu-item"><a class="pure-menu-link" href="/docs/guides.html">Guides</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/guide.html">Schemas</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/schematypes.html">SchemaTypes</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/connections.html">Connections</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/models.html">Models</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/documents.html">Documents</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/subdocs.html">Subdocuments</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/queries.html">Queries</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/validation.html">Validation</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/middleware.html">Middleware</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/populate.html">Populate</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/discriminators.html">Discriminators</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/plugins.html">Plugins</a></li><li class="pure-menu-item"><a class="pure-menu-link" href="/docs/api.html">API</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/api/mongoose.html">Mongoose</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/api/schema.html">Schema</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/api/connection.html">Connection</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/api/document.html">Document</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/api/model.html">Model</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/api/query.html">Query</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/api/aggregate.html">Aggregate</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/api/schematype.html">SchemaType</a></li><li class="pure-menu-item sub-item"><a class="pure-menu-link" href="/docs/api/virtualtype.html">VirtualType</a></li><li class="pure-menu-item"><a class="pure-menu-link" href="/docs/compatibility.html">Version Compatibility</a></li><li class="pure-menu-item"><a class="pure-menu-link" href="/docs/faq.html">FAQ</a></li><li class="pure-menu-item"><a class="pure-menu-link" href="/docs/further_reading.html">Further Reading</a></li></ul><div class="cpc-ad"><script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=mongoosejscom" id="_carbonads_js"></script></div></div></div><div class="container"><div id="content"><h2 id="schematypes"><a href="#schematypes">SchemaTypes</a></h2>

_native.init("CK7DT53U",{

targetClass: 'native-inline'

});

</script>

<a href="#native_link#">Sponsor #native_company# — #native_desc#</a>

</div>

SchemaTypes handle definition of path

<a href="./api.html#schematype_SchemaType-default">defaults</a>,

<a href="./api.html#schematype_SchemaType-validate">validation</a>,

<a href="#getters">getters</a>,

<a href="./api.html#schematype_SchemaType-set">setters</a>,

<a href="./api.html#schematype_SchemaType-select">field selection defaults</a> for

<a href="./api.html#query-js">queries</a>,

and other general characteristics for Mongoose document properties.

<li><a href="#what-is-a-schema-type">What is a SchemaType?</a></li>

<li><a href="#schematype-options">SchemaType Options</a></li>

<li><a href="#customtypes">Creating Custom Types</a></li>

<li><a href="#path">The `schema.path()` Function</a></li>

</ul>

<h3 id="what-is-a-schematype"><a href="#what-is-a-schematype">What is a SchemaType?</a></h3>

You can think of a Mongoose schema as the configuration object for a

Mongoose model. A SchemaType is then a configuration object for an individual

property. A SchemaType says what type a given

path should have, whether it has any getters/setters, and what values are

valid for that path.

<pre><code class="language-javascript">const schema = new Schema({ name: String });

schema.path('name') instanceof mongoose.SchemaType; // true

schema.path('name') instanceof mongoose.Schema.Types.String; // true

schema.path('name').instance; // 'String'</code></pre>

A SchemaType is different from a type. In other words, <code>mongoose.ObjectId !== mongoose.Types.ObjectId</code>.

A SchemaType is just a configuration object for Mongoose. An instance of

the <code>mongoose.ObjectId</code> SchemaType doesn't actually create MongoDB ObjectIds,

it is just a configuration for a path in a schema.

The following are all the valid SchemaTypes in Mongoose. Mongoose plugins

can also add custom SchemaTypes like <a href="http://plugins.mongoosejs.io/plugins/int32">int32</a>.

Check out <a href="http://plugins.mongoosejs.io">Mongoose's plugins search</a> to find plugins.

<ul>

<li><a href="#strings">String</a></li>

<li><a href="#numbers">Number</a></li>

<li><a href="#buffers">Buffer</a></li>

<li><a href="#booleans">Boolean</a></li>

<li><a href="#mixed">Mixed</a></li>

<li><a href="#objectids">ObjectId</a></li>

<li><a href="#arrays">Array</a></li>

<li><a href="./api.html#Decimal128">Decimal128</a></li>

</ul>

<h4>Example</h4>

<pre><code class="language-javascript">var schema = new Schema({

name: String,

binary: Buffer,

living: Boolean,

updated: { type: Date, default: Date.now },

age: { type: Number, min: 18, max: 65 },

mixed: Schema.Types.Mixed,

_someId: Schema.Types.ObjectId,

decimal: Schema.Types.Decimal128,

array: [],

ofString: [String],

ofNumber: [Number],

ofDates: [Date],

ofBuffer: [Buffer],

ofBoolean: [Boolean],

ofMixed: [Schema.Types.Mixed],

ofObjectId: [Schema.Types.ObjectId],

ofArrays: [[]],

ofArrayOfNumbers: [[Number]],

nested: {

stuff: { type: String, lowercase: true, trim: true }

map: Map,

mapOfString: {

type: Map,

of: String

}

})

// example use

var Thing = mongoose.model('Thing', schema);

var m = new Thing;

m.name = 'Statue of Liberty';

m.age = 125;

m.updated = new Date;

m.binary = Buffer.alloc(0);

m.living = false;

m.mixed = { any: { thing: 'i want' } };

m.markModified('mixed');

m._someId = new mongoose.Types.ObjectId;

m.array.push(1);

m.ofString.push("strings!");

m.ofNumber.unshift(1,2,3,4);

m.ofDates.addToSet(new Date);

m.ofBuffer.pop();

m.ofMixed = [1, [], 'three', { four: 5 }];

m.nested.stuff = 'good';

m.map = new Map([['key', 'value']]);

m.save(callback);</code></pre>

<h3 id="schematype-options"><a href="#schematype-options">SchemaType Options</a></h3>

You can declare a schema type using the type directly, or an object with

a <code>type</code> property.

<pre><code class="language-javascript">var schema1 = new Schema({

test: String // `test` is a path of type String

});

var schema2 = new Schema({

// The `test` object contains the "SchemaType options"

test: { type: String } // `test` is a path of type string

});</code></pre>

In addition to the type property, you can specify additional properties

for a path. For example, if you want to lowercase a string before saving:

<pre><code class="language-javascript">var schema2 = new Schema({

test: {

type: String,

lowercase: true // Always convert `test` to lowercase

}

});</code></pre>

You can add any property you want to your SchemaType options. Many plugins

rely on custom SchemaType options. For example, the <a href="http://plugins.mongoosejs.io/plugins/autopopulate">mongoose-autopopulate</a>

plugin automatically populates paths if you set <code>autopopulate: true</code> in your

SchemaType options. Mongoose comes with support for several built-in

SchemaType options, like <code>lowercase</code> in the above example.

The <code>lowercase</code> option only works for strings. There are certain options

which apply for all schema types, and some that apply for specific schema

types.

<h5>All Schema Types</h5>

<ul>

<li><code>required</code>: boolean or function, if true adds a <a href="./validation.html#built-in-validators">required validator</a> for this property</li>

<li><code>default</code>: Any or function, sets a default value for the path. If the value is a function, the return value of the function is used as the default.</li>

<li><code>select</code>: boolean, specifies default <a href="https://docs.mongodb.com/manual/tutorial/project-fields-from-query-results/">projections</a> for queries</li>

<li><code>validate</code>: function, adds a <a href="./validation.html#built-in-validators">validator function</a> for this property</li>

<li><code>get</code>: function, defines a custom getter for this property using <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty"><code>Object.defineProperty()</code></a>.</li>

<li><code>set</code>: function, defines a custom setter for this property using <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty"><code>Object.defineProperty()</code></a>.</li>

<li><code>alias</code>: string, mongoose >= 4.10.0 only. Defines a <a href="./guide.html#virtuals">virtual</a> with the given name that gets/sets this path.</li>

</ul>

<pre><code class="language-javascript">var numberSchema = new Schema({

integerOnly: {

type: Number,

get: v => Math.round(v),

set: v => Math.round(v),

alias: 'i'

}

});

var Number = mongoose.model('Number', numberSchema);

var doc = new Number();

doc.integerOnly = 2.001;

doc.integerOnly; // 2

doc.i; // 2

doc.i = 3.001;

doc.integerOnly; // 3

doc.i; // 3</code></pre>

<h5>Indexes</h5>

You can also define <a href="https://docs.mongodb.com/manual/indexes/">MongoDB indexes</a>

using schema type options.

<ul>

<li><code>index</code>: boolean, whether to define an <a href="https://docs.mongodb.com/manual/indexes/">index</a> on this property.</li>

<li><code>unique</code>: boolean, whether to define a <a href="https://docs.mongodb.com/manual/core/index-unique/">unique index</a> on this property.</li>

<li><code>sparse</code>: boolean, whether to define a <a href="https://docs.mongodb.com/manual/core/index-sparse/">sparse index</a> on this property.</li>

</ul>

<pre><code class="language-javascript">var schema2 = new Schema({

test: {

type: String,

index: true,

unique: true // Unique index. If you specify `unique: true`

// specifying `index: true` is optional if you do `unique: true`

}

});</code></pre>

<h5 id="string-validators">String</h5>

<ul>

<li><code>lowercase</code>: boolean, whether to always call <code>.toLowerCase()</code> on the value</li>

<li><code>uppercase</code>: boolean, whether to always call <code>.toUpperCase()</code> on the value</li>

<li><code>trim</code>: boolean, whether to always call <code>.trim()</code> on the value</li>

<li><code>match</code>: RegExp, creates a <a href="./validation.html">validator</a> that checks if the value matches the given regular expression</li>

<li><code>enum</code>: Array, creates a <a href="./validation.html">validator</a> that checks if the value is in the given array.</li>

<li><code>minlength</code>: Number, creates a <a href="./validation.html">validator</a> that checks if the value length is not less than the given number</li>

<li><code>maxlength</code>: Number, creates a <a href="./validation.html">validator</a> that checks if the value length is not greater than the given number</li>

</ul>

<h5 id="number-validators">Number</h5>

<ul>

<li><code>min</code>: Number, creates a <a href="./validation.html">validator</a> that checks if the value is greater than or equal to the given minimum.</li>

<li><code>max</code>: Number, creates a <a href="./validation.html">validator</a> that checks if the value is less than or equal to the given maximum.</li>

</ul>

<ul>

</ul>

<h3 id="usage-notes"><a href="#usage-notes">Usage notes</a></h3>

<h4 id="strings">String</h4>

To declare a path as a string, you may use either the <code>String</code> global

constructor or the string <code>'String'</code>.

<pre><code class="language-javascript">const schema1 = new Schema({ name: String }); // name will be cast to string

const schema2 = new Schema({ name: 'String' }); // Equivalent

const Person = mongoose.model('Person', schema2);</code></pre>

If you pass an element that has a <code>toString()</code> function, Mongoose will call it,

unless the <code>toString()</code> function is strictly equal to <code>Object.prototype.toString()</code>.

<pre><code class="language-javascript">new Person({ name: 42 }).name; // "42" as a string

new Person({ name: { toString: () => 42 } }).name; // "42" as a string

// "undefined", will get a cast error if you `save()` this document

new Person({ name: { foo: 42 } }).name; </code></pre>

<h4 id="numbers">Number</h4>

To declare a path as a number, you may use either the <code>Number</code> global

constructor or the string <code>'Number'</code>.

<pre><code class="language-javascript">const schema1 = new Schema({ age: Number }); // age will be cast to a Number

const schema2 = new Schema({ age: 'Number' }); // Equivalent

const Car = mongoose.model('Car', schema2);</code></pre>

There are several types of values that will be successfully cast to a Number.

<pre><code class="language-javascript">new Car({ age: '15' }).age; // 15 as a Number

new Car({ age: true }).age; // 1 as a Number

new Car({ age: false }).age; // 0 as a Number

new Car({ age: { valueOf: () => 83 } }).age; // 83 as a Number</code></pre>

If you pass an object with a <code>valueOf()</code> function that returns a Number, Mongoose will

call it and assign the returned value to the path.

The values <code>null</code> and <code>undefined</code> are not cast.

NaN, strings that cast to NaN, arrays, and objects that don't have a <code>valueOf()</code> function

will all result in a <a href="/docs/api.html#mongooseerror_MongooseError.CastError">CastError</a>.

<h4 id="dates">Dates</h4>

<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date">Built-in <code>Date</code> methods</a> are <a href="https://github.com/Automattic/mongoose/issues/1598">not hooked into</a> the mongoose change tracking logic which in English means that if you use a <code>Date</code> in your document and modify it with a method like <code>setMonth()</code>, mongoose will be unaware of this change and <code>doc.save()</code> will not persist this modification. If you must modify <code>Date</code> types using built-in methods, tell mongoose about the change with <code>doc.markModified('pathToYourDate')</code> before saving.

<pre><code class="language-javascript">var Assignment = mongoose.model('Assignment', { dueDate: Date });

Assignment.findOne(function (err, doc) {

doc.dueDate.setMonth(3);

doc.save(callback); // THIS DOES NOT SAVE YOUR CHANGE

doc.markModified('dueDate');

doc.save(callback); // works

})</code></pre>

<h4 id="buffers">Buffer</h4>

To declare a path as a Buffer, you may use either the <code>Buffer</code> global

constructor or the string <code>'Buffer'</code>.

<pre><code class="language-javascript">const schema1 = new Schema({ binData: Buffer }); // binData will be cast to a Buffer

const schema2 = new Schema({ binData: 'Buffer' }); // Equivalent

const Data = mongoose.model('Data', schema2);</code></pre>

Mongoose will successfully cast the below values to buffers.

<pre><code>const file1 = new Data({ binData: 'test'}); // {"type":"Buffer","data":[116,101,115,116]}

const file2 = new Data({ binData: 72987 }); // {"type":"Buffer","data":[27]}

const file4 = new Data({ binData: { type: 'Buffer', data: [1, 2, 3]}}); // {"type":"Buffer","data":[1,2,3]}</code></pre><h4 id="mixed">Mixed</h4>

An "anything goes" SchemaType. Mongoose will not do any casting on mixed paths.

You can define a mixed path using <code>Schema.Types.Mixed</code> or by passing an empty

object literal. The following are equivalent.

<pre><code class="language-javascript">const Any = new Schema({ any: {} });

const Any = new Schema({ any: Object });

const Any = new Schema({ any: Schema.Types.Mixed });

const Any = new Schema({ any: mongoose.Mixed });

// Note that if you're using `type`, putting _any_ POJO as the `type` will

// make the path mixed.

const Any = new Schema({

any: {

type: { foo: String }

}

});</code></pre>

Since it is a schema-less type, you can change the value to anything else you

like, but Mongoose loses the ability to auto detect and save those changes.

To tell Mongoose that the value of a Mixed type has changed, you need to

call <code>doc.markModified(path)</code>, passing the path to the Mixed type you just changed.

<pre><code class="language-javascript">person.anything = { x: [3, 4, { y: "changed" }] };

person.markModified('anything');

person.save(); // Mongoose will save changes to `anything`.</code></pre>

<h4 id="objectids">ObjectIds</h4>

To specify a type of ObjectId, use <code>Schema.Types.ObjectId</code> in your declaration.

<pre><code class="language-javascript">var mongoose = require('mongoose');

var ObjectId = mongoose.Schema.Types.ObjectId;

var Car = new Schema({ driver: ObjectId });

// or just Schema.ObjectId for backwards compatibility with v2</code></pre>

<h4 id="booleans">Boolean</h4>

Booleans in Mongoose are <a href="https://www.w3schools.com/js/js_booleans.asp">plain JavaScript booleans</a>.

By default, Mongoose casts the below values to <code>true</code>:

<ul>

</ul>

Mongoose casts the below values to <code>false</code>:

<ul>

<li><code>false</code></li>

<li><code>'false'</code></li>

</ul>

Any other value causes a <a href="/docs/api.html#mongooseerror_MongooseError.CastError">CastError</a>.

You can modify what values Mongoose converts to true or false using the

<code>convertToTrue</code> and <code>convertToFalse</code> properties, which are <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set">JavaScript sets</a>.

<pre><code class="language-javascript">const M = mongoose.model('Test', new Schema({ b: Boolean }));

console.log(new M({ b: 'nay' }).b); // undefined

// Set { false, 'false', 0, '0', 'no' }

console.log(mongoose.Schema.Types.Boolean.convertToFalse);

mongoose.Schema.Types.Boolean.convertToFalse.add('nay');

console.log(new M({ b: 'nay' }).b); // false</code></pre>

<h4 id="arrays">Arrays</h4>

Mongoose supports arrays of <a href="./api.html#schema_Schema.Types">SchemaTypes</a>

and arrays of <a href="./subdocs.html">subdocuments</a>. Arrays of SchemaTypes are

also called primitive arrays, and arrays of subdocuments are also called

document arrays.

<pre><code class="language-javascript">var ToySchema = new Schema({ name: String });

var ToyBoxSchema = new Schema({

toys: [ToySchema],

buffers: [Buffer],

strings: [String],

numbers: [Number]

// ... etc

});</code></pre>

Arrays are special because they implicitly have a default value of <code>[]</code> (empty array).

<pre><code class="language-javascript">var ToyBox = mongoose.model('ToyBox', ToyBoxSchema);

console.log((new ToyBox()).toys); // []</code></pre>

To overwrite this default, you need to set the default value to <code>undefined</code>

<pre><code class="language-javascript">var ToyBoxSchema = new Schema({

toys: {

type: [ToySchema],

default: undefined

}

});</code></pre>

Note: specifying an empty array is equivalent to <code>Mixed</code>. The following all create arrays of

<code>Mixed</code>:

<pre><code class="language-javascript">var Empty1 = new Schema({ any: [] });

var Empty2 = new Schema({ any: Array });

var Empty3 = new Schema({ any: [Schema.Types.Mixed] });

var Empty4 = new Schema({ any: [{}] });</code></pre>

New in Mongoose 5.1.0

A <code>MongooseMap</code> is a subclass of the built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map"><code>Map</code> class</a>.

In these docs, we'll use the terms 'map' and <code>MongooseMap</code> interchangeably.

In Mongoose, maps are how you create a nested document with arbitrary keys.

Note: In Mongoose Maps, keys must be strings in order to store the document in MongoDB.

<pre><code class="language-javascript">const userSchema = new Schema({

// `socialMediaHandles` is a map whose values are strings. A map's

// keys are always strings. You specify the type of values using `of`.

socialMediaHandles: {

type: Map,

of: String

}

});

const User = mongoose.model('User', userSchema);

// Map { 'github' => 'vkarpov15', 'twitter' => '@code_barbarian' }

console.log(new User({

socialMediaHandles: {

github: 'vkarpov15',

twitter: '@code_barbarian'

}

}).socialMediaHandles);</code></pre>

The above example doesn't explicitly declare <code>github</code> or <code>twitter</code> as paths,

but, since <code>socialMediaHandles</code> is a map, you can store arbitrary key/value

pairs. However, since <code>socialMediaHandles</code> is a map, you must use

<code>.get()</code> to get the value of a key and <code>.set()</code> to set the value of a key.

<pre><code class="language-javascript">const user = new User({

socialMediaHandles: {}

});

// Good

user.socialMediaHandles.set('github', 'vkarpov15');

// Works too

user.set('socialMediaHandles.twitter', '@code_barbarian');

// Bad, the `myspace` property will **not** get saved

user.socialMediaHandles.myspace = 'fail';

// 'vkarpov15'

console.log(user.socialMediaHandles.get('github'));

// '@code_barbarian'

console.log(user.get('socialMediaHandles.twitter'));

// undefined

user.socialMediaHandles.github;

// Will only save the 'github' and 'twitter' properties

user.save();</code></pre>

Map types are stored as <a href="https://en.wikipedia.org/wiki/BSON#Data_types_and_syntax">BSON objects in MongoDB</a>.

Keys in a BSON object are ordered, so this means the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map#Description">insertion order</a>

property of maps is maintained.

<h3 id="getters"><a href="#getters">Getters</a></h3>

Getters are like virtuals for paths defined in your schema. For example,

let's say you wanted to store user profile pictures as relative paths and

then add the hostname in your application. Below is how you would structure

your <code>userSchema</code>:

<pre><code class="language-javascript">const root = 'https://s3.amazonaws.com/mybucket';

const userSchema = new Schema({

name: String,

picture: {

type: String,

get: v => `${root}${v}`

}

});

const User = mongoose.model('User', userSchema);

const doc = new User({ name: 'Val', picture: '/123.png' });

doc.picture; // 'https://s3.amazonaws.com/mybucket/123.png'

doc.toObject({ getters: false }).picture; // '123.png'</code></pre>

Generally, you only use getters on primitive paths as opposed to arrays

or subdocuments. Because getters override what accessing a Mongoose path returns,

declaring a getter on an object may remove Mongoose change tracking for

that path.

<pre><code class="language-javascript">const schema = new Schema({

arr: [{ url: String }]

});

const root = 'https://s3.amazonaws.com/mybucket';

// Bad, don't do this!

schema.path('arr').get(v => {

return v.map(el => Object.assign(el, { url: root + el.url }));

});

// Later

doc.arr.push({ key: String });

doc.arr[0]; // 'undefined' because every `doc.arr` creates a new array!</code></pre>

Instead of declaring a getter on the array as shown above, you should

declare a getter on the <code>url</code> string as shown below. If you need to declare

a getter on a nested document or array, be very careful!

<pre><code class="language-javascript">const schema = new Schema({

arr: [{ url: String }]

});

const root = 'https://s3.amazonaws.com/mybucket';

// Good, do this instead of declaring a getter on `arr`

schema.path('arr.0.url').get(v => `${root}${v}`);</code></pre>

<h3 id="customtypes"><a href="#customtypes">Creating Custom Types</a></h3>

Mongoose can also be extended with <a href="customschematypes.html">custom SchemaTypes</a>. Search the

<a href="http://plugins.mongoosejs.io">plugins</a>

site for compatible types like

<a href="https://github.com/aheckmann/mongoose-long">mongoose-long</a>,

<a href="https://github.com/vkarpov15/mongoose-int32">mongoose-int32</a>,

and

<a href="https://github.com/aheckmann/mongoose-function">other</a>

<a href="https://github.com/OpenifyIt/mongoose-types">types</a>.

Read more about creating <a href="customschematypes.html">custom SchemaTypes here</a>.

<h3 id="path"><a href="#path">The `schema.path()` Function</a></h3>

The <code>schema.path()</code> function returns the instantiated schema type for a

given path.

<pre><code class="language-javascript">var sampleSchema = new Schema({ name: { type: String, required: true } });

console.log(sampleSchema.path('name'));

// Output looks like:

/**

* SchemaString {

* enumValues: [],

* regExp: null,

* path: 'name',

* instance: 'String',

* validators: ...

*/</code></pre>

You can use this function to inspect the schema type for a given path,

including what validators it has and what the type is.

Now that we've covered <code>SchemaTypes</code>, let's take a look at <a href="/docs/connections.html">Connections</a>.

</div></div><script type="text/javascript">var xhr = new XMLHttpRequest();

xhr.open('POST', 'https://g0a3nbw0xa.execute-api.us-east-1.amazonaws.com/prod/track', true);

xhr.setRequestHeader('Content-Type', 'application/json');

xhr.onreadystatechange = function() {};

xhr.send(JSON.stringify({

path: window.location.pathname,

hostname: window.location.hostname,

hash: window.location.hash

}));</script><script type="text/javascript" src="/docs/js/navbar-search.js"></script><script type="text/javascript">(function (window, document) {

var layout = document.getElementById('layout'),

menu = document.getElementById('menu'),

menuLink = document.getElementById('menuLink'),

content = document.getElementById('content');

function toggleClass(element, className) {

var classes = element.className.split(/\s+/),

length = classes.length,

i = 0;

for(; i < length; i++) {

if (classes[i] === className) {

classes.splice(i, 1);

break;

}

// The className is not found

if (length === classes.length) {

classes.push(className);

}

element.className = classes.join(' ');

}

function toggleAll(e) {

var active = 'active';

e.preventDefault();

toggleClass(layout, active);

toggleClass(menu, active);

toggleClass(menuLink, active);

}

menuLink.onclick = function (e) {

toggleAll(e);

};

content.onclick = function(e) {

if (menu.className.indexOf('active') !== -1) {

toggleAll(e);

}

};

}(this, this.document));</script></div></body></html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

schematypes.html

Latest commit

History

schematypes.html

File metadata and controls