collection API - 생략 가능 인자 처리.

[jhpark816]

Cache server API에서는 생략 가능한 인자이지만, client API에서는 필수 인자로 받고 있다.
따라서, client API 호출 시에 불필요하게 많은 인자를 넘기고 있다.

예를 들어, asyncBopGet API에서 생략 가능한 인자는 아래와 같다.

• eFlagFilter
• withDelete, dropIfEmpty
• offset, count

읽기 쉬운 코드를 위해 생략되는 인자를 제외하는 API 제공하는 것은 어떤지 ?

[jhpark816]

@sUpniverse @hjyun328 의견 바랍니다.

[hjyun328]

@jhpark816 @sUpniverse
추가하는게 좋겠습니다. 추가 옵션을 사용하지 않는다면 응용 코드도 한결 깔끔해질 것이구요.
bopGet 뿐만 아니라 다른 collection도 마찬가지로 withDelete, dropIfEmpty를 제거한 API 추가도 필요해보입니다.

[sUpniverse]

@jhpark816 @hjyun328
저도 동의 합니다. 사용자 관점에서 모든 인자가 반드시 입력이 필요한 필수인자로 느껴져 혼란을 줄 수 있다고 생각합니다. 생략 가능한 인자에 관해서는 생략한 API를 제공하는게 사용자에게 좋을것 같습니다.

[sUpniverse]

@jhpark816 @hjyun328
생략가능한 인자를 가진 API는 아래와 같습니다.
생략가능 인자를 제외하고 필수 인자만으로 이루어진 API를 추가하면 될 것 같습니다.

// b+tree
CollectionFuture<Map<Long, Element<Object>>> asyncBopGet(String key,  long bkey, ElementFlagFilter eFlagFilter, boolean withDelete, boolean dropIfEmpty)

CollectionFuture<Map<Long, Element<T>>> asyncBopGet(String key, long bkey, ElementFlagFilter eFlagFilter, boolean withDelete,  boolean dropIfEmpty, Transcoder<T> tc)

CollectionFuture<Map<Long, Element<Object>>> asyncBopGet(String key, long from, long to, ElementFlagFilter eFlagFilter, int offset, int count, boolean withDelete, boolean dropIfEmpty)

CollectionFuture<Map<Long, Element<Object>>> asyncBopGet(String key, long from, long to, ElementFlagFilter eFlagFilter, int offset, int count, boolean withDelete, boolean dropIfEmpty, Transcoder<T> tc)

CollectionGetBulkFuture<Map<String, BTreeGetResult<Long, Object>>> asyncBopGetBulk( List<String> keyList, long from, long to, ElementFlagFilter eFlagFilter, int offset, int count)

CollectionGetBulkFuture<Map<String, BTreeGetResult<Long, Object>>> asyncBopGetBulk( List<String> keyList, long from, long to, ElementFlagFilter eFlagFilter, int offset, int count, Transcoder<T> tc)

CollectionFuture<Boolean> asyncBopInsert(String key, long bkey, byte[] eFlag, Object value, CollectionAttributes attributesForCreate)

CollectionFuture<Boolean> asyncBopInsert(String key, long bkey, byte[] eFlag, T value, CollectionAttributes attributesForCreate, Transcoder<T> tc)

Future<Map<String, CollectionOperationStatus>> asyncBopInsertBulk(List<String> keyList, long bkey, byte[] eFlag, Object value, CollectionAttributes attributesForCreate)

Future<Map<String, CollectionOperationStatus>> asyncBopInsertBulk(List<String> keyList, long bkey, byte[] eFlag, T value, CollectionAttributes attributesForCreate, Transcoder<T> tc)

CollectionFuture<Boolean> asyncBopUpsert(String key, byte[] bkey, byte[] elementFlag, Object value, CollectionAttributes attributesForCreate)

CollectionFuture<Boolean> asyncBopUpsert(String key, byte[] bkey, byte[] elementFlag, Object value, CollectionAttributes attributesForCreate, Transcoder<T> tc)

