get( )
Retrieves an item from a collection.
Description
The get()
function returns a Promise that resolves to the item with ID
itemId
from the specified collection, or null if the itemId
is not found. The Promise is rejected if the
current user does not have read permissions for the collection.
Calling the get()
function triggers the beforeGet()
and afterGet()
hooks if they have been defined.
Use the options
parameter to run get()
from backend code without
checking for permissions or without its registered hooks.
Note: When using the
query()
orget()
functions or another data retrieval method following a change to your database collection, the data retrieved may not contain your most recent changes. See Wix-data and Eventual Consistency for more information. To solve this problem, you can use thesetTimeout()
function to delay retrieving data following any changes to your database collection.
Syntax
function get(collectionId: string, itemId: string, [options: WixDataOptions]): Promise<Object>
get Parameters
NAME
TYPE
DESCRIPTION
string
The ID of the collection to retrieve the item from.
string
The ID of the item to retrieve.
WixDataOptions
An object with one or both of the following boolean properties: suppressAuth, suppressHooks.
Returns
Fulfilled - The retrieved item or null if not found. Rejected - The error that caused the rejection.
Return Type:
Was this helpful?
Code Example
1import wixData from 'wix-data';23// ...45wixData.get("myCollection", "00001")6 .then( (results) => {7 let item = results; //see item below8 } )9 .catch( (err) => {10 let errorMsg = err;11 } );1213/* item is:14 *15 * {16 * "_id": "00001",17 * "_owner": "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",18 * "_createdDate": "2017-05-24T12:33:18.938Z",19 * "_updatedDate": "2017-05-24T12:33:18.938Z",20 * "title": "Mr.",21 * "first_name": "John",22 * "last_name": "Doe"23 * }24 */
Code Example
1import wixData from 'wix-data';23// ...45let options = {6 "suppressAuth": true,7 "suppressHooks": true8};910wixData.get("myCollection", "00001", options)11 .then( (results) => {12 let item = results; //see item below13 } )14 .catch( (err) => {15 let errorMsg = err;16 } );1718/* item is:19 *20 * {21 * "_id": "00001",22 * "_owner": "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",23 * "_createdDate": "2017-05-24T12:33:18.938Z",24 * "_updatedDate": "2017-05-24T12:33:18.938Z",25 * "title": "Mr.",26 * "first_name": "John",27 * "last_name": "Doe"28 * }29 */