Skip to content

Commit 4cc15a5

Browse files
authored
update readme
1 parent 34077fc commit 4cc15a5

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,8 @@ class User extends Model implements AuthenticatableContract
197197
}
198198
```
199199

200-
> Note that this model is implementing `Illuminate\Contracts\Auth\Authenticatable` and using `Illuminate\Auth\Authenticatable`. This is optional, but if we use them, we can use this model with authentication as well. For authentication, please refer to [Authentication section](#authentication-with-model)) for more details.
200+
> **Note**
201+
> Note that this model is implementing `Illuminate\Contracts\Auth\Authenticatable` and using `Illuminate\Auth\Authenticatable`. This is **optional**, but if we use them, we can use this model with authentication as well. For authentication, please refer to [Authentication section](#authentication-with-model)) for more details.
201202
202203
### Basic Usage
203204

@@ -233,6 +234,7 @@ public static function scan($exclusiveStartKey = null, $sort = 'asc', $limit = 5
233234
}
234235
```
235236

237+
> **Note**
236238
> DynamoDB can only handle result set up to 1MB per call, so we have to paginate if there are more results. see [Paginating the Results](#paginating-the-results) for more details.
237239
238240
#### Retrieving a model
@@ -472,6 +474,7 @@ $response = DB::table('ProductCatalog')
472474
->getItem(['Id' => 101]);
473475
```
474476

477+
> **Note**
475478
> Instead of marshaling manually, pass a plain array. `Kitar\Dynamodb\Query\Grammar` will automatically marshal them before querying.
476479
477480
#### putItem()
@@ -544,6 +547,7 @@ DB::table('ProductCatalog')
544547
]);
545548
```
546549

550+
> **Note**
547551
> Note that we specify `attribute_not_exists` for the operator of condition. This is DynamoDB-specific operator which called `function`. See [DynamoDB-specific operators for condition() and filter()](#dynamodb-specific-operators-for-condition-and-filter) for more details.
548552
549553
OR statements
@@ -621,6 +625,7 @@ $response = DB::table('Thread')
621625
->query();
622626
```
623627

628+
> **Note**
624629
> Note that DynamoDB's `ScanIndexForward` is a feature for `query`. It will not work with `scan`.
625630
626631
### Working with Scans
@@ -774,6 +779,7 @@ filter($key, 'begins_with', $value);
774779
filter($key, 'contains', $value);
775780
```
776781

782+
> **Note**
777783
> `size` function is not supported at this time.
778784
779785
## Testing

0 commit comments

Comments
 (0)