SMGetFuture<List<SMGetElement<Object>>> asyncBopSortMergeGet( List<String> keyList, long from, long to, ElementFlagFilter eFlagFilter, int offset, int count)

SMGetFuture<List<SMGetElement<Object>>> asyncBopSortMergeGet(List<String> keyList, long from, long to, ElementFlagFilter eFlagFilter, int count, SMGetMode smgetMode)

SMGetFuture<List<SMGetElement<Object>>> asyncBopSortMergeGet(List<String> keyList, byte[] from, byte[] to, ElementFlagFilter eFlagFilter, int offset, int count)

SMGetFuture<List<SMGetElement<Object>>> asyncBopSortMergeGet(List<String> keyList, byte[] from, byte[] to, ElementFlagFilter eFlagFilter, int count, SMGetMode smgetMode)

BTreeStoreAndGetFuture<Boolean, Object> asyncBopInsertAndGetTrimmed(String key, long bkey, byte[] eFlag, Object value, CollectionAttributes attributesForCreate)

BTreeStoreAndGetFuture<Boolean, Object> asyncBopInsertAndGetTrimmed(String key, byte[] bkey, byte[] eFlag, Object value, CollectionAttributes attributesForCreate)

BTreeStoreAndGetFuture<Boolean, E> asyncBopInsertAndGetTrimmed(String key, long bkey, byte[] eFlag, E value, CollectionAttributes attributesForCreate, Transcoder<E> transcoder)

BTreeStoreAndGetFuture<Boolean, E> asyncBopInsertAndGetTrimmed(String key, byte[] bkey, byte[] eFlag, E value, CollectionAttributes attributesForCreate, Transcoder<E> transcoder)

BTreeStoreAndGetFuture<Boolean, Object> asyncBopUpsertAndGetTrimmed(String key, long bkey, byte[] eFlag, Object value, CollectionAttributes attributesForCreate)

BTreeStoreAndGetFuture<Boolean, E> asyncBopUpsertAndGetTrimmed(String key, long bkey, byte[] eFlag, E value, CollectionAttributes attributesForCreate, Transcoder<E> transcoder)

BTreeStoreAndGetFuture<Boolean, Object> asyncBopUpsertAndGetTrimmed(String key, byte[] bkey, byte[] eFlag, Object value, CollectionAttributes attributesForCreate)

BTreeStoreAndGetFuture<Boolean, E> asyncBopUpsertAndGetTrimmed(String key, byte[] bkey, byte[] eFlag, E value, CollectionAttributes attributesForCreate, Transcoder<E> transcoder)

CollectionFuture<Long> asyncBopIncr(String key, long bkey, int by, long initial, byte[] eFlag)

CollectionFuture<Long> asyncBopIncr(String key, byte[] bkey, int by, long initial, byte[] eFlag)

CollectionFuture<Long> asyncBopDecr(String key, long bkey, int by, long initial, byte[] eFlag)

CollectionFuture<Long> asyncBopDecr(String key, byte[] bkey, int by, long initial, byte[] eFlag)

CollectionFuture<Boolean> asyncBopDelete(String key, long bkey, ElementFlagFilter eFlagFilter, boolean dropIfEmpty)

CollectionFuture<Boolean> asyncBopDelete(String key, long from, long to, ElementFlagFilter eFlagFilter, int count, boolean dropIfEmpty)

// map
CollectionFuture<Map<String, Object>> asyncMopGet(String key, boolean withDelete,  boolean dropIfEmpty)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, boolean withDelete,  boolean dropIfEmpty, Transcoder<T> tc)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, String mkey,  boolean withDelete, boolean dropIfEmpty)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, String mkey,  boolean withDelete, boolean dropIfEmpty, Transcoder<T> tc)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, List<String> mkeyList, boolean withDelete, boolean dropIfEmpty) 

CollectionFuture<Map<String, Object>> asyncMopGet(String key, List<String> mkeyList, boolean withDelete, boolean dropIfEmpty,  Transcoder<T> tc) 

CollectionFuture<Integer> asyncBopGetItemCount(String key, byte[] from, byte[] to,  ElementFlagFilter eFlagFilter)

