feat: adding methods documentation

byjg · Mar 13, 2024 · 3719620 · 3719620
1 parent 1b08c72
commit 3719620
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/AwsDynamoDbKeyValue.md b/docs/AwsDynamoDbKeyValue.md
@@ -140,6 +140,16 @@ $iterator = $dynamodb->getIterator($options);
 print_r($iterator->toArray());
 ```
 
+### Check if a key exists
+
+```php
+<?php
+$dynamodb = \ByJG\AnyDataset\NoSql\Factory::getInstance('dynamodb://....');
+if ($dynamodb->has(1201)) {
+    echo "exist!";
+}
+```
+
 ## Further reading
 
 - [https://docs.aws.amazon.com/aws-sdk-php/v2/guide/service-dynamodb.html](https://docs.aws.amazon.com/aws-sdk-php/v2/guide/service-dynamodb.html)

diff --git a/docs/AwsS3KeyValue.md b/docs/AwsS3KeyValue.md
@@ -81,5 +81,22 @@ while (strlen($data) <= $size) {
 }
 ```
 
+## Rename a key
+
+```php
+<?php
+$s3 = \ByJG\AnyDataset\NoSql\Factory::getInstance('s3://....');
+$s3->rename("object_name", "new_object_name");
+```
+
+## Check if a key exists
+
+```php
+<?php
+$s3 = \ByJG\AnyDataset\NoSql\Factory::getInstance('s3://....');
+if ($s3->has("object_name")) {
+    echo "exist!";
+}
+```
 ----
 [Open source ByJG](http://opensource.byjg.com)