Skip to content
This repository has been archived by the owner on Aug 13, 2021. It is now read-only.

Commit

Permalink
Passed in the collection arg.
Browse files Browse the repository at this point in the history
  • Loading branch information
@mikermcneil
mikermcneil committed May 12, 2013
1 parent e3fd131 commit 3468fb2
Show file tree
Hide file tree
Showing 2 changed files with 116 additions and 122 deletions.
234 changes: 113 additions & 121 deletions index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,149 +5,147 @@

var async = require('async');

module.exports = (function() {

var adapter = {

// Set to true if this adapter supports (or requires) things like data types, validations, keys, etc.
// If true, the schema for models using this adapter will be automatically synced when the server starts.
// Not terribly relevant if not using a non-SQL / non-schema-ed data store
syncable: false,

// Including a commitLog config enables transactions in this adapter
// Please note that these are not ACID-compliant transactions:
// They guarantee *ISOLATION*, and use a configurable persistent store, so they are *DURABLE* in the face of server crashes.
// However there is no scheduled task that rebuild state from a mid-step commit log at server start, so they're not CONSISTENT yet.
// and there is still lots of work to do as far as making them ATOMIC (they're not undoable right now)
var adapter = module.exports = {

// Set to true if this adapter supports (or requires) things like data types, validations, keys, etc.
// If true, the schema for models using this adapter will be automatically synced when the server starts.
// Not terribly relevant if not using a non-SQL / non-schema-ed data store
syncable: false,

// Including a commitLog config enables transactions in this adapter
// Please note that these are not ACID-compliant transactions:
// They guarantee *ISOLATION*, and use a configurable persistent store, so they are *DURABLE* in the face of server crashes.
// However there is no scheduled task that rebuild state from a mid-step commit log at server start, so they're not CONSISTENT yet.
// and there is still lots of work to do as far as making them ATOMIC (they're not undoable right now)
//
// However, for the immediate future, they do a great job of preventing race conditions, and are
// better than a naive solution. They add the most value in findOrCreate() and createEach().
//
// commitLog: {
// identity: '__default_mongo_transaction',
// adapter: 'sails-mongo'
// },

// Default configuration for collections
// (same effect as if these properties were included at the top level of the model definitions)
defaults: {

// For example:
// port: 3306,
// host: 'localhost'

// If setting syncable, you should consider the migrate option,
// which allows you to set how the sync will be performed.
// It can be overridden globally in an app (config/adapters.js) and on a per-model basis.
//
// However, for the immediate future, they do a great job of preventing race conditions, and are
// better than a naive solution. They add the most value in findOrCreate() and createEach().
//
// commitLog: {
// identity: '__default_mongo_transaction',
// adapter: 'sails-mongo'
// },

// Default configuration for collections
// (same effect as if these properties were included at the top level of the model definitions)
defaults: {

// For example:
// port: 3306,
// host: 'localhost'

// If setting syncable, you should consider the migrate option,
// which allows you to set how the sync will be performed.
// It can be overridden globally in an app (config/adapters.js) and on a per-model basis.
//
// drop => Drop schema and data, then recreate it
// alter => Drop/add columns as necessary, but try
// safe => Don't change anything (good for production DBs)
migrate: 'alter'
},
// drop => Drop schema and data, then recreate it
// alter => Drop/add columns as necessary, but try
// safe => Don't change anything (good for production DBs)
migrate: 'alter'
},

// This method runs when a model is initially registered at server start time
registerCollection: function(collection, cb) {
// This method runs when a model is initially registered at server start time
registerCollection: function(collection, cb) {

cb();
},
cb();
},


// The following methods are optional
////////////////////////////////////////////////////////////
// The following methods are optional
////////////////////////////////////////////////////////////

// Optional hook fired when a model is unregistered, typically at server halt
// useful for tearing down remaining open connections, etc.
teardown: function(cb) {
cb();
},
// Optional hook fired when a model is unregistered, typically at server halt
// useful for tearing down remaining open connections, etc.
teardown: function(cb) {
cb();
},


// REQUIRED method if integrating with a schemaful database
define: function(collectionName, definition, cb) {
// REQUIRED method if integrating with a schemaful database
define: function(collectionName, definition, cb) {

// Define a new "table" or "collection" schema in the data store
cb();
},
// REQUIRED method if integrating with a schemaful database
describe: function(collectionName, cb) {
// Define a new "table" or "collection" schema in the data store
cb();
},
// REQUIRED method if integrating with a schemaful database
describe: function(collectionName, cb) {

// Respond with the schema (attributes) for a collection or table in the data store
var attributes = {};
cb(null, attributes);
},
// REQUIRED method if integrating with a schemaful database
drop: function(collectionName, cb) {
// Drop a "table" or "collection" schema from the data store
cb();
},
// Respond with the schema (attributes) for a collection or table in the data store
var attributes = {};
cb(null, attributes);
},
// REQUIRED method if integrating with a schemaful database
drop: function(collectionName, cb) {
// Drop a "table" or "collection" schema from the data store
cb();
},

// Optional override of built-in alter logic
// Can be simulated with describe(), define(), and drop(),
// but will probably be made much more efficient by an override here
// alter: function (collectionName, attributes, cb) {
// Modify the schema of a table or collection in the data store
// cb();
// },
// Optional override of built-in alter logic
// Can be simulated with describe(), define(), and drop(),
// but will probably be made much more efficient by an override here
// alter: function (collectionName, attributes, cb) {
// Modify the schema of a table or collection in the data store
// cb();
// },


// REQUIRED method if users expect to call Model.create() or any methods
create: function(collectionName, values, cb) {
// Create a single new model specified by values
// REQUIRED method if users expect to call Model.create() or any methods
create: function(collectionName, values, cb) {
// Create a single new model specified by values

// Respond with error or newly created model instance
cb(null, values);
},
// Respond with error or newly created model instance
cb(null, values);
},

// REQUIRED method if users expect to call Model.find(), Model.findAll() or related methods
// You're actually supporting find(), findAll(), and other methods here
// but the core will take care of supporting all the different usages.
// (e.g. if this is a find(), not a findAll(), it will only send back a single model)
find: function(collectionName, options, cb) {
// REQUIRED method if users expect to call Model.find(), Model.findAll() or related methods
// You're actually supporting find(), findAll(), and other methods here
// but the core will take care of supporting all the different usages.
// (e.g. if this is a find(), not a findAll(), it will only send back a single model)
find: function(collectionName, options, cb) {

// ** Filter by criteria in options to generate result set
// ** Filter by criteria in options to generate result set

// Respond with an error or a *list* of models in result set
cb(null, []);
},
// Respond with an error or a *list* of models in result set
cb(null, []);
},

// REQUIRED method if users expect to call Model.update()
update: function(collectionName, options, values, cb) {
// REQUIRED method if users expect to call Model.update()
update: function(collectionName, options, values, cb) {

// ** Filter by criteria in options to generate result set
// ** Filter by criteria in options to generate result set

// Then update all model(s) in the result set
// Then update all model(s) in the result set

// Respond with error or a *list* of models that were updated
cb();
},
// Respond with error or a *list* of models that were updated
cb();
},

// REQUIRED method if users expect to call Model.destroy()
destroy: function(collectionName, options, cb) {
// REQUIRED method if users expect to call Model.destroy()
destroy: function(collectionName, options, cb) {

// ** Filter by criteria in options to generate result set
// ** Filter by criteria in options to generate result set

// Destroy all model(s) in the result set
// Destroy all model(s) in the result set

// Return an error or nothing at all
cb();
},
// Return an error or nothing at all
cb();
},



// REQUIRED method if users expect to call Model.stream()
stream: function(collectionName, options, stream) {
// options is a standard criteria/options object (like in find)
// REQUIRED method if users expect to call Model.stream()
stream: function(collectionName, options, stream) {
// options is a standard criteria/options object (like in find)

// stream.write() and stream.end() should be called.
// for an example, check out:
// https://github.com/balderdashy/sails-dirty/blob/master/DirtyAdapter.js#L247
// stream.write() and stream.end() should be called.
// for an example, check out:
// https://github.com/balderdashy/sails-dirty/blob/master/DirtyAdapter.js#L247

}
}



/*
/*
**********************************************
* Optional overrides
**********************************************
Expand All @@ -166,7 +164,7 @@ module.exports = (function() {
*/


/*
/*
**********************************************
* Custom methods
**********************************************
Expand Down Expand Up @@ -218,14 +216,8 @@ module.exports = (function() {
*/


};

return adapter;

////////////// //////////////////////////////////////////
////////////// Private Methods //////////////////////////////////////////
////////////// //////////////////////////////////////////


};

})();
////////////// //////////////////////////////////////////
////////////// Private Methods //////////////////////////////////////////
////////////// //////////////////////////////////////////
4 changes: 3 additions & 1 deletion test/register.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ describe('registerCollection', function () {

it('should not hang or encounter any errors', function (cb) {
var adapter = require('../index.js');
adapter.registerCollection(cb);
adapter.registerCollection({
identity: 'foo'
}, cb);
});

// e.g.
Expand Down

0 comments on commit 3468fb2

Please sign in to comment.