CollectionFuture<Boolean> asyncMopDelete(String key, boolean dropIfEmpty)

CollectionFuture<Boolean> asyncMopDelete(String key, String mkey, boolean dropIfEmpty)


// list
CollectionFuture<List<Object>> asyncLopGet(String key, int index, boolean withDelete, boolean dropIfEmpty, )

CollectionFuture<List<Object>> asyncLopGet(String key, int index, boolean withDelete, boolean dropIfEmpty, Transcoder<T> tc)

CollectionFuture<List<Object>> asyncLopGet(String key,  int from, int to, boolean withDelete, boolean dropIfEmpty)

CollectionFuture<List<Object>> asyncLopGet(String key,  int from, int to, boolean withDelete, boolean dropIfEmpty, Transcoder<T> tc)

CollectionFuture<Boolean> asyncLopDelete(String key, int index, boolean dropIfEmpty)

CollectionFuture<Boolean> asyncLopDelete(String key, int from, int to, boolean dropIfEmpty)


// set
CollectionFuture<Set<Object>> asyncSopGet(String key, int count, boolean withDelete, boolean dropIfEmpty)

CollectionFuture<Set<Object>> asyncSopGet(String key, int count, boolean withDelete, boolean dropIfEmpty, Transcoder<T> tc)

CollectionFuture<Boolean> asyncSopDelete(String key, Object value, boolean dropIfEmpty)

CollectionFuture<Boolean> asyncSopDelete(String key, Object value, boolean dropIfEmpty, Transcoder<T> tc)


// 생성자 추가 대상
CollectionInsert(T value, byte[] elementFlag, boolean createKeyIfNotExists, RequestMode requestMode, CollectionAttributes attr)

BTreeInsert(T value, byte[] eFlag, boolean createKeyIfNotExists, RequestMode requestMode, CollectionAttributes attr)

BTreeUpsert(T value, byte[] eFlag, boolean createKeyIfNotExists, RequestMode requestMode, CollectionAttributes attr)

BTreeInsertAndGet(Command cmd, long bkey, byte[] eFlag, T value, CollectionAttributes attributesForCreate)

BTreeInsertAndGet(Command cmd, byte[] bkey, byte[] eFlag, T value, CollectionAttributes attributesForCreate)

BTreeBulkInsert(MemcachedNode node, List<String> keyList, long bkey, byte[] eflag, T value, CollectionAttributes attr, Transcoder<T> tc)

BTreeBulkInsert(MemcachedNode node, List<String> keyList, byte[] bkey, byte[] eflag, T value, CollectionAttributes attr, Transcoder<T> tc)

BTreeMutate(Mutator m, int by, long initial, byte[] eFlag)

BTreeSMGetWithByteTypeBkeyOld(MemcachedNode node, List<String> keyList, byte[] from, byte[] to, ElementFlagFilter eFlagFilter, int offset, int count)

BTreeGetBulkWithLongTypeBkey(MemcachedNode node, List<String> keyList,  long from, long to, ElementFlagFilter eFlagFilter, int offset, int count)

BTreeGetBulkWithByteTypeBkey(MemcachedNode node, List<String> keyList, byte[] from, byte[] to, ElementFlagFilter eFlagFilter, int offset, int count)

BTreeGetBulkImpl(MemcachedNode node, List<String> keyList, long from, long to, ElementFlagFilter eFlagFilter, int offset, int count)

BTreeGetBulkImpl(MemcachedNode node, List<String> keyList, byte[] from, byte[] to, ElementFlagFilter eFlagFilter, int offset, int count)

BTreeGetBulkImpl(MemcachedNode node, List<String> keyList, long bkey, ElementFlagFilter eFlagFilter, int offset, int count)

BTreeElement(K bkey, byte[] eflag, V value)

Element(byte[] bkey, T value, byte[] eflag)

Element(long bkey, T value, byte[] eflag)

[jhpark816]

@sUpniverse @hjyun328
offline 미팅으로 논의하고 나서, 최종 결정하시죠.

[sUpniverse]

@oliviarla

