-
Notifications
You must be signed in to change notification settings - Fork 399
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Table.select method with filtering by formula support
Example: // The params object specifies the query options. // All parameters are optional. var params = { fields: ['Name', 'Days', 'Country'], // only return these fields. filterByFormula: 'Days > 3', // return records that satisfy formula. maxRecords: 10, // at most 10 records in total. pageSize: 5, // at most 5 records per request. sort: [{field: 'Name', direction: 'asc'}], view: 'Main View', // can return records from a specific view. }; var query = base('Table 1').select(params); // If you're only interested in the first page of // results, you can use `firstPage`: query.firstPage(function(error, records) { // 'records' contains the records for the first page of results. }); // If you want all results, you can page through them // using `eachPage`. query.eachPage(function(records, nextPage) { // 'records' contains the records for the current page. // call nextPage() to fetch the next page of records. // If there are more records to fetch, this function // will get called again. Otherwise, the `done` function // will get called. }, function done(error) { // Called if there's an error, or after all // records have been fetched (in this case, the // error parameter will be null). }); This commit deprecates Table.list and Table.forEach.
- Loading branch information
Kasra Kyanzadeh
committed
Jan 29, 2016
1 parent
01ddac6
commit 08e6e76
Showing
8 changed files
with
267 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
var didWarnForDeprecation = {}; | ||
|
||
/** | ||
* Convenience function for marking a function as deprecated. | ||
* | ||
* Will emit a warning the first time that function is called. | ||
* | ||
* @param fn the function to mark as deprecated. | ||
* @param key a unique key identifying the function. | ||
* @param message the warning message. | ||
* | ||
* @return a wrapped function | ||
*/ | ||
function deprecate(fn, key, message) { | ||
return function() { | ||
if (!didWarnForDeprecation[key]) { | ||
didWarnForDeprecation[key] = true; | ||
console.warn(message); | ||
} | ||
fn.apply(this, arguments); | ||
}; | ||
} | ||
|
||
module.exports = deprecate; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
'use strict'; | ||
|
||
var assert = require('assert'); | ||
var _ = require('lodash'); | ||
|
||
var check = require('./typecheck'); | ||
var Class = require('./class'); | ||
var Record = require('./record'); | ||
|
||
var Query = Class.extend({ | ||
/** | ||
* Builds a query object. Won't fetch until `firstPage` or | ||
* or `eachPage` is called. | ||
*/ | ||
init: function(table, params) { | ||
assert(_.isPlainObject(params)); | ||
_.each(params, function(value, key) { | ||
assert(Query.paramValidators[key] && Query.paramValidators[key](value).pass, 'Invalid parameter for Query: ' + key); | ||
}); | ||
|
||
this._table = table; | ||
this._params = params; | ||
}, | ||
|
||
/** | ||
* Fetches the first page of results for the query asynchronously, | ||
* then calls `done(error, records)`. | ||
*/ | ||
firstPage: function(done) { | ||
assert(_.isFunction(done), | ||
'The first parameter to `firstPage` must be a function'); | ||
|
||
this.eachPage(function(records, fetchNextPage) { | ||
done(null, records); | ||
}, function(error) { | ||
done(error, null); | ||
}); | ||
}, | ||
|
||
/** | ||
* Fetches each page of results for the query asynchronously. | ||
* | ||
* Calls `pageCallback(records, fetchNextPage)` for each | ||
* page. You must call `fetchNextPage()` to fetch the next page of | ||
* results. | ||
* | ||
* After fetching all pages, or if there's an error, calls | ||
* `done(error)`. | ||
*/ | ||
eachPage: function(pageCallback, done) { | ||
assert(_.isFunction(pageCallback), | ||
'The first parameter to `eachPage` must be a function'); | ||
|
||
assert(_.isFunction(done) || _.isUndefined(done), | ||
'The second parameter to `eachPage` must be a function or undefined'); | ||
|
||
var that = this; | ||
var path = '/' + this._table._urlEncodedNameOrId(); | ||
var params = _.clone(this._params); | ||
|
||
var inner = function() { | ||
that._table._base.runAction('get', path, params, {}, function(err, response, result) { | ||
if (err) { | ||
done(err, null); | ||
} else { | ||
var next; | ||
if (result.offset) { | ||
params.offset = result.offset; | ||
next = inner; | ||
} else { | ||
next = function() { | ||
if (done) { | ||
done(null); | ||
} | ||
}; | ||
} | ||
|
||
var records = _.map(result.records, function(recordJson) { | ||
return new Record(that, null, recordJson); | ||
}); | ||
|
||
pageCallback(records, next); | ||
} | ||
}); | ||
}; | ||
|
||
inner(); | ||
}, | ||
}); | ||
|
||
Query.paramValidators = { | ||
fields: | ||
check(check.isArrayOf(_.isString), 'the value for `fields` should be an array of strings'), | ||
|
||
filterByFormula: | ||
check(_.isString, 'the value for `filterByFormula` should be a string'), | ||
|
||
maxRecords: | ||
check(_.isNumber, 'the value for `maxRecords` should be a number'), | ||
|
||
pageSize: | ||
check(_.isNumber, 'the value for `pageSize` should be a number'), | ||
|
||
sort: | ||
check(check.isArrayOf(function(obj) { | ||
return ( | ||
_.isPlainObject(obj) && | ||
_.isString(obj.field) && | ||
(_.isUndefined(obj.direction) || _.contains(['asc', 'desc'], obj.direction)) | ||
); | ||
}), 'the value for `sort` should be an array of sort objects. ' + | ||
'Each sort object must have a string `field` value, and an optional ' + | ||
'`direction` value that is "asc" or "desc".' | ||
), | ||
|
||
view: | ||
check(_.isString, 'the value for `view` should be a string'), | ||
}; | ||
|
||
/** | ||
* Validates the parameters for passing to the Query constructor. | ||
* | ||
* @return an object with two keys: | ||
* validParams: the object that should be passed to the constructor. | ||
* ignoredKeys: a list of keys that will be ignored. | ||
* errors: a list of error messages. | ||
*/ | ||
Query.validateParams = function validateParams(params) { | ||
assert(_.isPlainObject(params)); | ||
|
||
var validParams = {}; | ||
var ignoredKeys = []; | ||
var errors = []; | ||
_.each(params, function(value, key) { | ||
if (Query.paramValidators.hasOwnProperty(key)) { | ||
var validator = Query.paramValidators[key]; | ||
var validationResult = validator(value); | ||
if (validationResult.pass) { | ||
validParams[key] = value; | ||
} else { | ||
errors.push(validationResult.error); | ||
} | ||
} else { | ||
ignoredKeys.push(key); | ||
} | ||
}); | ||
|
||
return { | ||
validParams: validParams, | ||
ignoredKeys: ignoredKeys, | ||
errors: errors, | ||
}; | ||
}; | ||
|
||
module.exports = Query; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
var _ = require('lodash'); | ||
|
||
function check(fn, error) { | ||
return function(value) { | ||
if (fn(value)) { | ||
return {pass: true}; | ||
} else { | ||
return {pass: false, error: error}; | ||
} | ||
}; | ||
} | ||
|
||
check.isOneOf = function isOneOf(options) { | ||
return _.contains.bind(this, options); | ||
}; | ||
|
||
check.isArrayOf = function(itemValidator) { | ||
return function(value) { | ||
return _.isArray(value) && _.every(value, itemValidator); | ||
}; | ||
}; | ||
|
||
module.exports = check; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters