new (require("datastore/dataset"))(optionsopt)
+ + +Intract with a dataset from the +Google Cloud Datastore.
+Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
+
+
+ + + +object + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Properties+ + +
|
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Example
+ +var dataset = new datastore.Dataset({
+ projectId: 'my-project',
+ keyFilename: '/path/to/keyfile.json'
+});-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Methods
+ +-
+
+
-
+
allocateIds(incompleteKey, n, callback)
+ + +
+ -
+
+
+ ++ + + + + + + +
Generate IDs without creating entities.
+Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +incompleteKey+ + +Key + + + + + + + + + +The key object to complete.
+ + + + + +n+ + +number + + + + + + + + + +How many IDs to generate.
+ + + + + +callback+ + +function + + + + + + + + + +The callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Example
+ +
+ + +// The following call will create 100 new IDs from the Company kind, which +// exists under the default namespace. +var incompleteKey = datastore.key('Company', null); +dataset.allocateIds(incompleteKey, 100, function(err, keys) {}); + +// You may prefer to create IDs from a non-default namespace by providing an +// incomplete key with a namespace. Similar to the previous example, the call +// below will create 100 new IDs, but from the Company kind that exists under +// the "ns-test" namespace. +var incompleteKey = datastore.key('ns-test', 'Company', null); +dataset.allocateIds(incompleteKey, 100, function(err, keys) {});
+
+
+
+ -
+
createQuery(namespaceopt, kinds) → {module:datastore/query}
+ + +
+ -
+
+
+ ++ + + + + + + +
Create a query from the current dataset to query the specified kinds, scoped +to the namespace provided at the initialization of the dataset.
+Dataset query reference: http://goo.gl/Cag0r6
+Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +namespace+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +Optional namespace.
+ + + + + +kinds+ + +string +| + +array + + + + + + ++ + + + + + + + + + +Kinds to query.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
-
+
-
+
- {module:datastore/query} +
+
+
+
+
Returns:
+ + + + +-
+
- + Type + +
- + +module:datastore/query + + + +
+
+
+
+ -
+
delete(key, callback)
+ + +
+ -
+
+
+ ++ + + + + + + +
Delete all entities identified with the specified key(s) in the current +transaction.
+Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +key+ + +Key +| + +Array.<Key> + + + + + + + + + +Datastore key object(s).
+ + + + + +callback+ + +function + + + + + + + + + +The callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Example
+ +
+ + +// 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) {});
+
+
+
+ -
+
get(key, callback)
+ + +
+ -
+
+
+ ++ + + + + + + +
Retrieve the entities identified with the specified key(s) in the current +transaction. Get operations require a valid key to retrieve the +key-identified entity from Datastore.
+Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +key+ + +module:datastore/entity~Key +| + +Array.<module:datastore/entity~Key> + + + + + + + + + +Datastore key object(s).
+ + + + + +callback+ + +function + + + + + + + + + +The callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Example
+ +
+ + +dataset.get([ + datastore.key('Company', 123), + datastore.key('Product', 'Computer') +], function(err, entities) {});
+
+
+
+ -
+
key()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Helper to create a Key object, scoped to the dataset's namespace by default.
+You may also specify a configuration object to define a namespace and path.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Example
+ +
+ + +var key; + +// Create a key from the dataset's namespace. +key = dataset.key('Company', 123); + +// Create a key from a provided namespace and path. +key = dataset.key({ + namespace: 'My-NS', + path: ['Company', 123] +});
+
+
+
+ -
+
runInTransaction(fn, callback)
+ + +
+ -
+
+
+ ++ + + + + + + +
Run a function in the context of a new transaction. Transactions allow you to +perform multiple operations, committing your changes atomically.
+Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +fn+ + +function + + + + + + + + + +The function to run in the context of a transaction.
+ + + + + +callback+ + +function + + + + + + + + + +The callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Example
+ +
+ + +dataset.transaction(function(transaction, done) { + // From the `transaction` object, execute dataset methods as usual. + // Call `done` when you're ready to commit all of the changes. + transaction.get(datastore.key('Company', 123), function(err, entity) { + if (err) { + transaction.rollback(done); + return; + } + + done(); + }); +}, function(err) {});
+
+
+
+ -
+
runQuery(query, callback)
+ + +
+ -
+
+
+ ++ + + + + + + +
Datastore allows you to query entities by kind, filter them by property +filters, and sort them by a property name. Projection and pagination are also +supported. If more results are available, a query to retrieve the next page +is provided to the callback function.
+Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +query+ + +module:datastore/query + + + + + + + + + +Query object.
+ + + + + +callback+ + +function + + + + + + + + + +The callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Example
+ +
+ + +// 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) {}); + } +});
+
+
+
+ -
+
save(entities, callback)
+ + +
+ -
+
+
+ ++ + + + + + + +
Insert or update the specified object(s) in the current transaction. If a +key is incomplete, its associated object is inserted and its generated +identifier is returned to the callback.
+Parameters:
+ + ++ +
+ + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +entities+ + +object +| + +Array.<object> + + + + + + + + + +Datastore key object(s).
+Properties
+ + ++ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +key+ + +Key + + + + + + + + + +Datastore key object.
+ + + + + +data+ + +object + + + + + + + + + +Data to save with the provided key.
+ + + + + +callback+ + +function + + + + + + + + + +The callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Example
+ +
+ + +// 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) {});
+
+