server의 ascii 문서를 참고하여

1. 생략가능한 인자를 제외한 API (필수 인자)
2. 그외에 생략가능한 인자를 부분적으로 포함한 API 도 고려

추가할 API 목록을 작성 후 작업을 진행하면 됩니다.

[oliviarla]

@sUpniverse
1. 생략가능한 인자를 제외한 API (필수 인자) 목록입니다.
이대로 진행해도 괜찮을까요?

// list
CollectionFuture<List<Object>> asyncLopGet(String key, int index)

CollectionFuture<List<Object>> asyncLopGet(String key, int index, Transcoder<T> tc)

CollectionFuture<List<Object>> asyncLopGet(String key,  int from, int to)

CollectionFuture<List<Object>> asyncLopGet(String key,  int from, int to, Transcoder<T> tc)

CollectionFuture<Boolean> asyncLopDelete(String key, int index)

CollectionFuture<Boolean> asyncLopDelete(String key, int from, int to)


// set
CollectionFuture<Set<Object>> asyncSopGet(String key, int count)

CollectionFuture<Set<Object>> asyncSopGet(String key, int count, Transcoder<T> tc)

CollectionFuture<Boolean> asyncSopDelete(String key, Object value)

CollectionFuture<Boolean> asyncSopDelete(String key, Object value, Transcoder<T> tc)

//map
CollectionFuture<Map<String, Object>> asyncMopGet(String key)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, Transcoder<T> tc)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, String mkey)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, String mkey, Transcoder<T> tc)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, List<String> mkeyList) 

CollectionFuture<Map<String, Object>> asyncMopGet(String key, List<String> mkeyList, Transcoder<T> tc) 

CollectionFuture<Boolean> asyncMopDelete(String key)

CollectionFuture<Boolean> asyncMopDelete(String key, String mkey)


//b+tree
// bkey, from, to가 byte[] 형식인 메소드들은 생략
CollectionFuture<Integer> asyncBopGetItemCount(String key, long from, long to)

CollectionFuture<Map<Long, Element<Object>>> asyncBopGet(String key,  long bkey)

CollectionFuture<Map<Long, Element<T>>> asyncBopGet(String key, long bkey, Transcoder<T> tc)

CollectionFuture<Map<Long, Element<Object>>> asyncBopGet(String key, long from, long to, int offset, int count)

CollectionFuture<Map<Long, Element<Object>>> asyncBopGet(String key, long from, long to, int offset, int count, Transcoder<T> tc)

CollectionGetBulkFuture<Map<String, BTreeGetResult<Long, Object>>> asyncBopGetBulk( List<String> keyList, long from, long to, int offset, int count)

CollectionGetBulkFuture<Map<String, BTreeGetResult<Long, Object>>> asyncBopGetBulk( List<String> keyList, long from, long to, int offset, int count, Transcoder<T> tc)

CollectionFuture<Boolean> asyncBopInsert(String key, long bkey, Object value, CollectionAttributes attributesForCreate)

CollectionFuture<Boolean> asyncBopInsert(String key, long bkey, T value, CollectionAttributes attributesForCreate, Transcoder<T> tc)ong, Object>>> asyncBopGetBulk( List<String> keyList, long from, long to, int offset, int count, Transcoder<T> tc)

CollectionFuture<Boolean> asyncBopInsert(String key, long bkey, Object value, CollectionAttributes attributesForCreate)

CollectionFuture<Boolean> asyncBopInsert(String key, long bkey, T value, CollectionAttributes attributesForCreate, Transcoder<T> tc)

Future<Map<String, CollectionOperationStatus>> asyncBopInsertBulk(List<String> keyList, long bkey, Object value)

Future<Map<String, CollectionOperationStatus>> asyncBopInsertBulk(List<String> keyList, long bkey, T value, Transcoder<T> tc)

CollectionFuture<Boolean> asyncBopUpsert(String key, long bkey, Object value)

CollectionFuture<Boolean> asyncBopUpsert(String key, long bkey, Object value, Transcoder<T> tc)

