diff --git a/lib/datastore/dataset.js b/lib/datastore/dataset.js index 530e94223e4..4a8027df1e9 100644 --- a/lib/datastore/dataset.js +++ b/lib/datastore/dataset.js @@ -103,6 +103,14 @@ Dataset.prototype.createQuery = function(ns, kinds) { /** * @borrows {module:datastore/transaction#get} as get + * + * @example + * ```js + * dataset.get([ + * datastore.key('Company', 123), + * datastore.key('Product', 'Computer') + * ], function(err, entities) {}); + * ``` */ Dataset.prototype.get = function(key, callback) { this.transaction.get(key, callback); @@ -110,6 +118,36 @@ Dataset.prototype.get = function(key, callback) { /** * @borrows {module:datastore/transaction#save} as save + * + * @example + * ```js + * // Save a single entity. + * dataset.save({ + * key: datastore.key('Company', null), + * data: { + * rating: '10' + * } + * }, function(err, key) { + * // Because we gave an incomplete key as an argument, `key` will be + * // populated with the complete, generated key. + * }); + * + * // Save multiple entities at once. + * dataset.save([ + * { + * key: datastore.key('Company', 123), + * data: { + * HQ: 'Dallas, TX' + * } + * }, + * { + * key: datastore.key('Product', 'Computer'), + * data: { + * vendor: 'Dell' + * } + * } + * ], function(err, keys) {}); + * ``` */ Dataset.prototype.save = function(key, obj, callback) { this.transaction.save(key, obj, callback); @@ -117,6 +155,18 @@ Dataset.prototype.save = function(key, obj, callback) { /** * @borrows {module:datastore/transaction#delete} as delete + * + * @example + * ```js + * // Delete a single entity. + * dataset.delete(datastore.key('Company', 123), function(err) {}); + * + * // Delete multiple entities at once. + * dataset.delete([ + * datastore.key('Company', 123), + * datastore.key('Product', 'Computer') + * ], function(err) {}); + * ``` */ Dataset.prototype.delete = function(key, callback) { this.transaction.delete(key, callback); @@ -124,6 +174,17 @@ Dataset.prototype.delete = function(key, callback) { /** * @borrows {module:datastore/transaction#runQuery} as runQuery + * + * @example + * ```js + * // Retrieve 5 companies. + * dataset.runQuery(queryObject, function(err, entities, nextQuery) { + * // `nextQuery` is not null if there are more results. + * if (nextQuery) { + * dataset.runQuery(nextQuery, function(err, entities, nextQuery) {}); + * } + * }); + * ``` */ Dataset.prototype.runQuery = function(q, callback) { this.transaction.runQuery(q, callback); diff --git a/lib/datastore/transaction.js b/lib/datastore/transaction.js index 83065ed5038..7876d7be6a2 100644 --- a/lib/datastore/transaction.js +++ b/lib/datastore/transaction.js @@ -366,7 +366,7 @@ Transaction.prototype.delete = function(keys, callback) { * transaction.runQuery(queryObject, function(err, entities, nextQuery) { * // `nextQuery` is not null if there are more results. * if (nextQuery) { - * dataset.runQuery(nextQuery, function(err, entities, nextQuery) {}); + * transaction.runQuery(nextQuery, function(err, entities, nextQuery) {}); * } * }); * ```