DOC: Modify examples for the set document #321

ing-eoking · 2024-12-04T08:22:13Z

🔗 Related Issue

DOC: Modify examples for the list document #320
jam2in/arcus-works#636

⌨️ What I did

set 아이템 관련 API 문서를 list와 유사한 형식으로 변경했습니다.
다음 PR에서는 Map과 Btree API 수정이 순차적으로 진행될 예정입니다.
- 작업을 따로 진행하는 이유는 각 타입마다 제공하는 API가 조금씩 다르고, 일부 내용은 아직 확인이 완료되지 않았기 때문입니다.

jhpark816

리뷰 완료

docs/05-set-API.md

jhpark816 · 2024-12-04T08:59:18Z

docs/05-set-API.md

+    return -1;
+  }
+
+  if (piped_rc == MEMCACHED_ALL_NOT_EXIST) {


이게 failure에 해당되나요?

수정되었습니다.

jhpark816

리뷰 완료

docs/05-set-API.md

jhpark816 · 2024-12-05T01:14:47Z

docs/05-set-API.md

-    // 조회 결과를 삭제한다.
-    memcached_coll_result_free(result);
+  const char *key= "set:a_key";
+  size_t count= 1;


이 값을 0으로 하면 전체 element 조회인 것이죠?
전체 element 조회가 맞다면, 0으로 설정합시다.

그리고, memcached_sop_get의 count 인자 설명을 보강해 주세요.
key 인자도 추가해 주시고요.

jhpark816

리뷰 완료

docs/05-set-API.md

jhpark816 · 2024-12-05T02:32:50Z

docs/05-set-API.md

+    for (size_t i=0; i<number_of_values; i++) {
+      if (results[i] != MEMCACHED_EXIST && results[i] != MEMCACHED_NOT_EXIST) {
+        fprintf(stderr, "Failed to memcached_sop_piped_exist: %s : %s %d(%s)\n",
+                key, values[i], results[i], memcached_strerror(memc, results[i]));


이 경우의 results[i] 값으로 어떤 값이 있나요?

에러에 해당하는 값이 모두 들어갈 수 있습니다.
(ex. CONNECTION_FAILURE, SERVER_ERROR 등등)

PIPE_ERROR 같은 경우에도
항상 number_of_values 개의 result가 담기나요?

위의 에러 응답도 재 정리해 주시고요.

java client 예시에서는
get 하기 전에 insert 하는 코드가 있는 지를 확인하고 알려주세요.

PIPE_ERROR 같은 경우에도
항상 number_of_values 개의 result가 담기나요?

네 항상 number_of_values 갯수만큼 result가 담기며, 만약 PIPE_ERROR로 인하여 수행되지 않은 일부는 MEMCACHED_MAXIMUM_RETURN으로 채워집니다.

위의 에러 응답도 재 정리해 주시고요.

수정했습니다. 또한 문서에서 MEMCACHED_SOME_SUCCESS, MEMCACHED_ALL_FAILURE 내용을 추가했습니다.

java client 예시에서는
get 하기 전에 insert 하는 코드가 있는 지를 확인하고 알려주세요.

없습니다.

String key = "Sample:Set"; int count = 10; boolean withDelete = false; boolean dropIfEmpty = false; CollectionFuture<Set<Object>> future = null; try { future = client.asyncSopGet(key, count, withDelete, dropIfEmpty); // (1) } catch (IllegalStateException e) { // handle exception } if (future == null) return; try { Set<Object> result = future.get(1000L, TimeUnit.MILLISECONDS); // (2) System.out.println(result); System.out.println(future.getOperationStatus().getResponse()); // (3) } catch (TimeoutException e) { future.cancel(true); } catch (InterruptedException e) { future.cancel(true); } catch (ExecutionException e) { future.cancel(true); }

jhpark816

리뷰 완료

jhpark816 · 2024-12-05T05:06:04Z

docs/05-set-API.md

+    for (size_t i=0; i<number_of_values; i++) {
+      if (results[i] != MEMCACHED_EXIST && results[i] != MEMCACHED_NOT_EXIST) {
+        fprintf(stderr, "Failed to memcached_sop_piped_exist: %s : %s %d(%s)\n",
+                key, values[i], results[i], memcached_strerror(memc, results[i]));


PIPE_ERROR 같은 경우에도
항상 number_of_values 개의 result가 담기나요?

jhpark816 · 2024-12-05T05:06:22Z

docs/05-set-API.md

+    for (size_t i=0; i<number_of_values; i++) {
+      if (results[i] != MEMCACHED_EXIST && results[i] != MEMCACHED_NOT_EXIST) {
+        fprintf(stderr, "Failed to memcached_sop_piped_exist: %s : %s %d(%s)\n",
+                key, values[i], results[i], memcached_strerror(memc, results[i]));


위의 에러 응답도 재 정리해 주시고요.

jhpark816 · 2024-12-05T05:16:18Z

docs/05-set-API.md

+  bool drop_if_empty = false;
+  memcached_coll_result_st result;
+  memcached_return_t rc;
+


result create

result create; do { if (fail) { break; } } while(0); result free;

수정되었습니다. (list는 다음 PR로 수정하겠습니다.)

result의 일부 값에 대해서만 malloc이 성공하는 경우가 존재합니다.
(예: values 공간을 생성하는 도중 일부는 성공하고 일부는 실패하는 경우, 이 경우에는 별도의 핸들링 없이 바로 에러를 반환합니다.)

jhpark816 · 2024-12-05T05:20:34Z

docs/05-set-API.md

+    for (size_t i=0; i<number_of_values; i++) {
+      if (results[i] != MEMCACHED_EXIST && results[i] != MEMCACHED_NOT_EXIST) {
+        fprintf(stderr, "Failed to memcached_sop_piped_exist: %s : %s %d(%s)\n",
+                key, values[i], results[i], memcached_strerror(memc, results[i]));


java client 예시에서는
get 하기 전에 insert 하는 코드가 있는 지를 확인하고 알려주세요.

ing-eoking

수정되었습니다.

ing-eoking · 2024-12-05T06:19:02Z

docs/05-set-API.md

+  bool drop_if_empty = false;
+  memcached_coll_result_st result;
+  memcached_return_t rc;
+


수정되었습니다. (list는 다음 PR로 수정하겠습니다.)

result의 일부 값에 대해서만 malloc이 성공하는 경우가 존재합니다.
(예: values 공간을 생성하는 도중 일부는 성공하고 일부는 실패하는 경우, 이 경우에는 별도의 핸들링 없이 바로 에러를 반환합니다.)

ing-eoking · 2024-12-05T06:51:23Z

docs/05-set-API.md

+    for (size_t i=0; i<number_of_values; i++) {
+      if (results[i] != MEMCACHED_EXIST && results[i] != MEMCACHED_NOT_EXIST) {
+        fprintf(stderr, "Failed to memcached_sop_piped_exist: %s : %s %d(%s)\n",
+                key, values[i], results[i], memcached_strerror(memc, results[i]));


PIPE_ERROR 같은 경우에도
항상 number_of_values 개의 result가 담기나요?

네 항상 number_of_values 갯수만큼 result가 담기며, 만약 PIPE_ERROR로 인하여 수행되지 않은 일부는 MEMCACHED_MAXIMUM_RETURN으로 채워집니다.

위의 에러 응답도 재 정리해 주시고요.

수정했습니다. 또한 문서에서 MEMCACHED_SOME_SUCCESS, MEMCACHED_ALL_FAILURE 내용을 추가했습니다.

java client 예시에서는
get 하기 전에 insert 하는 코드가 있는 지를 확인하고 알려주세요.

없습니다.

String key = "Sample:Set"; int count = 10; boolean withDelete = false; boolean dropIfEmpty = false; CollectionFuture<Set<Object>> future = null; try { future = client.asyncSopGet(key, count, withDelete, dropIfEmpty); // (1) } catch (IllegalStateException e) { // handle exception } if (future == null) return; try { Set<Object> result = future.get(1000L, TimeUnit.MILLISECONDS); // (2) System.out.println(result); System.out.println(future.getOperationStatus().getResponse()); // (3) } catch (TimeoutException e) { future.cancel(true); } catch (InterruptedException e) { future.cancel(true); } catch (ExecutionException e) { future.cancel(true); }

jhpark816

리뷰 완료

jhpark816 · 2024-12-05T08:52:31Z

docs/05-set-API.md

-    // 조회 결과를 삭제한다.
-    memcached_coll_result_free(result);
+  memcached_coll_result_free(&result);
+  return return_value;


return_value 변수를 두지 않고, 아래와 같이 처리하시죠.

return (rc == MEMCACHED_SUCCESS) ? 0 : -1;

수정되었습니다.

jhpark816 · 2024-12-05T08:53:23Z

docs/05-set-API.md

+      const char* value= memcached_coll_result_get_value(&result, i);
+      fprintf(stdout, "memcached_sop_get: %s : %s\n", key, value);
+    }
+  } while(0)


while(0) 다음에 ;(콜론)을 추가합시다.

ing-eoking

수정되었습니다.

ing-eoking · 2024-12-06T00:14:22Z

docs/05-set-API.md

-    // 조회 결과를 삭제한다.
-    memcached_coll_result_free(result);
+  memcached_coll_result_free(&result);
+  return return_value;


수정되었습니다.

ing-eoking force-pushed the set branch from c57b807 to b2eb6a2 Compare December 4, 2024 08:24

jhpark816 reviewed Dec 4, 2024

View reviewed changes

ing-eoking force-pushed the set branch from b2eb6a2 to 3a2be6e Compare December 4, 2024 22:58

jhpark816 reviewed Dec 5, 2024

View reviewed changes

ing-eoking force-pushed the set branch from 3a2be6e to 5b3f84f Compare December 5, 2024 01:55

jhpark816 reviewed Dec 5, 2024

View reviewed changes

ing-eoking mentioned this pull request Dec 5, 2024

INTERNAL: Add a success case for 'NOT_EXIST' in the exist API #322

Merged

ing-eoking force-pushed the set branch from 5b3f84f to a624727 Compare December 5, 2024 02:50

jhpark816 reviewed Dec 5, 2024

View reviewed changes

ing-eoking force-pushed the set branch from a624727 to 110c8cd Compare December 5, 2024 06:59

ing-eoking commented Dec 5, 2024

View reviewed changes

ing-eoking mentioned this pull request Dec 5, 2024

DOC: Add missing documentation for the list API #323

Merged

jhpark816 reviewed Dec 5, 2024

View reviewed changes

DOC: Modify examples for the set document

c73b3bf

ing-eoking force-pushed the set branch from 110c8cd to c73b3bf Compare December 6, 2024 00:11

ing-eoking commented Dec 6, 2024

View reviewed changes

jhpark816 merged commit 1504516 into naver:develop Dec 6, 2024
1 check passed

ing-eoking deleted the set branch December 6, 2024 01:55

ing-eoking mentioned this pull request Jan 2, 2025

[DOC] docs/manual 보강 #66

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Modify examples for the set document #321

DOC: Modify examples for the set document #321

ing-eoking commented Dec 4, 2024

jhpark816 left a comment

jhpark816 Dec 4, 2024

ing-eoking Dec 4, 2024

jhpark816 left a comment

jhpark816 Dec 5, 2024

jhpark816 left a comment

jhpark816 Dec 5, 2024

ing-eoking Dec 5, 2024 •

edited

Loading

jhpark816 Dec 5, 2024

jhpark816 Dec 5, 2024

jhpark816 Dec 5, 2024

ing-eoking Dec 5, 2024 •

edited

Loading

jhpark816 left a comment

jhpark816 Dec 5, 2024

jhpark816 Dec 5, 2024

jhpark816 Dec 5, 2024

jhpark816 Dec 5, 2024

ing-eoking Dec 5, 2024 •

edited

Loading

jhpark816 Dec 5, 2024

ing-eoking left a comment

ing-eoking Dec 5, 2024 •

edited

Loading

ing-eoking Dec 5, 2024 •

edited

Loading

jhpark816 left a comment

jhpark816 Dec 5, 2024

ing-eoking Dec 6, 2024

jhpark816 Dec 5, 2024

ing-eoking left a comment

ing-eoking Dec 6, 2024

DOC: Modify examples for the set document #321

DOC: Modify examples for the set document #321

Conversation

ing-eoking commented Dec 4, 2024

🔗 Related Issue

⌨️ What I did

jhpark816 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jhpark816 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jhpark816 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ing-eoking Dec 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ing-eoking Dec 5, 2024 • edited Loading

Choose a reason for hiding this comment

jhpark816 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ing-eoking Dec 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ing-eoking left a comment

Choose a reason for hiding this comment

ing-eoking Dec 5, 2024 • edited Loading

Choose a reason for hiding this comment

ing-eoking Dec 5, 2024 • edited Loading

Choose a reason for hiding this comment

jhpark816 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ing-eoking left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ing-eoking Dec 5, 2024 •

edited

Loading

ing-eoking Dec 5, 2024 •

edited

Loading

ing-eoking Dec 5, 2024 •

edited

Loading

ing-eoking Dec 5, 2024 •

edited

Loading

ing-eoking Dec 5, 2024 •

edited

Loading