gcloud-datastore-schema

gcloud-datastore-schema

Define and follow a schema for your Datastore entities

$ npm install --save gcloud-datastore-schema

var gcloud = require('gcloud');
var schema = require('gcloud-datastore-schema');

var datastore = schema(gcloud.datastore({/*...*/}));

// New method: register
datastore.register('Person', {
  // Native JavaScript types
  name: String,
  age: Number,
  tools: Array,
  favoriteNumbers: [Number],
  isPremiumUser: Boolean,

  // Datastore types
  gpa: gcloud.datastore.double,

  // Nested schemas
  address: {
    streetNumber: Number,
    streetName: String,
    // Nested nested schemas
    zip: {
      firstPart: Number,
      secondPart: Number
    }
  },

  // Nested array schemas
  phoneNumbers: [
    {
      number: String,
      metadata: {
        type: String,
        // Nested nested array schemas
        availability: [
          String
        ]
      }
    }
  ],

  // Custom validators
  fullName: function (input) {
    return input.split(' ').length > 1;
  }
});

// The original save method will now validate by default
// So let's make it mad
datastore.save({
  key: datastore.key(['Person']),
  data: {
    name: 'Doc',
    age: 8,
    tools: ['Stethoscope', 'Positive attitude'],
    favoriteNumbers: [16, 91],
    gpa: gcloud.datastore.int(4.0),
    address: {
      streetNumber: 123,
      streetName: 'Main',
      zip: {
        firstPart: 12345,
        secondPart: 4444
      }
    },
    phoneNumbers: [
      {
        number: '555-1212',
        metadata: {
          availability: [
            '9-5',
            95
          ]
        }
      }
    ],
    fullName: 'Doc',
    extraData: true,
    extraExtraData: false
  }
}, function (err) {
  // err:
  // {
  //   code: 'ESCHEMAVIOLATION',
  //   message: 'Schema validation failed',
  //   errors: [
  //     {
  //       kind: 'Person',
  //       errors: [
  //         'Schema definition expected property: "isPremiumUser"',
  //         'Schema definition violated for property: "gpa". Expected type: Double, received: Int',
  //         'Schema definition expected property: "phoneNumbers[].metadata.type"',
  //         'Schema definition violated for property: "phoneNumbers[].metadata.availability[].availability". Expected type: String, received: 95',
  //         'Schema definition violated for property: "fullName"',
  //         'Unexpected properties found: "extraData", "extraExtraData"'
  //       ]
  //     }
  //   ]
  // }
})

API Documentation

Coming soon, sorry. For now, please use the above example as a guide.