Skip to content

Commit 9bba9ff

Browse files
committed
documentation
1 parent 1517bfa commit 9bba9ff

File tree

19 files changed

+385
-835
lines changed

19 files changed

+385
-835
lines changed

website/docs/cache/api/soql-cache.md

Lines changed: 56 additions & 56 deletions
Large diffs are not rendered by default.

website/docs/cache/examples/select.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ Specify fields that will be retrieved via query. Check [SOQLCache Cache API - SE
1616

1717
**SOQL**
1818

19-
```sql
19+
```sql title="Traditional SOQL"
2020
SELECT Id, Name, BillingCity
2121
FROM Account
2222
WHERE Id = '1234'
2323
```
2424

2525
**SOQL Lib**
2626

27-
```apex
27+
```apex title="SOQL Cache Approach"
2828
SOQLCache.of(Account.SObject)
2929
.with(Account.Id, Account.Name, Account.BillingCity)
3030
.byId('1234')
@@ -35,7 +35,7 @@ More than 5 fields:
3535

3636
**SOQL**
3737

38-
```sql
38+
```sql title="Traditional SOQL"
3939
SELECT
4040
Id,
4141
Name,
@@ -50,7 +50,7 @@ WHERE Id = '1234'
5050

5151
**SOQL Lib**
5252

53-
```apex
53+
```apex title="SOQL Cache Approach"
5454
SOQLCache.of(Account.SObjectType)
5555
.with(new List<SObjectField> {
5656
Account.Id,
@@ -69,15 +69,15 @@ SOQLCache.of(Account.SObjectType)
6969

7070
**SOQL**
7171

72-
```sql
72+
```sql title="Traditional SOQL"
7373
SELECT Id, Name, Industry, Rating, AnnualRevenue, BillingCity, Phone
7474
FROM Account
7575
WHERE Id = '1234'
7676
```
7777

7878
**SOQL Lib**
7979

80-
```apex
80+
```apex title="SOQL Cache Approach"
8181
SOQLCache.of(Account.SObjectType)
8282
.with('Id, Name, Industry, Rating, AnnualRevenue, BillingCity, Phone')
8383
.byId('1234')

website/docs/docs/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ List<Account> accounts = SOQL.of(Account.SObjectType)
6161
.toList();
6262
```
6363

64-
### [`Cache`](../cache/getting-started.md) - Performance Module _(Optional)_
64+
### [`Cache`](../cache/getting-started.md) _(Optional)_
6565

6666
An optional but highly recommended module that dramatically improves application performance by caching query results across different storage levels. Ideal for frequently accessed, slowly-changing data such as configuration records, metadata, and reference data.
6767

@@ -80,7 +80,7 @@ Profile profile = (Profile) SOQLCache.of(Profile.SObjectType)
8080
.toObject();
8181
```
8282

83-
### [`Evaluator`](../evaluator/getting-started.md) - Legacy Bridge Module _(Optional)_
83+
### [`Evaluator`](../evaluator/getting-started.md) _(Optional)_
8484

8585
Designed for developers who prefer traditional SOQL syntax but want to leverage SOQL Lib's enhanced capabilities. This module processes static query result, providing advanced result transformation methods and mocking capabilities without requiring adoption of the full SOQL Builder syntax.
8686

website/docs/evaluator/api/soql-evaluator.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Apex Classes: `SOQLEvaluator.cls` and `SOQLEvaluator_Test.cls`.
88

99
The lib evaluator class for processing of queried records.
1010

11-
```apex
11+
```apex title="Basic Usage Example"
1212
List<Account> accounts = SOQLEvaluator.of([
1313
SELECT Id, Name
1414
FROM Account
@@ -61,13 +61,13 @@ Constructs a `SOQLEvaluator` from existing SObject records.
6161

6262
**Signature**
6363

64-
```apex
64+
```apex title="Method Signature"
6565
SObjectEvaluable of(List<SObject> staticQueryRecords)
6666
```
6767

6868
**Example**
6969

70-
```apex
70+
```apex title="Constructor Example"
7171
SOQLEvaluator.of([
7272
SELECT Id, Name, Industry
7373
FROM Account
@@ -83,14 +83,14 @@ The `Security.stripInaccessible` method removes inaccessible fields from the exi
8383

8484
**Signature**
8585

86-
```apex
86+
```apex title="Method Signatures"
8787
SObjectEvaluable stripInaccessible()
8888
SObjectEvaluable stripInaccessible(AccessType accessType)
8989
```
9090

9191
**Example**
9292

93-
```apex
93+
```apex title="Strip Inaccessible Fields Example"
9494
List<Account> accessibleAccounts = SOQLEvaluator.of([
9595
SELECT Id, Name, Industry
9696
FROM Account

0 commit comments

Comments
 (0)