SMGetFuture<List<SMGetElement<Object>>> asyncBopSortMergeGet( List<String> keyList, long from, long to, int offset, int count)

SMGetFuture<List<SMGetElement<Object>>> asyncBopSortMergeGet(List<String> keyList, long from, long to, int count, SMGetMode smgetMode)

BTreeStoreAndGetFuture<Boolean, Object> asyncBopInsertAndGetTrimmed(String key, long bkey, Object value)

BTreeStoreAndGetFuture<Boolean, E> asyncBopInsertAndGetTrimmed(String key, long bkey, E value, Transcoder<E> transcoder)

BTreeStoreAndGetFuture<Boolean, Object> asyncBopUpsertAndGetTrimmed(String key, long bkey, Object value)

BTreeStoreAndGetFuture<Boolean, E> asyncBopUpsertAndGetTrimmed(String key, long bkey, E value, Transcoder<E> transcoder)

CollectionFuture<Long> asyncBopIncr(String key, long bkey, int by) //eflag와 동시에 initial도 삭제하였습니다

CollectionFuture<Long> asyncBopDecr(String key, long bkey, int by)

CollectionFuture<Boolean> asyncBopDelete(String key, long bkey)

CollectionFuture<Boolean> asyncBopDelete(String key, long from, long to, int count) //count(필수): from~to 범위 내에서 앞에서부터 count 개수만큼 삭제

[sUpniverse]

@oliviarla

bopGet 의 offset arugemnt는 생략 불가능 한가요?
그외 다른 API의 offset 도 마찬가지로 생략 불가능 한가요?

[oliviarla]

@sUpniverse
모두 offset과 count 생략이 가능하네요! 수정했습니다.

// list
CollectionFuture<List<Object>> asyncLopGet(String key, int index)

CollectionFuture<List<Object>> asyncLopGet(String key, int index, Transcoder<T> tc)

CollectionFuture<List<Object>> asyncLopGet(String key,  int from, int to)

CollectionFuture<List<Object>> asyncLopGet(String key,  int from, int to, Transcoder<T> tc)

CollectionFuture<Boolean> asyncLopDelete(String key, int index)

CollectionFuture<Boolean> asyncLopDelete(String key, int from, int to)


// set
CollectionFuture<Set<Object>> asyncSopGet(String key, int count)

CollectionFuture<Set<Object>> asyncSopGet(String key, int count, Transcoder<T> tc)

CollectionFuture<Boolean> asyncSopDelete(String key, Object value)

CollectionFuture<Boolean> asyncSopDelete(String key, Object value, Transcoder<T> tc)

//map
CollectionFuture<Map<String, Object>> asyncMopGet(String key)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, Transcoder<T> tc)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, String mkey)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, String mkey, Transcoder<T> tc)

CollectionFuture<Map<String, Object>> asyncMopGet(String key, List<String> mkeyList) 

CollectionFuture<Map<String, Object>> asyncMopGet(String key, List<String> mkeyList, Transcoder<T> tc) 

CollectionFuture<Boolean> asyncMopDelete(String key)

CollectionFuture<Boolean> asyncMopDelete(String key, String mkey)


//b+tree
// bkey, from, to가 byte[] 형식인 메소드들도 구현 필요
CollectionFuture<Integer> asyncBopGetItemCount(String key, long from, long to)

CollectionFuture<Map<Long, Element<Object>>> asyncBopGet(String key,  long bkey)

CollectionFuture<Map<Long, Element<T>>> asyncBopGet(String key, long bkey, Transcoder<T> tc)

CollectionFuture<Map<Long, Element<Object>>> asyncBopGet(String key, long from, long to)

CollectionFuture<Map<Long, Element<Object>>> asyncBopGet(String key, long from, long to, Transcoder<T> tc)

CollectionGetBulkFuture<Map<String, BTreeGetResult<Long, Object>>> asyncBopGetBulk( List<String> keyList, long from, long to)

CollectionGetBulkFuture<Map<String, BTreeGetResult<Long, Object>>> asyncBopGetBulk( List<String> keyList, long from, long to, Transcoder<T> tc)

