# API Reference

# Classes

AbstractBaseModel

Abstract Base Model representation for all created Document instances. Represents just the document data and generic properties and functions. Also used for "object" abstraction / representation of sub documents that are not actual Models / Documents. Clients should never have to call this directly.

BaseModel ⇐ EventEmitter

BaseModel implements AbstractBaseModel and is a representation for all created Document instances that have a user defined schema. Represents just the document data and generic properties and functions. Clients should never have to call this directly. Inherits EventEmitter

CouchbaseDocument ⇐ Document

CouchbaseDocument inherits Document and handles all the database related actions. Clients should never have to call this directly.

Document ⇐ BaseModel

Base constructor for all created Document instances. Represents just the document data and generic properties and functions. Clients should never have to call this directly.

Lounge ⇐ Bucket

The Lounge module The exports object of the lounge module is an instance of this class. Most apps will only use this one instance. We copy all Couchbase Bucket methods and properties so you can call them generically = require(this instance as well.

Model ⇐ CouchbaseDocument

Model class is a base class for all ModelInstances and it extends CouchbaseDocument

ModelInstance ⇐ Model

ModelInstance class is the compiled class from a schema definition. It extends Model. All models generated are an instance of ModelInstance. It also inherits grappling-hook See grappling-hook for pre and post hooks.

Schema

Schema class represents the schema definition. It includes properties, methods, static methods, and any middleware we want to define.

# AbstractBaseModel

Abstract Base Model representation for all created Document instances. Represents just the document data and generic properties and functions. Also used for "object" abstraction / representation of sub documents that are not actual Models / Documents. Clients should never have to call this directly.

Kind: global class

• AbstractBaseModel
  • new AbstractBaseModel(values, options, schema)
  • .schema ⇒ Schema
  • .set()
  • .get(path) ⇒ *
  • .toObject(options) ⇒ Object
  • .toJSON(options) ⇒ Object
  • .inspect()
  • .toString()
  • .clear()
  • .getErrors()
  • .clearErrors()
  • .hasErrors() ⇒ Boolean

# new AbstractBaseModel(values, options, schema)

Clients do not need to create AbstractBaseModel instances manually.

# abstractBaseModel.schema ⇒ Schema

Get the model schema instance

Kind: instance property of AbstractBaseModel
Access: public

# abstractBaseModel.set()

Sets data on the document based on the schema. Accepts a key of property and value for the property, or object representing the data for document.

Kind: instance method of AbstractBaseModel
Access: public
Example

user.set('fistName', 'Joe')
user.set({ lastName: 'Smith' })

# abstractBaseModel.get(path) ⇒ *

Gets value at a specified path.

Kind: instance method of AbstractBaseModel
Returns: * - The value at the path.

# abstractBaseModel.toObject(options) ⇒ Object

Converts this document into a plain javascript object.

Kind: instance method of AbstractBaseModel
Returns: Object - Plain javascript object representation of document.
Access: public

Example

var userSchema = lounge.schema({ name: String })
var User = lounge.model('User', userSchema)
var user = new User({name: 'Joe Smith'})
console.log(user) // automatically invokes toObject()

Example (Example with transform option.)

var xform = function (doc, ret, options) {
  ret.name = ret.name.toUpperCase()
  return ret
}
console.dir(user.toObject({transform: xform}) // { name: 'JOE SMITH' }

# abstractBaseModel.toJSON(options) ⇒ Object

Similar as toObject but applied when JSON.stringify is called

Kind: instance method of AbstractBaseModel
Returns: Object - Plain javascript object representation of document.
Access: public

# abstractBaseModel.inspect()

Helper for console.log. Just invokes default toObject.

Kind: instance method of AbstractBaseModel
Access: public

# abstractBaseModel.toString()

Helper for console.log. Alias for inspect.

Kind: instance method of AbstractBaseModel
Access: public

# abstractBaseModel.clear()

Clear the document data. This can be overridden at schema level using Schema.set().

Kind: instance method of AbstractBaseModel

# abstractBaseModel.getErrors()

Gets the errors object.

Kind: instance method of AbstractBaseModel

# abstractBaseModel.clearErrors()

Clears all the errors.

Kind: instance method of AbstractBaseModel

# abstractBaseModel.hasErrors() ⇒ Boolean

Checks whether we have any errors.

Kind: instance method of AbstractBaseModel
Returns: Boolean - true if we have errors, false otherwise.

# BaseModel ⇐ EventEmitter

BaseModel implements AbstractBaseModel and is a representation for all created Document instances that have a user defined schema. Represents just the document data and generic properties and functions. Clients should never have to call this directly. Inherits EventEmitter

Kind: global class
Extends: EventEmitter

# new BaseModel()

Clients do not need to create BaseModel instances manually.

# CouchbaseDocument ⇐ Document

CouchbaseDocument inherits Document and handles all the database related actions. Clients should never have to call this directly.

Kind: global class
Extends: Document

• CouchbaseDocument ⇐ Document
  • new CouchbaseDocument(values, cas, options, schema, name)
  • instance
    • .cas ⇒ String
    • .db ⇒ Driver | null
    • .config ⇒ Object
    • .modelName : String
    • ._isNew : Boolean
    • .getCAS(raw) ⇒ String | Object
    • .save(options, replicate_to, fn)
    • .index(options, fn)
    • .remove(options, fn)
    • .removeIndexes(options, fn)
    • .populate(options, fn)
    • .getDocumentKeyValue(full) ⇒ String
    • .getDocumentKeyKey() ⇒ String
  • static
    • .findById(id, options, fn)
    • .remove(id, options, fn)

# new CouchbaseDocument(values, cas, options, schema, name)

Clients do not need to create Document manually.

# couchbaseDocument.cas ⇒ String

Returns the string representation of CAS value.

Kind: instance property of CouchbaseDocument
Example

console.log(doc.cas) // String: 00000000a71626e4

# couchbaseDocument.db ⇒ Driver | null

Gets the database driver of the model

Kind: instance property of CouchbaseDocument

# couchbaseDocument.config ⇒ Object

Gets the config object

Kind: instance property of CouchbaseDocument

# couchbaseDocument.modelName : String

The name the name of the model. This is both a static and instance property.

Kind: instance property of CouchbaseDocument
Example

var schema = lounge.schema({ name: String })
var Cat = lounge.model('Cat', schema)
var kitty = new Cat({ name: 'Zildjian' })
console.log(Cat.modelName) // 'Cat'
console.log(kitty.modelName) // 'Cat'

# couchbaseDocument._isNew : Boolean

Has a key been generated for this document.

Kind: instance property of CouchbaseDocument
Example

var schema = lounge.schema({ name: String })
var Cat = lounge.model('Cat', schema)
var kitty = new Cat({ name: 'Zildjian' })
console.log(kitty._isNew) // true
var kat = new Cat({ id: '123abc', name: 'Sabian' })
console.log(kat._isNew) // false

# couchbaseDocument.getCAS(raw) ⇒ String | Object

Returns the document CAS value.

Kind: instance method of CouchbaseDocument
Returns: String | Object - the CAS value

Example

console.log(doc.getCAS()) // String: 00000000a71626e4
console.log(doc.getCAS(true)) // Object: CouchbaseCas<11338961768815788032>

# couchbaseDocument.save(options, replicate_to, fn)

Save the current model instance. Calls db set function for the model id and saves the properties.

Kind: instance method of CouchbaseDocument

Example

var user = new User({ name: 'Bob Smith', email: 'bsmith@acme.com' })
user.save(function(err, savedDoc) {
  if(err) console.log(err)
})

# couchbaseDocument.index(options, fn)

Update all lookup documents for this document instance. Creates new lookup documents for properties that have changed and deletes the old ones not needed any more.

Kind: instance method of CouchbaseDocument

# couchbaseDocument.remove(options, fn)

Removes the instance from the database. Calls the bucket remove() function. Options can be passed to the driver.

Kind: instance method of CouchbaseDocument

Example

user.remove(function(err, doc) {
  if(err) console.log(err)
})

# couchbaseDocument.removeIndexes(options, fn)

Removes all lookup / index documents for this document.

Kind: instance method of CouchbaseDocument

# couchbaseDocument.populate(options, fn)

Populates this instance given the options

Kind: instance method of CouchbaseDocument

Example (Populate an instance)

User.findBy(userId, (err, user) {
  console.log(user.company) // ID
  user.populate((err, populatedUser) => {
    console.log(user.company) // full populated sub documnet
  })
})

Example (Populate a specific path within an instance)

User.findBy(userId, (err, user) {
  console.log(user.company) // ID
  user.populate('company', (err, populatedUser) => {
    console.log(user.company) // full populated sub documnet
  })
})

# couchbaseDocument.getDocumentKeyValue(full) ⇒ String

Helper function to get the document key.

Kind: instance method of CouchbaseDocument
Returns: String - document key
Access: public

Example

var schema = lounge.schema({ email: String }, { keyPrefix: 'user::'})
var User = lounge.model('User', schema)
var user = new User({ email: 'bsmith@acme.com' })
console.log(user.getDocumentKeyValue()) // 114477a8-1901-4146-8c90-0fc9eec57a58
console.log(user.getDocumentKeyValue(true)) // user::114477a8-1901-4146-8c90-0fc9eec57a58

# couchbaseDocument.getDocumentKeyKey() ⇒ String

Gets the Document key property name.

Kind: instance method of CouchbaseDocument
Returns: String - Document key property name
Access: public
Example

var schema = lounge.schema({ email: { type: String, key: true, generate: false }})
var User = lounge.model('User', schema)
var user = new User({ email: 'bsmith@acme.com' })
console.log(user.getDocumentKeyKey()) // email

# CouchbaseDocument.findById(id, options, fn)

All models created come with a static function findById that can be used to look up a single or multiple keys and retrieve documents from the database. If key does not exist and document is not found we do not return an error but also no model is generated. This is different than present couchbase module behaviour.

Kind: static method of CouchbaseDocument

Example

User.findById('user123', function(err, doc, missing) {
  if(err) console.log(err) // there was an error looking up the key
  else if(!doc) console.log('no document found')
  else console.log(doc) // doc is instance of User and will print it out
})

# CouchbaseDocument.remove(id, options, fn)

Removes specified document(s).

Kind: static method of CouchbaseDocument

Example

User.remove('user123', function(err, doc) {
  if(err) console.log(err)
})

# Document ⇐ BaseModel

Base constructor for all created Document instances. Represents just the document data and generic properties and functions. Clients should never have to call this directly.

Kind: global class
Extends: BaseModel

• Document ⇐ BaseModel
  • new Document(values, options, schema, name)
  • instance
    • .modelName : String
    • ._isNew : Boolean
    • .getDocumentKeyValue(full) ⇒ String
    • .getDocumentKeyKey() ⇒ String
  • static
    • .getDocumentKeyKey() ⇒ String
    • .getDocumentKeyValue(id, full) ⇒ string

# new Document(values, options, schema, name)

Clients do not need to create Document manually.

# document.modelName : String

The name the name of the model. This is both a static and instance property.

Kind: instance property of Document
Example

var schema = lounge.schema({ name: String })
var Cat = lounge.model('Cat', schema)
var kitty = new Cat({ name: 'Zildjian' })
console.log(Cat.modelName) // 'Cat'
console.log(kitty.modelName) // 'Cat'

# document._isNew : Boolean

Has a key been generated for this document.

Kind: instance property of Document
Example

var schema = lounge.schema({ name: String })
var Cat = lounge.model('Cat', schema)
var kitty = new Cat({ name: 'Zildjian' })
console.log(kitty._isNew) // true
var kat = new Cat({ id: '123abc', name: 'Sabian' })
console.log(kat._isNew) // false

# document.getDocumentKeyValue(full) ⇒ String

Helper function to get the document key.

Kind: instance method of Document
Returns: String - document key
Access: public

Example

var schema = lounge.schema({ email: String }, { keyPrefix: 'user::'})
var User = lounge.model('User', schema)
var user = new User({ email: 'bsmith@acme.com' })
console.log(user.getDocumentKeyValue()) // 114477a8-1901-4146-8c90-0fc9eec57a58
console.log(user.getDocumentKeyValue(true)) // user::114477a8-1901-4146-8c90-0fc9eec57a58

# document.getDocumentKeyKey() ⇒ String

Gets the Document key property name.

Kind: instance method of Document
Returns: String - Document key property name
Access: public
Example

var schema = lounge.schema({ email: { type: String, key: true, generate: false }})
var User = lounge.model('User', schema)
var user = new User({ email: 'bsmith@acme.com' })
console.log(user.getDocumentKeyKey()) // email

# Document.getDocumentKeyKey() ⇒ String

Gets the Document key property name.

Kind: static method of Document
Returns: String - Document key property name
Access: public
Example

var schema = lounge.schema({ email: { type: String, key: true, generate: false }});
var User = lounge.model('User', schema);
console.log(User.getDocumentKeyKey()); // email

# Document.getDocumentKeyValue(id, full) ⇒ string

Static version of getDocumentKeyValue.

Kind: static method of Document
Returns: string - Document key / id
Access: public

Example

// assuming keyPrefix: 'user::'
console.log(User.getDocumentKeyValue('114477a8-1901-4146-8c90-0fc9eec57a58', true)) // user::114477a8-1901-4146-8c90-0fc9eec57a58
console.log(User.getDocumentKeyValue('user::114477a8-1901-4146-8c90-0fc9eec57a58', true)) // user::114477a8-1901-4146-8c90-0fc9eec57a58
console.log(User.getDocumentKeyValue('user::114477a8-1901-4146-8c90-0fc9eec57a58', false)) // 114477a8-1901-4146-8c90-0fc9eec57a58
console.log(User.getDocumentKeyValue('114477a8-1901-4146-8c90-0fc9eec57a58', false)) // 114477a8-1901-4146-8c90-0fc9eec57a58

# Lounge ⇐ Bucket

The Lounge module The exports object of the lounge module is an instance of this class. Most apps will only use this one instance. We copy all Couchbase Bucket methods and properties so you can call them generically = require(this instance as well.

Kind: global class
Extends: Bucket

• Lounge ⇐ Bucket
  • new Lounge(options)
  • .Schema
  • .Model
  • .CouchbaseDocument
  • .Document
  • .Lounge
  • .connect(options, fn) ⇒ Bucket
  • .disconnect()
  • .schema(descriptor, options) ⇒ Schema
  • .model(name, schema, options) ⇒ ModelInstance
  • .getModel(name) ⇒ Model | undefined
  • .setOption(key, value)
  • .getOption(key) ⇒ *
  • .modelNames() ⇒ Array

# new Lounge(options)

The Lounge constructor

# lounge.Schema

The Lounge Schema constructor

Kind: instance property of Lounge

# lounge.Model

The Lounge Model constructor.

Kind: instance property of Lounge

# lounge.CouchbaseDocument

The Lounge CouchbaseDocument constructor.

Kind: instance property of Lounge

# lounge.Document

The Lounge Document constructor.

Kind: instance property of Lounge

# lounge.Lounge

The Lounge constructor The exports of the Lounge module is an instance of this class.

Kind: instance property of Lounge

# lounge.connect(options, fn) ⇒ Bucket

Connect to the database. You may define Models before connecting, but you should not create any actual document instances before connecting to the database.

Kind: instance method of Lounge
Returns: Bucket - Couchbase Bucket instance
Access: public

Example

lounge.connect({
  connectionString: 'couchbase://127.0.0.1',
  bucket: 'lounge_test'
})

# lounge.disconnect()

Disconnect = require(the bucket. Deletes all defined models.

Kind: instance method of Lounge

# lounge.schema(descriptor, options) ⇒ Schema

Creates a schema. Prefer to use this over Schema constructor as this will pass along Lounge config settings.

Kind: instance method of Lounge
Returns: Schema - created Schema instance
Access: public

Example

var schema = lounge.schema({ name: String })

# lounge.model(name, schema, options) ⇒ ModelInstance

Creates a model = require(a schema.

Kind: instance method of Lounge
Returns: ModelInstance - The created ModelInstance class.
Access: public

Example

var Cat = lounge.model('Cat', schema)

# lounge.getModel(name) ⇒ Model | undefined

Returns the model given the name.

Kind: instance method of Lounge
Returns: Model | undefined - The ModelInstance or undefined if the model by that name does not exist.

Example

var Cat = lounge.getModel('Cat')

# lounge.setOption(key, value)

Sets lounge config options

Kind: instance method of Lounge
Access: public

# lounge.getOption(key) ⇒ *

Get config option.

Kind: instance method of Lounge
Returns: * - Option value

# lounge.modelNames() ⇒ Array

Returns an array of model names created on this instance of Lounge.

Kind: instance method of Lounge
Returns: Array - Array of model names registered.
Access: public
Example

console.log(lounge.modelNames()) // [ 'Cat', 'Dog' ]

# Model ⇐ CouchbaseDocument

Model class is a base class for all ModelInstances and it extends CouchbaseDocument

Kind: global class
Extends: CouchbaseDocument

• Model ⇐ CouchbaseDocument
  • new Model()
  • .cas ⇒ String
  • .db ⇒ Driver | null
  • .config ⇒ Object
  • .modelName : String
  • ._isNew : Boolean
  • .getCAS(raw) ⇒ String | Object
  • .save(options, replicate_to, fn)
  • .index(options, fn)
  • .remove(options, fn)
  • .removeIndexes(options, fn)
  • .populate(options, fn)
  • .getDocumentKeyValue(full) ⇒ String
  • .getDocumentKeyKey() ⇒ String

# new Model()

Model class is a base class for all ModelInstances and it extends CouchbaseDocument

# model.cas ⇒ String

Returns the string representation of CAS value.

Kind: instance property of Model
Example

console.log(doc.cas) // String: 00000000a71626e4

# model.db ⇒ Driver | null

Gets the database driver of the model

Kind: instance property of Model

# model.config ⇒ Object

Gets the config object

Kind: instance property of Model

# model.modelName : String

The name the name of the model. This is both a static and instance property.

Kind: instance property of Model
Example

var schema = lounge.schema({ name: String })
var Cat = lounge.model('Cat', schema)
var kitty = new Cat({ name: 'Zildjian' })
console.log(Cat.modelName) // 'Cat'
console.log(kitty.modelName) // 'Cat'

# model._isNew : Boolean

Has a key been generated for this document.

Kind: instance property of Model
Example

var schema = lounge.schema({ name: String })
var Cat = lounge.model('Cat', schema)
var kitty = new Cat({ name: 'Zildjian' })
console.log(kitty._isNew) // true
var kat = new Cat({ id: '123abc', name: 'Sabian' })
console.log(kat._isNew) // false

# model.getCAS(raw) ⇒ String | Object

Returns the document CAS value.

Kind: instance method of Model
Returns: String | Object - the CAS value

Example

console.log(doc.getCAS()) // String: 00000000a71626e4
console.log(doc.getCAS(true)) // Object: CouchbaseCas<11338961768815788032>

# model.save(options, replicate_to, fn)

Save the current model instance. Calls db set function for the model id and saves the properties.

Kind: instance method of Model

Example

var user = new User({ name: 'Bob Smith', email: 'bsmith@acme.com' })
user.save(function(err, savedDoc) {
  if(err) console.log(err)
})

# model.index(options, fn)

Update all lookup documents for this document instance. Creates new lookup documents for properties that have changed and deletes the old ones not needed any more.

Kind: instance method of Model

# model.remove(options, fn)

Removes the instance from the database. Calls the bucket remove() function. Options can be passed to the driver.

Kind: instance method of Model

Example

user.remove(function(err, doc) {
  if(err) console.log(err)
})

# model.removeIndexes(options, fn)

Removes all lookup / index documents for this document.

Kind: instance method of Model

# model.populate(options, fn)

Populates this instance given the options

Kind: instance method of Model

Example (Populate an instance)

User.findBy(userId, (err, user) {
  console.log(user.company) // ID
  user.populate((err, populatedUser) => {
    console.log(user.company) // full populated sub documnet
  })
})

Example (Populate a specific path within an instance)

User.findBy(userId, (err, user) {
  console.log(user.company) // ID
  user.populate('company', (err, populatedUser) => {
    console.log(user.company) // full populated sub documnet
  })
})

# model.getDocumentKeyValue(full) ⇒ String

Helper function to get the document key.

Kind: instance method of Model
Returns: String - document key
Access: public

Example

var schema = lounge.schema({ email: String }, { keyPrefix: 'user::'})
var User = lounge.model('User', schema)
var user = new User({ email: 'bsmith@acme.com' })
console.log(user.getDocumentKeyValue()) // 114477a8-1901-4146-8c90-0fc9eec57a58
console.log(user.getDocumentKeyValue(true)) // user::114477a8-1901-4146-8c90-0fc9eec57a58

# model.getDocumentKeyKey() ⇒ String

Gets the Document key property name.

Kind: instance method of Model
Returns: String - Document key property name
Access: public
Example

var schema = lounge.schema({ email: { type: String, key: true, generate: false }})
var User = lounge.model('User', schema)
var user = new User({ email: 'bsmith@acme.com' })
console.log(user.getDocumentKeyKey()) // email

# ModelInstance ⇐ Model

ModelInstance class is the compiled class from a schema definition. It extends Model. All models generated are an instance of ModelInstance. It also inherits grappling-hook See grappling-hook for pre and post hooks.

Kind: global class
Extends: Model

• ModelInstance ⇐ Model
  • new ModelInstance(data, options, cas)
  • instance
    • .cas ⇒ String
    • .db ⇒ Driver | null
    • .config ⇒ Object
    • .modelName : String
    • ._isNew : Boolean
    • .getCAS(raw) ⇒ String | Object
    • .save(options, replicate_to, fn)
    • .index(options, fn)
    • .remove(options, fn)
    • .removeIndexes(options, fn)
    • .populate(options, fn)
    • .getDocumentKeyValue(full) ⇒ String
    • .getDocumentKeyKey() ⇒ String
  • static
    • .schema
    • .modelName
    • .lounge
    • .config
    • .db

# new ModelInstance(data, options, cas)

This would be the constructor for the generated models.

# modelInstance.cas ⇒ String

Returns the string representation of CAS value.

Kind: instance property of ModelInstance
Overrides: cas
Example

console.log(doc.cas) // String: 00000000a71626e4

# modelInstance.db ⇒ Driver | null

Gets the database driver of the model

Kind: instance property of ModelInstance
Overrides: db

# modelInstance.config ⇒ Object

Gets the config object

Kind: instance property of ModelInstance
Overrides: config

# modelInstance.modelName : String

The name the name of the model. This is both a static and instance property.

Kind: instance property of ModelInstance
Overrides: modelName
Example

var schema = lounge.schema({ name: String })
var Cat = lounge.model('Cat', schema)
var kitty = new Cat({ name: 'Zildjian' })
console.log(Cat.modelName) // 'Cat'
console.log(kitty.modelName) // 'Cat'

# modelInstance._isNew : Boolean

Has a key been generated for this document.

Kind: instance property of ModelInstance
Overrides: _isNew
Example

var schema = lounge.schema({ name: String })
var Cat = lounge.model('Cat', schema)
var kitty = new Cat({ name: 'Zildjian' })
console.log(kitty._isNew) // true
var kat = new Cat({ id: '123abc', name: 'Sabian' })
console.log(kat._isNew) // false

# modelInstance.getCAS(raw) ⇒ String | Object

Returns the document CAS value.

Kind: instance method of ModelInstance
Overrides: getCAS
Returns: String | Object - the CAS value

Example

console.log(doc.getCAS()) // String: 00000000a71626e4
console.log(doc.getCAS(true)) // Object: CouchbaseCas<11338961768815788032>

# modelInstance.save(options, replicate_to, fn)

Save the current model instance. Calls db set function for the model id and saves the properties.

Kind: instance method of ModelInstance
Overrides: save

Example

var user = new User({ name: 'Bob Smith', email: 'bsmith@acme.com' })
user.save(function(err, savedDoc) {
  if(err) console.log(err)
})

# modelInstance.index(options, fn)

Update all lookup documents for this document instance. Creates new lookup documents for properties that have changed and deletes the old ones not needed any more.

Kind: instance method of ModelInstance
Overrides: index

# modelInstance.remove(options, fn)

Removes the instance from the database. Calls the bucket remove() function. Options can be passed to the driver.

Kind: instance method of ModelInstance
Overrides: remove

Example

user.remove(function(err, doc) {
  if(err) console.log(err)
})

# modelInstance.removeIndexes(options, fn)

Removes all lookup / index documents for this document.

Kind: instance method of ModelInstance
Overrides: removeIndexes

# modelInstance.populate(options, fn)

Populates this instance given the options

Kind: instance method of ModelInstance
Overrides: populate

Example (Populate an instance)

User.findBy(userId, (err, user) {
  console.log(user.company) // ID
  user.populate((err, populatedUser) => {
    console.log(user.company) // full populated sub documnet
  })
})

Example (Populate a specific path within an instance)

User.findBy(userId, (err, user) {
  console.log(user.company) // ID
  user.populate('company', (err, populatedUser) => {
    console.log(user.company) // full populated sub documnet
  })
})

# modelInstance.getDocumentKeyValue(full) ⇒ String

Helper function to get the document key.

Kind: instance method of ModelInstance
Overrides: getDocumentKeyValue
Returns: String - document key
Access: public

Example

var schema = lounge.schema({ email: String }, { keyPrefix: 'user::'})
var User = lounge.model('User', schema)
var user = new User({ email: 'bsmith@acme.com' })
console.log(user.getDocumentKeyValue()) // 114477a8-1901-4146-8c90-0fc9eec57a58
console.log(user.getDocumentKeyValue(true)) // user::114477a8-1901-4146-8c90-0fc9eec57a58

# modelInstance.getDocumentKeyKey() ⇒ String

Gets the Document key property name.

Kind: instance method of ModelInstance
Overrides: getDocumentKeyKey
Returns: String - Document key property name
Access: public
Example

var schema = lounge.schema({ email: { type: String, key: true, generate: false }})
var User = lounge.model('User', schema)
var user = new User({ email: 'bsmith@acme.com' })
console.log(user.getDocumentKeyKey()) // email

# ModelInstance.schema

Schema the schema of this model.

Kind: static property of ModelInstance

# ModelInstance.modelName

The name of the model.

Kind: static property of ModelInstance

# ModelInstance.lounge

The static lounge instance in the model

Kind: static property of ModelInstance

# ModelInstance.config

The config.

Kind: static property of ModelInstance

# ModelInstance.db

The driver.

Kind: static property of ModelInstance

# Schema

Schema class represents the schema definition. It includes properties, methods, static methods, and any middleware we want to define.

Kind: global class
Access: public

• Schema
  • new Schema(descriptor, options)
  • .index(prop, options)
  • .method(name, func)
  • .static(name, val)
  • .virtual(name, type, options)
  • .set(key, [value])
  • .get(key) ⇒ *
  • .pre()
  • .post()
  • .add(key, descriptor)
  • .extend(other)
  • .getDocumentKeyValue(id, full) ⇒ String
  • .getRefKey(name, v) ⇒ string
  • .hasRefPath(path) ⇒ boolean

# new Schema(descriptor, options)

Creates an object schema

Example

var schema = new lounge.Schema({ name: String })

Example (with <code>onBeforeValueSet</code>)

var User = lounge.schema({ name: String }, {
  onBeforeValueSet: function(key, value) {
    if(key === 'name' && value.indexOf('Joe') >= 0) {
      return false
    })
  }
})

var User = lounge.model('User', schema)
var user = new User()
user.name = 'Bill' // name not set
user.name = 'Joe Smith' //  { name: 'Joe Smith' }

# schema.index(prop, options)

Creates an index on the specified property.

Kind: instance method of Schema
Access: public

Example (Simple reference document)

var userSchema = lounge.schema({
  firstName: String,
  lastName: String,
  username: String
})

userSchema.index('username', { indexName: 'UserName' })
var User = lounge.model('User', userSchema)
// use User.findByUserName(username) to query

Example (Simple coumpund document)

var userSchema = lounge.schema({
  email: String,
  username: String
})

userSchema.index(['email', 'username'], { indexName: 'EmailAndUserName' })
var User = lounge.model('User', userSchema)
// use User.findByEmailAndUserName(email, username) to query

# schema.method(name, func)

Creates a instance method for the created model. An object of function names and functions can also be passed in.

Kind: instance method of Schema
Access: public

Example

var userSchema = lounge.schema({
  firstName: String,
  lastName: String
})

userSchema.method('getFullName', function () {
  return this.firstName + ' ' + this.lastName
})

var User = lounge.model('User', userSchema)
var user = new User({
  firstName: 'Joe',
  lastName: 'Smith'
})

console.log(user.getFullName()) // Joe Smith

# schema.static(name, val)

Creates a static function or property for the created model. An object of function or property names and functions or values can also be passed in.

Kind: instance method of Schema
Access: public

Example (Create a static function)

var userSchema = lounge.schema({ name: String })
userSchema.static('foo', function () {
  return 'bar'
})

var User = lounge.model('User', userSchema)
console.log(User.foo()) // 'bar'

Example (Create a static property)

var userSchema = lounge.schema({ name: String })
userSchema.static('FOO', 'bar')
var User = lounge.model('User', userSchema)
console.log(User.FOO) // 'bar'

# schema.virtual(name, type, options)

Creates a virtual property for the created model with the given object specifying the get and optionally set function

Kind: instance method of Schema
Access: public

Example

var userSchema = lounge.schema({firstName: String, lastName: String})

userSchema.virtual('fullName', String, {
  get: function () {
    return this.firstName + ' ' + this.lastName
  },
  set: function (v) {
    if (v !== undefined) {
      var parts = v.split(' ')
      this.firstName = parts[0]
      this.lastName = parts[1]
    }
  }
})

var User = lounge.model('User', userSchema)

var user = new User({firstName: 'Joe', lastName: 'Smith'})
console.log(user.fullName) // Joe Smith
user.fullName = 'Bill Jones'
console.log(user.firstName) // Bill
console.log(user.lastName) // Jones
console.log(user.fullName) // Bill Jones

# schema.set(key, [value])

Sets/gets a schema option.

Kind: instance method of Schema
Access: public

# schema.get(key) ⇒ *

Gets a schema option.

Kind: instance method of Schema
Returns: * - the option value
Access: public

# schema.pre()

Defines a pre hook for the schema. See grappling-hook.

Kind: instance method of Schema

# schema.post()

Defines a post hook for the schema. See grappling-hook.

Kind: instance method of Schema

# schema.add(key, descriptor)

Adds the descriptor to the schema at the given key. Or add an object as a descriptor.

Kind: instance method of Schema

Example

var userSchema = lounge.schema({firstName: String })
userSchema.add('lastName', String)
userSchema.add({ email: String })

# schema.extend(other)

Extends other schema. Copies descriptor properties, methods, statics, virtuals and middleware. If this schema has a named property already, the property is not copied.

Kind: instance method of Schema

# schema.getDocumentKeyValue(id, full) ⇒ String

Helper function to get the document key

Kind: instance method of Schema

Example

var schema = lounge.schema({ email: String }, {keyPrefix: 'user::' })
console.log(schema.getDocumentKeyValue('114477a8-1901-4146-8c90-0fc9eec57a58', true)) // user::114477a8-1901-4146-8c90-0fc9eec57a58
console.log(schema.getDocumentKeyValue('user::114477a8-1901-4146-8c90-0fc9eec57a58', true)) // user::114477a8-1901-4146-8c90-0fc9eec57a58
console.log(schema.getDocumentKeyValue('user::114477a8-1901-4146-8c90-0fc9eec57a58', false)) // 114477a8-1901-4146-8c90-0fc9eec57a58
console.log(schema.getDocumentKeyValue('114477a8-1901-4146-8c90-0fc9eec57a58', false)) // 114477a8-1901-4146-8c90-0fc9eec57a58

# schema.getRefKey(name, v) ⇒ string

Gets the reference document key value

Kind: instance method of Schema

# schema.hasRefPath(path) ⇒ boolean

Returns whether this schema has the specified reference path

Kind: instance method of Schema