gstore-node
v8.x
v8.x
  • Introduction
  • Getting Started
    • Motivation
    • Installation
    • Create a gstore instance
  • Schema
    • About
    • Type validation
    • Value validation
    • Additional properties settings
    • Schema options
    • Joi Schema
    • Methods
      • path()
      • virtual()
    • Custom methods
  • Model
    • Creation
    • Methods
      • GET
      • UPDATE
      • DELETE
      • excludeFromIndexes()
      • key()
      • sanitize()
      • clearCache()
  • Entity
    • Creation
    • Properties
    • Methods
      • SAVE
      • plain()
      • populate()
      • model()
      • datastoreEntity()
      • validate()
  • Queries
    • @google-cloud Query
    • list()
    • findOne()
    • deleteAll()
    • findAround()
  • Populate
  • Middleware (hooks)
    • About
    • Pre hooks
    • Post hooks
  • Cache / Dataloader
    • Dataloader
    • Cache
  • gstore Methods
    • save()
  • Typescript
  • Appendix
    • Error Codes
    • Credits
Powered by GitBook
On this page

Was this helpful?

  1. Entity
  2. Methods

plain()

PreviousSAVENextpopulate()

Last updated 6 years ago

Was this helpful?

This methods returns the entity data and its entity key id (int or string)

It accepts one optional options argument

entity.plain({
    readAll: true|false,
    virtuals: true|false,
    showKey: true|false,
}):

options

  • readAll (default: false)

Outputs all the data properties, regardless of the schema "read" parameter.

  • virtuals (default: false)

Adds the schema "virtuals" to the output. (see: )

  • showKey(default: false)

Adds a "__key" property to the entity data with the complete Key from the Datastore.

schema virtuals