verdnatura-mirror
/
loopback
mirror of https://github.com/strongloop/loopback.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove discover sugar apis

This commit is contained in:
Ritchie 2013-06-20 14:17:38 -07:00
parent e910a834a6
commit db7a86321b
2 changed files with 118 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

187
README.md
View File

@ -145,7 +145,7 @@ Validate the model instance.
Attach a model to a [DataSource](#data-source). Attaching a [DataSource](#data-source) updates the model with additional methods and behaviors. Attach a model to a [DataSource](#data-source). Attaching a [DataSource](#data-source) updates the model with additional methods and behaviors.
var oracle = asteroid.createDataSource({ var oracle = asteroid.createDataSource({
connector: require('asteroid-oracle'), connector: require('asteroid-connector-oracle'),
host: '111.22.333.44', host: '111.22.333.44',
database: 'MYDB', database: 'MYDB',
username: 'username', username: 'username',
@ -224,6 +224,8 @@ Update when record with id=data.id found, insert otherwise. **Note:** no setters
Define a static model method. Define a static model method.
User.login = function (username, password, fn) { User.login = function (username, password, fn) {
var passwordHash = hashPassword(password); var passwordHash = hashPassword(password);
this.findOne({username: username}, function (err, user) { this.findOne({username: username}, function (err, user) {
@ -243,7 +245,7 @@ Define a static model method.
}); });
} }
Setup the static model method to be exposed to clients as a [remote method](#remote-method). Setup the static model method to be exposed to clients as a [remote method](#remote-method).
asteroid.remoteMethod( asteroid.remoteMethod(
User.login, User.login,
@ -303,7 +305,7 @@ Define a remote model instance method.
#### Remote Methods #### Remote Methods
Both instance and static methods can be exposed to clients. A remote method must accept a callback with the conventional `fn(err, result, ...)` signature. Both instance and static methods can be exposed to clients. A remote method must accept a callback with the conventional `fn(err, result, ...)` signature.
##### asteroid.remoteMethod(fn, [options]); ##### asteroid.remoteMethod(fn, [options]);
@ -439,25 +441,29 @@ Define a "one to many" relationship.
Query and create the related models. Query and create the related models.
Book.create(function(err, book) { Book.create(function(err, book) {
// using 'chapters' scope for build: // create a chapter instance
var c = book.chapters.build({name: 'Chapter 1'}); // ready to be saved in the data source
var chapter = book.chapters.build({name: 'Chapter 1'});
// same as: // save the new chapter
c = new Chapter({name: 'Chapter 1', bookId: book.id}); chapter.save();
// using 'chapters' scope for create: // you can also call the Chapter.create method with
book.chapters.create(); // the `chapters` property which will build a chapter
// instance and save the it in the data source
// same as: book.chapters.create({name: 'Chapter 2'}, function(err, savedChapter) {
Chapter.create({bookId: book.id}); // this callback is optional
});
// using scope for querying: // query chapters for the book using the
book.chapters(function(err, chapters) { book.chapters(function(err, chapters) {
/* all chapters with bookId = book.id */ // all chapters with bookId = book.id
console.log(chapters);
}); });
book.chapters({where: {name: 'test'}, function(err, chapters) { book.chapters({where: {name: 'test'}, function(err, chapters) {
// all chapters with bookId = book.id and name = 'test' // all chapters with bookId = book.id and name = 'test'
console.log(chapters);
}); });
}); });
@ -468,7 +474,6 @@ TODO: implement / document
#### Shared Methods #### Shared Methods
Any static or instance method can be decorated as `shared`. These methods are exposed over the provided transport (eg. [asteroid.rest](#rest)). Any static or instance method can be decorated as `shared`. These methods are exposed over the provided transport (eg. [asteroid.rest](#rest)).
### Data Source ### Data Source
@ -490,28 +495,11 @@ Define a model and attach it to a `DataSource`.
var Color = oracle.createModel('color', {name: String}); var Color = oracle.createModel('color', {name: String});
#### dataSource.discoverAndBuildModels(owner, tableOrView, options, fn) #### dataSource.discoverModelDefinitions([username], fn)
Discover a set of models based on tables or collections in a data source. Discover a set of model definitions (table or collection names) based on tables or collections in a data source.
oracle.discoverAndBuildModels('MYORG', function(err, models) {
var ProductModel = models.Product;
});
**Note:** The `models` will contain all properties and options discovered from the data source. It will also automatically discover and create relationships.
#### dataSource.discoverAndBuildModelsSync(owner, tableOrView, options)
Synchronously Discover a set of models based on tables or collections in a data source. oracle.discoverModelDefinitions(function (err, models) {
var models = oracle.discoverAndBuildModelsSync('MYORG');
var ProductModel = models.Product;
#### dataSource.discoverModelDefinitions([owner], fn)
Discover a set of model definitions based on tables or collections in a data source.
oracle.discoverModelDefinitions(null, function (err, models) {
models.forEach(function (def) { models.forEach(function (def) {
// def.name ~ the model name // def.name ~ the model name
oracle.discoverSchema(null, def.name, function (err, schema) { oracle.discoverSchema(null, def.name, function (err, schema) {
@ -522,39 +510,100 @@ Discover a set of model definitions based on tables or collections in a data sou
#### dataSource.discoverSchema([owner], name, fn) #### dataSource.discoverSchema([owner], name, fn)
Discover the schema of a data source. Discover the schema of a specific table or collection.
#### dataSource.defineOperation(name, options, fn) **Example schema from oracle connector:**
Define a new operation available to all model's attached to the data source. {
"name": "Product",
var maps = asteroid.createDataSource({ "options": {
connector: require('asteroid-rest'), "idInjection": false,
url: 'http://api.googleapis.com/maps/api' "oracle": {
}); "schema": "BLACKPOOL",
"table": "PRODUCT"
rest.defineOperation('geocode', { }
url: '/geocode/json', },
verb: 'get', "properties": {
accepts: [ "id": {
{arg: 'address', type: 'string'}, "type": "String",
{arg: 'sensor', default: 'true'} "required": true,
], "length": 20,
returns: {arg: 'location', type: asteroid.GeoPoint, transform: transform}, "id": 1,
json: true, "oracle": {
enableRemote: true "columnName": "ID",
}); "dataType": "VARCHAR2",
"dataLength": 20,
function transform(res) { "nullable": "N"
var geo = res.body.results[0].geometry; }
return new asteroid.GeoPoint({lat: geo.lat, long: geo.lng}); },
"name": {
"type": "String",
"required": false,
"length": 64,
"oracle": {
"columnName": "NAME",
"dataType": "VARCHAR2",
"dataLength": 64,
"nullable": "Y"
}
},
"audibleRange": {
"type": "Number",
"required": false,
"length": 22,
"oracle": {
"columnName": "AUDIBLE_RANGE",
"dataType": "NUMBER",
"dataLength": 22,
"nullable": "Y"
}
},
"effectiveRange": {
"type": "Number",
"required": false,
"length": 22,
"oracle": {
"columnName": "EFFECTIVE_RANGE",
"dataType": "NUMBER",
"dataLength": 22,
"nullable": "Y"
}
},
"rounds": {
"type": "Number",
"required": false,
"length": 22,
"oracle": {
"columnName": "ROUNDS",
"dataType": "NUMBER",
"dataLength": 22,
"nullable": "Y"
}
},
"extras": {
"type": "String",
"required": false,
"length": 64,
"oracle": {
"columnName": "EXTRAS",
"dataType": "VARCHAR2",
"dataLength": 64,
"nullable": "Y"
}
},
"fireModes": {
"type": "String",
"required": false,
"length": 64,
"oracle": {
"columnName": "FIRE_MODES",
"dataType": "VARCHAR2",
"dataLength": 64,
"nullable": "Y"
}
}
}
} }
var GeoCoder = rest.createModel('geocoder');
GeoCoder.geocode('123 fake street', function(err, point) {
console.log(point.lat, point.long); // 24.224424 44.444445
});
#### dataSource.enableRemote(operation) #### dataSource.enableRemote(operation)
@ -568,7 +617,7 @@ Disable remote access to a data source operation. Each [connector](#connector) h
// all rest data source operations are // all rest data source operations are
// disabled by default // disabled by default
var oracle = asteroid.createDataSource({ var oracle = asteroid.createDataSource({
connector: require('asteroid-oracle'), connector: require('asteroid-connector-oracle'),
host: '...', host: '...',
... ...
}); });
@ -634,11 +683,11 @@ Include the connector in your package.json dependencies and run `npm install`.
{ {
"dependencies": { "dependencies": {
"asteroid-oracle": "latest" "asteroid-connector-oracle": "latest"
} }
} }
### GeoPoint ### GeoPoint TODO
Embed a latitude / longitude point in a [Model](#model). Embed a latitude / longitude point in a [Model](#model).
@ -696,7 +745,7 @@ Various APIs in Asteroid accept type descriptions (eg. [remote methods](#remote-
- `Array` - JSON array - `Array` - JSON array
- `Date` - a JavaScript date object - `Date` - a JavaScript date object
- `Buffer` - a node.js Buffer object - `Buffer` - a node.js Buffer object
- [GeoPoint](#geopoint) - an asteroid GeoPoint object. - [GeoPoint](#geopoint) - an asteroid GeoPoint object. TODO
### REST Router ### REST Router

47
test/data-source.test.js
View File

@ -34,53 +34,6 @@ describe('DataSource', function() {
}); });
}); });
// describe('dataSource.discover(options, fn)', function() {
// it("Discover an object containing properties and settings for an existing data source.", function(done) {
// /* example -
// oracle.discover({owner: 'MYORG'}, function(err, tables) {
// var productSchema = tables.PRODUCTS;
// var ProductModel = oracle.createModel('product', productSchema.properties, productSchema.settings);
// });
//
// */
// done(new Error('test not implemented'));
// });
// });
//
// describe('dataSource.discoverSync(options)', function() {
// it("Synchronously discover an object containing properties and settings for an existing data source tables or collections.", function(done) {
// /* example -
// var tables = oracle.discover({owner: 'MYORG'});
// var productSchema = tables.PRODUCTS;
// var ProductModel = oracle.createModel('product', productSchema.properties, productSchema.settings);
//
// */
// done(new Error('test not implemented'));
// });
// });
// describe('dataSource.discoverModels(options, fn) ', function() {
// it("Discover a set of models based on tables or collections in a data source.", function(done) {
// /* example -
// oracle.discoverModels({owner: 'MYORG'}, function(err, models) {
// var ProductModel = models.Product;
// });
//
// */
// done(new Error('test not implemented'));
// });
// });
//
// describe('dataSource.discoverModelsSync(options)', function() {
// it("Synchronously Discover a set of models based on tables or collections in a data source.", function(done) {
// /* example -
// var models = oracle.discoverModels({owner: 'MYORG'});
// var ProductModel = models.Product;
// */
// done(new Error('test not implemented'));
// });
// });
describe('dataSource.operations()', function() { describe('dataSource.operations()', function() {
it("List the enabled and disabled operations.", function() { it("List the enabled and disabled operations.", function() {
// assert the defaults // assert the defaults