Skip to content

Commit 08a019c

Browse files
committed
doc updates
1 parent e626e8e commit 08a019c

3 files changed

Lines changed: 73 additions & 18 deletions

File tree

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,35 @@
33
## A .NET Standard and .NET Core Salesforce REST API integration library
44
*This project is not offered, sponsored, or endorsed by Salesforce.*
55

6-
Targets:
7-
- .NET Standard 2.0 : widest possible support including .NET Framework 4.6.1+ and .NET Core 2.0+
8-
- .NET Standard 2.1 : for newer .NET Core versions
6+
![NuGet Downloads](https://img.shields.io/nuget/dt/NetCoreForce.Client)
97

10-
For more info on .NET Standard compatiblity [see the Microsoft documentation here](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0)
8+
[Documentation](https://anthonyreilly.github.io/NetCoreForce/)
119

12-
Full tested support is for .NET Core 6.0 - 9.0 as tooling and tests target those.
10+
## Library Targets
1311

14-
![NuGet Downloads](https://img.shields.io/nuget/dt/NetCoreForce.Client)
12+
The primary target is .NET Standard 2.0 to provide the widest possible support.
13+
- .NET Standard 2.0 for widest possible support including .NET Framework 4.6.1+ and .NET Core 2.0
14+
- .NET Standard 2.1 for newer .NET Core versions
15+
16+
For more info on .NET Standard compatiblity [see the Microsoft documentation here](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0)
17+
18+
Full target list
19+
- .NET Standard 2.0
20+
- .NET Standard 2.1
21+
- .NET Core 3.1
22+
- .NET 5.0
23+
- .NET 6.0
24+
- .NET 7.0
25+
- .NET 8.0
26+
- .NET 9.0
27+
- .NET Framework 4.6.2
28+
- .NET Framework 4.7.2
29+
- .NET Framework 4.8
30+
31+
All possible frameworks are specifically targeted so that conditional compilation can be done where required.
32+
33+
Full tested support is for .NET Core 6.0 - 9.0 as tooling and tests target those.
34+
Legacy .NET Frameworks are partially tested
1535

1636
### [CHANGELOG](CHANGELOG.md)
1737

docs/getting-started.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44

5-
### Basic Usage Example
5+
## Basic Usage Example
66

77
```csharp
88
///Initialize the authentication client
@@ -25,14 +25,17 @@ await client.DeleteRecord(SfAccount.SObjectTypeName, acct.Id);
2525
//Get the results of a SOQL query
2626
List<SfCase> cases = await client.Query<SfCase>("SELECT Id,CaseNumber,Account.Name,Contact.Name FROM Case");
2727
```
28+
---
2829

29-
### Nested Query Results
30+
## Nested Query Results
3031

3132
When you include related objects in a SOQL query:
3233
```
3334
SELECT Id,CaseNumber,Account.Name,Contact.Name FROM Case
3435
```
3536

37+
[```Query<T>```](xref:NetCoreForce.Client.ForceClient.Query``1(System.String,System.Boolean)).
38+
3639
And get the results via the client, you can then access the related objects and fields included in the query in a fluent manner.
3740
```csharp
3841
List<SfCase> cases = await client.Query<SfCase>("SELECT Id,CaseNumber,Account.Name,Contact.Name FROM Case");
@@ -47,11 +50,14 @@ Nested queries are not fully supported - the subquery results will not be comple
4750
// *NOT* fully supported
4851
"SELECT Id,CaseNumber, (Select Contact.Name from Account) FROM Case"
4952
```
53+
---
5054

51-
### Asynchronous Batch Processing
55+
## Asynchronous Batch Processing
5256

53-
Query<T> method will retrieve the full result set before returning. By default, results are returned in batches of 2000.
54-
In cases where you are working with large result sets, you may want to use QueryAsync<T> to retrieve the batches asynchronously for better performance.
57+
[```Query<T>```](xref:NetCoreForce.Client.ForceClient.Query``1(System.String,System.Boolean)) method will retrieve the full result set before returning. By default, results are returned in batches of 2000.
58+
In cases where you are working with large result sets, you may want to use
59+
[```QueryAsync<T>```](xref:NetCoreForce.Client.ForceClient.QueryAsync``1(System.String,System.Boolean,System.Nullable{System.Int32},System.Threading.CancellationToken))
60+
to retrieve the batches asynchronously for better performance.
5561

5662
```csharp
5763
// First create the async enumerable. At this point, no query has been executed.
@@ -69,4 +75,12 @@ await using (IAsyncEnumerator<SfContact> contactsEnumerator = contactsEnumerable
6975
// process your results
7076
}
7177
}
72-
```
78+
```
79+
80+
---
81+
82+
## Multiple and Single Resultsets
83+
84+
By defualt, the [```Query<T>```](xref:NetCoreForce.Client.ForceClient.Query``1(System.String,System.Boolean)) returns a ```List<T>```.
85+
When you know the result will be a single record, you can use the [```QuerySingle<T>```](xref:NetCoreForce.Client.ForceClient.QuerySingle``1(System.String,System.Boolean)) method.
86+

docs/index.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,40 @@
22
_layout: landing
33
---
44

5-
6-
7-
* [ForceClient](~/api/NetCoreForce.Client.ForceClient.yml)
8-
-[NetcoreForce.Client](~/api/NetCoreForce.Client.yml)
5+
- [ForceClient](~/api/NetCoreForce.Client.ForceClient.yml)
6+
- [NetcoreForce.Client](~/api/NetCoreForce.Client.yml)
97

108

119
# NetCoreForce
1210

1311
## A .NET Salesforce REST API integration library
1412
*This project is not offered, sponsored, or endorsed by Salesforce.*
1513

16-
Targets .NET Standard 2.0 - this means it will be generally compatible with .NET Framework 4.6.1+ and .NET Core 2.0+
17-
For more info on .NET Standard 2.0 compatiblity [see the Microsoft documentation here](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0)
14+
## Library Targets
15+
16+
The primary target is .NET Standard 2.0 to provide the widest possible support.
17+
- .NET Standard 2.0 for widest possible support including .NET Framework 4.6.1+ and .NET Core 2.0
18+
- .NET Standard 2.1 for newer .NET Core versions
19+
20+
For more info on .NET Standard compatiblity [see the Microsoft documentation here](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0)
21+
22+
Full target list
23+
- .NET Standard 2.0
24+
- .NET Standard 2.1
25+
- .NET Core 3.1
26+
- .NET 5.0
27+
- .NET 6.0
28+
- .NET 7.0
29+
- .NET 8.0
30+
- .NET 9.0
31+
- .NET Framework 4.6.2
32+
- .NET Framework 4.7.2
33+
- .NET Framework 4.8
34+
35+
All possible frameworks are specifically targeted so that conditional compilation can be done where required.
36+
37+
Full tested support is for .NET Core 6.0 - 9.0 as tooling and tests target those.
38+
Legacy .NET Frameworks are partially tested
1839

1940
Full tested support is for .NET Core 6.0 - 9.0 as tooling and tests target those.
2041

0 commit comments

Comments
 (0)