Stay organized with collections Save and categorize content based on your preferences.
Build a Datastore Key object.
Package@google-cloud/datastore Examples
//-
// Create an incomplete key with a kind value of `Company`.
//-
const {Datastore} = require('@google-cloud/datastore');
const datastore = new Datastore();
const key = datastore.key('Company');
//-
// Create a complete key with a kind value of `Company` and id`123`.
//-
const {Datastore} = require('@google-cloud/datastore');
const datastore = new Datastore();
const key = datastore.key(['Company', 123]);
//-
// If the ID integer is outside the bounds of a JavaScript Number
// object, create an Int.
//-
const {Datastore} = require('@google-cloud/datastore');
const datastore = new Datastore();
const key = datastore.key([
'Company',
datastore.int('100000000000001234')
]);
const {Datastore} = require('@google-cloud/datastore');
const datastore = new Datastore();
// Create a complete key with a kind value of `Company` and name `Google`.
// Note: `id` is used for numeric identifiers and `name` is used otherwise.
const key = datastore.key(['Company', 'Google']);
//-
// Create a complete key from a provided namespace and path.
//-
const {Datastore} = require('@google-cloud/datastore');
const datastore = new Datastore();
const key = datastore.key({
namespace: 'My-NS',
path: ['Company', 123]
});
Serialize the key for later re-use.
const {Datastore} = require('@google-cloud/datastore');
const datastore = new Datastore();
const key = datastore.key({
namespace: 'My-NS',
path: ['Company', 123]
});
// Later...
const key = datastore.key(key.serialized);
Constructors (constructor)(options)
constructor(options: KeyOptions);
Constructs a new instance of the Key
class
options
entity.KeyOptions
path: Array<string | number>;
serialized
get serialized(): {
namespace: string | undefined;
path: (string | Int)[];
};
Access the serialized
property for a library-compatible way to re-use a key.
const key = datastore.key({
namespace: 'My-NS',
path: ['Company', 123]
});
// Later...
const key = datastore.key(key.serialized);
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4