//-// Create an incomplete key with a kind value of `Company`.//-const{Datastore}=require('@google-cloud/datastore');constdatastore=newDatastore();constkey=datastore.key('Company');
//-// Create a complete key with a kind value of `Company` and id`123`.//-const{Datastore}=require('@google-cloud/datastore');constdatastore=newDatastore();constkey=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');constdatastore=newDatastore();constkey=datastore.key(['Company',datastore.int('100000000000001234')]);
const{Datastore}=require('@google-cloud/datastore');constdatastore=newDatastore();// 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.constkey=datastore.key(['Company','Google']);
//-// Create a complete key from a provided namespace and path.//-const{Datastore}=require('@google-cloud/datastore');constdatastore=newDatastore();constkey=datastore.key({namespace:'My-NS',path:['Company',123]});
[[["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-09-04 UTC."],[],[],null,["# Class Key (9.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [9.1.0 (latest)](/nodejs/docs/reference/datastore/latest/datastore/key)\n- [8.7.0](/nodejs/docs/reference/datastore/8.7.0/datastore/key)\n- [8.6.0](/nodejs/docs/reference/datastore/8.6.0/datastore/key)\n- [8.5.0](/nodejs/docs/reference/datastore/8.5.0/datastore/key)\n- [8.4.0](/nodejs/docs/reference/datastore/8.4.0/datastore/key)\n- [8.3.0](/nodejs/docs/reference/datastore/8.3.0/datastore/key)\n- [8.2.2](/nodejs/docs/reference/datastore/8.2.2/datastore/key)\n- [8.1.0](/nodejs/docs/reference/datastore/8.1.0/datastore/key)\n- [8.0.0](/nodejs/docs/reference/datastore/8.0.0/datastore/key)\n- [6.6.2](/nodejs/docs/reference/datastore/6.6.2/datastore/key)\n- [6.5.0](/nodejs/docs/reference/datastore/6.5.0/datastore/key)\n- [6.4.8](/nodejs/docs/reference/datastore/6.4.8/datastore/key)\n- [6.3.1](/nodejs/docs/reference/datastore/6.3.1/datastore/key) \nBuild a Datastore Key object.\n\nPackage\n-------\n\n[@google-cloud/datastore](../overview.html)\n\nExamples\n--------\n\n\n //-\n // Create an incomplete key with a kind value of `Company`.\n //-\n const {Datastore} = require('https://cloud.google.com/nodejs/docs/reference/datastore/latest/overview.html');\n const datastore = new https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html();\n const key = datastore.https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html('Company');\n\n\n //-\n // Create a complete key with a kind value of `Company` and id`123`.\n //-\n const {Datastore} = require('https://cloud.google.com/nodejs/docs/reference/datastore/latest/overview.html');\n const datastore = new https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html();\n const key = datastore.https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html(['Company', 123]);\n\n\n //-\n // If the ID integer is outside the bounds of a JavaScript Number\n // object, create an Int.\n //-\n const {Datastore} = require('https://cloud.google.com/nodejs/docs/reference/datastore/latest/overview.html');\n const datastore = new https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html();\n const key = datastore.https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html([\n 'Company',\n datastore.https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html('100000000000001234')\n ]);\n\n\n const {Datastore} = require('https://cloud.google.com/nodejs/docs/reference/datastore/latest/overview.html');\n const datastore = new https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html();\n // Create a complete key with a kind value of `Company` and name `Google`.\n // Note: `id` is used for numeric identifiers and `name` is used otherwise.\n const key = datastore.https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html(['Company', 'Google']);\n\n\n //-\n // Create a complete key from a provided namespace and path.\n //-\n const {Datastore} = require('https://cloud.google.com/nodejs/docs/reference/datastore/latest/overview.html');\n const datastore = new https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html();\n const key = datastore.https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html({\n namespace: 'My-NS',\n path: ['Company', 123]\n });\n\nSerialize the key for later re-use. \n\n\n const {Datastore} = require('https://cloud.google.com/nodejs/docs/reference/datastore/latest/overview.html');\n const datastore = new https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html();\n const key = datastore.https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html({\n namespace: 'My-NS',\n path: ['Company', 123]\n });\n // Later...\n const key = datastore.https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html(https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/datastore.html.https://cloud.google.com/nodejs/docs/reference/datastore/latest/datastore/key.html);\n\nConstructors\n------------\n\n### (constructor)(options)\n\n constructor(options: KeyOptions);\n\nConstructs a new instance of the `Key` class\n\nProperties\n----------\n\n### id\n\n id?: string;\n\n### kind\n\n kind: string;\n\n### name\n\n name?: string;\n\n### namespace\n\n namespace?: string;\n\n### parent\n\n parent?: Key;\n\n### path\n\n path: Array\u003cstring | number\u003e;\n\n### serialized\n\n get serialized(): {\n namespace: string | undefined;\n path: (string | Int)[];\n };\n\nAccess the `serialized` property for a library-compatible way to re-use a key.\n**Example** \n\n\n const key = datastore.key({\n namespace: 'My-NS',\n path: ['Company', 123]\n });\n\n // Later...\n const key = datastore.key(key.serialized);"]]