CollectionFuture<Boolean> asyncBopInsert(String key, long bkey, Object value, CollectionAttributes attributesForCreate)

CollectionFuture<Boolean> asyncBopInsert(String key, long bkey, T value, CollectionAttributes attributesForCreate, Transcoder<T> tc)

CollectionFuture<Boolean> asyncBopInsert(String key, long bkey, Object value, CollectionAttributes attributesForCreate)

CollectionFuture<Boolean> asyncBopInsert(String key, long bkey, T value, CollectionAttributes attributesForCreate, Transcoder<T> tc)

Future<Map<String, CollectionOperationStatus>> asyncBopInsertBulk(List<String> keyList, long bkey, Object value)

Future<Map<String, CollectionOperationStatus>> asyncBopInsertBulk(List<String> keyList, long bkey, T value, Transcoder<T> tc)

CollectionFuture<Boolean> asyncBopUpsert(String key, long bkey, Object value)

CollectionFuture<Boolean> asyncBopUpsert(String key, long bkey, Object value, Transcoder<T> tc)

SMGetFuture<List<SMGetElement<Object>>> asyncBopSortMergeGet( List<String> keyList, long from, long to)

SMGetFuture<List<SMGetElement<Object>>> asyncBopSortMergeGet(List<String> keyList, long from, long to, SMGetMode smgetMode)

BTreeStoreAndGetFuture<Boolean, Object> asyncBopInsertAndGetTrimmed(String key, long bkey, Object value)

BTreeStoreAndGetFuture<Boolean, E> asyncBopInsertAndGetTrimmed(String key, long bkey, E value, Transcoder<E> transcoder)

BTreeStoreAndGetFuture<Boolean, Object> asyncBopUpsertAndGetTrimmed(String key, long bkey, Object value)

BTreeStoreAndGetFuture<Boolean, E> asyncBopUpsertAndGetTrimmed(String key, long bkey, E value, Transcoder<E> transcoder)

CollectionFuture<Long> asyncBopIncr(String key, long bkey, int by)

CollectionFuture<Long> asyncBopDecr(String key, long bkey, int by)

CollectionFuture<Boolean> asyncBopDelete(String key, long bkey)

CollectionFuture<Boolean> asyncBopDelete(String key, long from, long to, int count) //count(필수): from~to 범위 내에서 앞에서부터 count 개수만큼 삭제

[jhpark816]

코멘트입니다.

• delete API 경우에 한하여 dropIfEmpty 인자가 생략된 API를 제공하지 않도록 합시다.
  • dropIfEmpty 인자가 생략 가능하지만,
    응용 개발자가 dropIfEmpty 의미를 인지하여 사용하도록 유도하기 위함입니다.
• map API에 asyncMopDelete( ... mkeyList, ...) 형태가 포함되어야 할 것 같습니다.
  • 원래 제공되어야 할 API가 실수로 빠진 것으로 보입니다.
  • 확인해 보고 맞다면, 이 API 제공은 별도 PR로 보내주시죠.
• Object value vs T value 차이가 무엇인가요? Object value 형태로 통일하는 것이 나을 것 같아서요.
  • 통일하는 작업을 한다면, 이 작업도 의미가 다르므로 별도 PR로 처리하는 것이 좋겠습니다.
• bop get API 경우는 생략 가능 인자의 조합이 많아서, 어떤 API 제공할 것이지 생각할 필요가 있을 것 같습니다.
  • 가장 많이 사용될 API만 제공 vs. 모든 조합 가능한 API 제공 : 어떤 형태가 나을까요?
• 위 코멘트에 asyncBopInsert() API가 중복으로 들어간 것 같습니다.
• asyncBopSortMergeGet() 에서는 eFlagFilter만 제외하는 API 이어야 하지 않나 생각됩니다.
• bop API가 복잡하여 생각할 부분이 많군요.
  • list/set/map 관련 PR와 bop PR로 구분하는 것이 좋겠습니다.
  • bop PR은 위의 코멘트에 대해 정리하고 나서 진행하는 것이 좋겠습니다.