Exploring Lightning Data Service: A Comprehensive Guide with 10 Code Examples and Detailed Explanations
Lightning Data Service (LDS) is a powerful tool in Salesforce Lightning that allows you to work with Salesforce data without writing complex Apex code. It provides a standard way to access, create, update, and delete records in the database. Here are ten code examples that demonstrate the usage of Lightning Data Service:
1. Retrieve a single record by ID:
import { LightningElement, wire } from 'lwc';
import { getRecord } from 'lightning/uiRecordApi';
export default class ExampleComponent extends LightningElement {
recordId;
@wire(getRecord, { recordId: '$recordId', fields: ['Account.Name'] })
account;
handleRecordIdChange(event) {
this.recordId = event.target.value;
}
}
In this example, the getRecord function from lightning/uiRecordApi is used to retrieve an Account record based on the provided ID.
2. Retrieve related records using LDS:
import { LightningElement, wire } from 'lwc';
import { getRecord, getFieldValue } from 'lightning/uiRecordApi';
import { getObjectInfo } from 'lightning/uiObjectInfoApi';
export default class ExampleComponent extends LightningElement {
recordId;
@wire(getRecord, { recordId: '$recordId', fields: ['Account.Name', 'Account.Owner.Name'] })
account;
get ownerName() {
return getFieldValue(this.account.data, 'Account.Owner.Name');
}
}
This example demonstrates how to retrieve related data using LDS. The getRecord function is used to fetch the Account record and its related Owner record. The getFieldValue function is used to extract the Owner's name from the retrieved data.
3. Create a new record using LDS:
import { LightningElement, wire } from 'lwc';
import { createRecord } from 'lightning/uiRecordApi';
export default class ExampleComponent extends LightningElement {
accountId;
name = '';
description = '';
handleCreate() {
const fields = { Name: this.name, Description: this.description };
const recordInput = { apiName: 'Custom_Object__c', fields };
createRecord(recordInput)
.then((result) => {
this.accountId = result.id;
})
.catch((error) => {
// Handle error
});
}
}
In this example, the createRecord function is used to create a new record of the custom object Custom_Object__c with the specified field values.
4. Update a record using LDS:
import { LightningElement, wire } from 'lwc';
import { updateRecord } from 'lightning/uiRecordApi';
export default class ExampleComponent extends LightningElement {
recordId;
name = '';
handleUpdate() {
const fields = { Id: this.recordId, Name: this.name };
const recordInput = { fields };
updateRecord(recordInput)
.then(() => {
// Record updated successfully
})
.catch((error) => {
// Handle error
});
}
}
This example demonstrates how to update a record using the updateRecord function. The recordId and the field(s) to be updated are specified in the fields object.
5. Delete a record using LDS:
import { LightningElement, wire } from 'lwc';
import { deleteRecord } from 'lightning/uiRecordApi';
export default class ExampleComponent extends LightningElement {
recordId;
handleDelete() {
deleteRecord(this.recordId)
.then(() => {
// Record deleted successfully
})
.catch((
error) => {
// Handle error
});
}
}
In this example, the deleteRecord function is used to delete a record based on its ID.
6. Retrieve field metadata using LDS:
import { LightningElement, wire } from 'lwc';
import { getObjectInfo } from 'lightning/uiObjectInfoApi';
export default class ExampleComponent extends LightningElement {
objectApiName = 'Account';
@wire(getObjectInfo, { objectApiName: '$objectApiName' })
objectInfo;
get fields() {
if (this.objectInfo.data) {
return this.objectInfo.data.fields;
}
return [];
}
}
This example demonstrates how to retrieve metadata about fields in an object using the getObjectInfo function. The objectApiName parameter is used to specify the object for which metadata is required.
7. Refresh a record using LDS:
import { LightningElement, wire } from 'lwc';
import { refreshRecord } from 'lightning/uiRecordApi';
export default class ExampleComponent extends LightningElement {
recordId;
handleRefresh() {
refreshRecord(this.recordId)
.then(() => {
// Record refreshed successfully
})
.catch((error) => {
// Handle error
});
}
}
In this example, the refreshRecord function is used to reload the data for a record.
8. Perform a record save operation with LDS:
import { LightningElement, wire } from 'lwc';
import { getRecord, getFieldValue, updateRecord } from 'lightning/uiRecordApi';
export default class ExampleComponent extends LightningElement {
recordId;
account;
@wire(getRecord, { recordId: '$recordId', fields: ['Account.Name'] })
wiredAccount({ data }) {
if (data) {
this.account = data;
}
}
handleSave() {
const fields = { Id: this.recordId, Name: getFieldValue(this.account, 'Account.Name') };
const recordInput = { fields };
updateRecord(recordInput)
.then(() => {
// Record saved successfully
})
.catch((error) => {
// Handle error
});
}
}
This example demonstrates how to perform a record save operation using LDS. The updateRecord function is used to update the record with the modified field values.
9. Fetch records using a record list:
import { LightningElement, wire } from 'lwc';
import { getListUi } from 'lightning/uiListApi';
export default class ExampleComponent extends LightningElement {
objectApiName = 'Account';
listViewApiName = 'AllAccounts';
accounts;
@wire(getListUi, { objectApiName: '$objectApiName', listViewApiName: '$listViewApiName' })
wiredList({ data }) {
if (data) {
this.accounts = data.records.records;
}
}
}
In this example, the getListUi function is used to fetch a list of records from a specified list view. The retrieved records are stored in the accounts property.
10. Retrieve record data using LDS with an LDS wire adapter:
import { LightningElement, wire } from 'lwc';
import { getRecord } from 'lightning/uiRecordApi';
export default class ExampleComponent extends LightningElement {
recordId;
account;
@wire(getRecord, { recordId: '$recordId', fields: ['Account.Name'] })
wiredAccount({ data }) {
if (data) {
this.account = data;
}
}
}
This example demonstrates how to use the LDS wire adapter to retrieve record data. The getRecord function is used to fetch the Account record, and the retrieved data is stored in the account property.
These code examples showcase various use cases of Lightning Data Service in Salesforce Lightning. They illustrate how to retrieve, create, update, and delete records, work with related data, fetch field metadata, refresh records, and perform save operations.