Skip to content

Commit 2c5f9f1

Browse files
committed
docs update
1 parent d34555e commit 2c5f9f1

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

docs/getting-started.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Getting Started
22

3-
4-
53
## Basic Usage Example
64

75
```csharp
@@ -45,11 +43,21 @@ string caseAccountName = firstCase.Account.Name;
4543
string caseContactName = firstCase.Contact.Name;
4644
```
4745

48-
Nested queries are not fully supported - the subquery results will not be complete if they exceed the batch size as the NextRecordsUrl in the subquery results is not being acted upon. Instead use the relationship syntax in the example above.
46+
While you can use a SOQL query such as
47+
```SELECT * FROM Case```
48+
this will be inefficient as it will retrieve all fields for the object. It is highly recommended to only query those fields you will need, e.g.
49+
```SELECT Id, FirstName, LastName, Email, Account.Id, Account.Name FROM Contact```
50+
51+
[Nested queries](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_relationships_query_using.htm) are not fully supported - the subquery results will not be complete if they exceed the batch size as the NextRecordsUrl in the subquery results is not being acted upon. Instead use the relationship syntax in the examples above.
4952
```
5053
// *NOT* fully supported
51-
"SELECT Id,CaseNumber, (Select Contact.Name from Account) FROM Case"
54+
SELECT Name, (SELECT Email FROM Contacts) FROM Account
55+
// Instead use:
56+
SELECT Email, Account.Name FROM Contact
5257
```
58+
59+
For more on SOQL queries see the Salesforce Documentation: [Salesforce Object Query Language (SOQL)](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm)
60+
5361
---
5462

5563
## Asynchronous Batch Processing

0 commit comments

Comments
 (0)