Skip to content

Commit 926c21b

Browse files
simonmumenthalersimonmumenthaler
committed
docs(class-diagram): update request class diagram
add public methods to get a simple overview which methods where exists
1 parent b58dec2 commit 926c21b

File tree

2 files changed

+52
-31
lines changed

2 files changed

+52
-31
lines changed

‎src/dynamo/request/class-diagram.monopic

1.85 KB
Binary file not shown.

‎src/dynamo/request/class-diagram.txt

Lines changed: 52 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,52 @@
1-
┌──────────────────────┐
2-
│ BaseRequest │
3-
└──────────────────────┘
4-
▲
5-
┌──────────────┴───────────────────────────────┐
6-
│ │
7-
│ │
8-
│ ┌───────────────────────────────┐
9-
│ │ StandardRequest │
10-
│ └───────────────────────────────┘
11-
│ ▲
12-
│ ┌───────────────┼─────────────────────────┐
13-
│ │ │ │
14-
│ ┌──────────────────────┐ │ │
15-
│ │ ReadManyRequest │ │ │
16-
│ └──────────────────────┘ │ │
17-
│ ▲ ┌──────────────────────┐ │
18-
│ │ │ WriteRequest │ │
19-
│ │ └──────────────────────┘ │
20-
│ │ ▲ │
21-
┌───────────────────────────────┐ │ ┌──────────────────────┐ │ │ ┌──────────────────────┐│ ┌──────────────────────┐
22-
│ BatchGetSingleTableRequest │─┤ │ QueryRequest │─┤ ├─│ DeleteRequest │└─│ GetRequest │
23-
└───────────────────────────────┘ │ └──────────────────────┘ │ │ └──────────────────────┘ └──────────────────────┘
24-
│ ┌──────────────────────┐ │ │ ┌──────────────────────┐
25-
┌───────────────────────────────┐ │ │ ScanRequest │─┘ ├─│ PutRequest │
26-
│ BatchWriteSingleTableRequest │─┤ └──────────────────────┘ │ └──────────────────────┘
27-
└───────────────────────────────┘ │ │ ┌──────────────────────┐
28-
│ └─│ UpdateRequest │
29-
┌───────────────────────────────┐ │ └──────────────────────┘
30-
│ TransactGetSingleTableRequest │─┘
31-
└───────────────────────────────┘
1+
┌──────────────────────────────────────────────┐
2+
│ BaseRequest │
3+
├──────────────────────────────────────────────┤
4+
│+ returnConsumedCapacity(level): this │
5+
├──────────────────────────────────────────────┤
6+
│+ execFullResponse() │
7+
│+ exec() │
8+
└──────────────────────────────────────────────┘
9+
▲
10+
┌─────────────────────────────┴─────────────────────────┐
11+
│ │
12+
│ ┌─────────────────────────┐
13+
│ │ StandardRequest │
14+
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ │ └─────────────────────────┘
15+
┃ BatchGetSingleTableRequest<T> ┃─┤ ▲
16+
┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ │ ┌─────────────────────────────┼────┐
17+
┃+ consistentRead(): this ┃ │ │ │ │ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
18+
┃+ projectionExpression(...keyof): this ┃ │ ┌─────────────────────────────────────────────┐ │ └─┃ GetRequest ┃
19+
┃+ execNoMap() ┃ │ │ ReadManyRequest │ │ ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
20+
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ │ ├─────────────────────────────────────────────┤ │ ┃+ consistentRead(): this ┃
21+
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ │ │+ exclusiveStartKey(Key): this │ │ ┃+ projectionExpression(...keyof): this ┃
22+
┃ BatchWriteSingleTableRequest<T> ┃─┤ │+ index(string): this │ │ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
23+
┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ │ │+ limit(number): this │ └─────────────────────────┐
24+
┃+ returnItemCollectionMetrics(Metrics): this ┃ │ │+ consistentRead(boolean): this │ │
25+
┃+ delete(Partials<T>[]): this ┃ │ │+ projectionExpression(...keyof): this │ │
26+
┃+ put(T[]): this ┃ │ │+ whereAttribute(keyof): conditionFn<this> │ ┌─────────────────────────────────────────────────┐
27+
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ │ │+ where(...ConditionExpressionFunction): this│ │ WriteRequest │
28+
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ │ │+ execNoMap() │ ├─────────────────────────────────────────────────┤
29+
┃ TransactGetSingleTableRequest ┃─┘ │+ execSingle() │ │+ returnItemCollectionMetrics(metric) : this │
30+
┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ │+ execCount() │ │+ onlyIfAttribute(keyof):ConditionFunction<this> │
31+
┃+ execNoMap() ┃ │+ execFetchAll() │ │+ onlyIf(...ConditionFunctions): this │
32+
┃+ exec ┃ └─────────────────────────────────────────────┘ │+ execNoMap() │
33+
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ▲ └─────────────────────────────────────────────────┘
34+
│ ▲
35+
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ │ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ │
36+
┃ QueryRequest ┃─┤ ┃ DeleteRequest ┃─┤
37+
┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ │ ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ │
38+
┃+ wherePartitionKey(any): this ┃ │ ┃+ returnValues(string): this ┃ │
39+
┃+ whereSortKey(): SortKeyConditionFunction<this>┃ │ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ │
40+
┃+ ascending(): this ┃ │ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ │
41+
┃+ descending(): this ┃ │ ┃ PutRequest ┃─┤
42+
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ │ ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ │
43+
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ │ ┃+ returnValues(string): this ┃ │
44+
┃ ScanRequest ┃─┘ ┃+ ifNotExists(boolean): this ┃ │
45+
┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ │
46+
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ │
47+
┃ UpdateRequest ┃─┘
48+
┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
49+
┃+ updateAttribute(keyof): UpdateFunction<this> ┃
50+
┃+ operations(...updateFunction): this ┃
51+
┃+ returnValues(string): this ┃
52+
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

0 commit comments

Comments
 (0)