# Class: Document ‹T›

Document class represent a database document and provide some useful methods to work with.

example

import { connect, model } from "ottoman";
connect("couchbase://localhost/travel-sample@admin:password");

// Create an `User` model
const User = model('User', { name: String });

// Create a document from the `User` Model
const jane = new User({name: "Jane Doe"})

# Type parameters

▪ T

# Hierarchy

Document

↳ Model

# Methods

# _applyData

▸ _applyData(data: any, strategy?: CAST_STRATEGY): void

Allows to easily apply data from an object to current document.

example

const user = new User({name: "John Doe"});

user._applyData({name: "Jane Doe"});
console.log(user) // {name: "Jane Doe"}

Parameters:

Name	Type
`data`	any
`strategy?`	CAST_STRATEGY

Returns: void

# _depopulate

▸ _depopulate(fieldsName: string | string[]): this

Reverts population. Switches back document reference

example To get in context about the Card and Issue Models see the populate example.

const card = await Card.findById(cardId);
console.log(card.issues); // ['issueId']

await card._populate('issues')
console.log(card.issues); // [{id: 'issueId', title: 'Broken card'}]

card._depopulate('issues')
console.log(card.issues); // ['issueId']

Parameters:

Name	Type
`fieldsName`	string \| string[]

Returns: this

# _getId

▸ _getId(): string

Returns id value, useful when working with dynamic ID_KEY

example

  console.log(user._getId()); // 'userId'
  console.log(user.id); // 'userId'

Returns: string

# _getIdField

▸ _getIdField(): string

Returns id key

Returns: string

# _populate

▸ _populate(fieldsName: string | string[], deep: number): Promise‹this›

Allows to load document references

example Getting context to explain populate.

const CardSchema = new Schema({
  number: String,
  zipCode: String,
  issues: [{ type: IssueSchema, ref: 'Issue' }],
});

const IssueSchema = new Schema({
  title: String,
  description: String,
});

const Card = model('Card', CardSchema);
const Issue = model('Issue', CardSchema);

const issue = await Issue.create({ title: 'Broken card' });

const card = await Card.create({
  cardNumber: '4242 4242 4242 4242',
  zipCode: '42424',
  issues: [issue.id],
});

Now we will see how the _populate methods works.

const card = await Card.findById(cardId);
console.log(card.issues); // ['issueId']

await card.populate('issues')
console.log(card.issues); // [{id: 'issueId', title: 'Broken card'}]

Parameters:

Name	Type	Default
`fieldsName`	string \| string[]	-
`deep`	number	1

Returns: Promise‹this›

# _populated

▸ _populated(fieldName: string): boolean

Allows to know if a document field is populated

example To get in context about the Card and Issue Models see the populate example.

const card = await Card.findById(cardId);
console.log(card.issues); // ['issueId']
console.log(card._populated('issues')); // false

await card._populate('issues')
console.log(card.issues); // [{id: 'issueId', title: 'Broken card'}]
console.log(card._populated('issues')); // true

Parameters:

Name	Type
`fieldName`	string

Returns: boolean

# _validate

▸ _validate(): any

Runs schema validations over current document

example

const user = new User({name: "John Doe"});

try {
  await user._validate()
} catch(errors) {
  console.log(errors)
}

Returns: any

# remove

▸ remove(options: object): Promise‹any›

Removes the document from database

example

const user = User.findById('userId')

await user.remove();

Parameters:

Name	Type	Default
`options`	object	{}

Returns: Promise‹any›

# save

▸ save(onlyCreate: boolean): Promise‹this›

Saves or Updates the document

example

const user = new User({name: "John Doe"}); //user document created, it's not saved yet

await user.save(); // user saved into the DB

You also can force save function to only create new Documents by passing true as argument
await user.save(true); // ensure to execute a insert operation

Parameters:

Name	Type	Default
`onlyCreate`	boolean	false

Returns: Promise‹this›

# toJSON

▸ toJSON(): this

Returns a Javascript object to be serialized to JSON

Returns: this

# toObject

▸ toObject(): this

Returns a Javascript object with data

Returns: this