Skip to content

Commit 265ace3

Browse files
brido4125jhpark816
authored andcommitted
DOCS: fix link reference.
1 parent 491e927 commit 265ace3

File tree

11 files changed

+167
-116
lines changed

11 files changed

+167
-116
lines changed

docs/user-guide/01-arcus-cloud-basics.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,14 @@ ARCUS Cache Server의 key-value 모델은 아래의 기본 제약 사항을 가
1515

1616
아래에서 ARCUS Cloud를 이해하는 데 있어 기본 사항들을 기술한다.
1717

18-
- [서비스코드](01-arcus-cloud-basics.md#서비스코드)
18+
- [서비스코드](01-arcus-cloud-basics.md#service-code)
1919
- [ARCUS Admin](01-arcus-cloud-basics.md#arcus-admin)
2020
- [Cache Key](01-arcus-cloud-basics.md#cache-key)
2121
- [Cache Item](01-arcus-cloud-basics.md#cache-item)
22-
- [Expiration, Eviction, and Sticky Item](01-arcus-cloud-basics.md#expiration-eviction-and-sticky-item)
22+
- [Expiration, Eviction, and Sticky Item](01-arcus-cloud-basics.md#expiration-eviction-sticky)
2323

2424

25+
<a id="service-code"></a>
2526
## 서비스코드
2627

2728
서비스코드(service code)는 ARCUS에서 Cache Cloud를 구분하는 코드이다.
@@ -32,6 +33,7 @@ ARCUS Java Client 객체는 하나의 ARCUS 서비스코드만을 가지며, 하
3233
해당 응용이 둘 이상의 ARCUS Cache Cloud를 접근해야 한다면,
3334
각 ARCUS Cache Cloud의 서비스코드를 가지는 ARCUS Java Client 객체를 따로 생성하여 사용하여야 한다.
3435

36+
<a id="arcus-admin"></a>
3537
## ARCUS Admin
3638

3739
ARCUS admin은 ZooKeeper를 이용하여 각 서비스 코드에 해당하는 ARCUS Cache Cloud를 관리한다.
@@ -41,6 +43,7 @@ cache server 추가 및 삭제에 대해 cache server list를 최신 상태로
4143
ARCUS admin은 highly available하여야 하므로,
4244
여러 ZooKeeper 서버들을 하나의 ZeeKeeper ensemble로 구성하여 사용한다.
4345

46+
<a id="cache-key"></a>
4447
## Cache Key
4548

4649
Cache key는 ARCUS Cache에 저장하는 cache item을 유일하게 식별한다. Cache key 형식은 아래와 같다.
@@ -61,6 +64,7 @@ Prefix와 subkey는 아래의 명명 규칙을 가진다.
6164
이 중에 하이픈(-)은 prefix 명의 첫번째 문자로 올 수 없다.
6265
- Subkey는 공백을 포함할 수 없으며, 기본적으로 alphanumeric만을 사용하길 권장한다.
6366

67+
<a id="cache-item"></a>
6468
## Cache Item
6569

6670
ARCUS Cache는 simple key-value item 외에 다양한 collection item 유형을 가진다.
@@ -72,6 +76,7 @@ ARCUS Cache는 simple key-value item 외에 다양한 collection item 유형을
7276
- map item - \<mkey, value\>쌍으로 구성된 데이터 집합을 가지는 item
7377
- b+tree item - b+tree key 기반으로 정렬된 데이터 집합을 가지는 item
7478

79+
<a id="expiration-eviction-sticky"></a>
7580
## Expiration, Eviction, and Sticky Item
7681

7782
각 cache item은 expiration time 속성을 가진다.

docs/user-guide/02-arcus-java-client.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# 2. ARCUS Java Client 사용법
22

3-
- [ARCUS Client 기본 사용법](02-arcus-java-client.md#arcus-client-기본-사용법)
4-
- [ARCUS Client 생성, 소멸, 관리](02-arcus-java-client.md#arcus-client-생성-소멸-관리)
5-
- [ARCUS Client 설정](02-arcus-java-client.md#arcus-client-설정)
3+
- [ARCUS Client 기본 사용법](02-arcus-java-client.md#arcus-client-basic-usage)
4+
- [ARCUS Client 생성, 소멸, 관리](02-arcus-java-client.md#arcus-client-lifecycle)
5+
- [ARCUS Client 설정](02-arcus-java-client.md#arcus-client-settings)
66

77

8+
<a id="arcus-client-basic-usage"></a>
89
## ARCUS Client 기본 사용법
910

1011
예제를 통해 ARCUS java client 기본 사용법을 알아본다.
@@ -106,6 +107,7 @@ public class HelloArcus {
106107
- Spring container에서 관리되는 경우 bean 설정의 destroy-method에서 `shutdown` 메소드가 호출되도록 설정해야 한다.
107108

108109

110+
<a id="arcus-client-lifecycle"></a>
109111
## ARCUS Client 생성, 소멸, 관리
110112

111113
### ARCUS Client 생성
@@ -217,6 +219,7 @@ cache key와 cache server와의 mapping을 갱신하게 한다.
217219
따라서, ARCUS client를 사용할 때 cache server 대수의 변화에 대한 방어 로직은 신경 쓰지 않아도 된다.
218220

219221

222+
<a id="arcus-client-settings"></a>
220223
## ARCUS Client 설정
221224

222225
### Key-Value에서 데이터 압축 설정

docs/user-guide/03-key-value-API.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@ Key-value item은 하나의 key에 대해 하나의 value만을 저장하는 ite
88

99
Key-value item에 대해 수행가능한 연산들은 아래와 같다.
1010

11-
- [Key-Value Item 저장](03-key-value-API.md#key-value-item-저장)
12-
- [Key-Value Item 조회](03-key-value-API.md#key-value-item-조회)
13-
- [Key-Value Item 값의 증감](03-key-value-API.md#key-value-item-값의-증감)
14-
- [Key-Value Item 삭제](03-key-value-API.md#key-value-item-삭제)
15-
- [Key-Value Item 만료 시간 갱신](03-key-value-API.md#key-value-item-만료-시간-갱신)
11+
- [Key-Value Item 저장](03-key-value-API.md#key-value-item-store)
12+
- [Key-Value Item 조회](03-key-value-API.md#key-value-item-get)
13+
- [Key-Value Item 값의 증감](03-key-value-API.md#key-value-item-incr-decr)
14+
- [Key-Value Item 삭제](03-key-value-API.md#key-value-item-delete)
15+
- [Key-Value Item 만료 시간 갱신](03-key-value-API.md#key-value-item-touch)
1616

17+
<a id="key-value-item-store"></a>
1718
## Key-Value Item 저장
1819

1920
key-value item을 저장하는 API로 set, add, replace를 제공한다.
@@ -90,6 +91,7 @@ StatusCode.ERR_NOT_FOUND | Key miss (주어진 key에 해당하는 item
9091
StatusCode.ERR_EXISTS | 동일 key가 이미 존재함
9192

9293

94+
<a id="key-value-item-get"></a>
9395
## Key-Value Item 조회
9496

9597
하나의 key를 가진 cache item에 저장된 value를 조회하는 API를 제공한다.
@@ -141,6 +143,7 @@ BulkFuture<Map<String, CASValue<Object>>> asyncGetsBulk(String... keys)
141143
- 다수 key들은 String 유형의 Collection이거나 String 유형의 나열된 key 목록일 수 있다.
142144

143145

146+
<a id="key-value-item-incr-decr"></a>
144147
## Key-Value Item 값의 증감
145148

146149
key-value item에서 value 부분의 값을 증가시키거나 감소시키는 연산이다.
@@ -173,6 +176,7 @@ StatusCode.SUCCESS | 증감 성공
173176
StatusCode.ERR_NOT_FOUND | 증감 실패 (Key miss, 주어진 key에 해당하는 item이 없음)
174177

175178

179+
<a id="key-value-item-delete"></a>
176180
## Key-Value Item 삭제
177181

178182
하나의 key에 대한 item을 삭제하는 API와
@@ -205,6 +209,7 @@ future.get().get(key).getStatusCode() | 설명
205209
--------------------------------------| ---------
206210
StatusCode.ERR_NOT_FOUND | 삭제 실패 (Key miss, 주어진 key에 해당하는 item이 없음)
207211

212+
<a id="key-value-item-touch"></a>
208213
## Key-Value Item 만료 시간 갱신
209214
하나의 key에 대한 item의 만료 시간을 갱신하는 API를 제공한다.
210215

docs/user-guide/04-list-API.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ List collection은 하나의 key에 대해 여러 value들을 double linked list
1111

1212
List item에 대해 수행가능한 기본 연산들은 아래와 같다.
1313

14-
- [List Item 생성](04-list-API.md#list-item-생성) (List Item 삭제는 key-value item 삭제 함수로 수행한다)
15-
- [List Element 삽입](04-list-API.md#list-element-삽입)
16-
- [List Element 삭제](04-list-API.md#list-element-삭제)
17-
- [List Element 조회](04-list-API.md#list-element-조회)
14+
- [List Item 생성](04-list-API.md#list-element-create) (List Item 삭제는 key-value item 삭제 함수로 수행한다)
15+
- [List Element 삽입](04-list-API.md#list-element-insert)
16+
- [List Element 삭제](04-list-API.md#list-element-delete)
17+
- [List Element 조회](04-list-API.md#list-element-get)
1818

1919
여러 list element들에 대해 한 번에 일괄 수행하는 연산은 다음과 같다.
2020

21-
- [List Element 일괄 삽입](04-list-API.md#list-element-일괄-삽입)
22-
21+
- [List Element 일괄 삽입](04-list-API.md#list-element-bulk-insert)
2322

23+
<a id="list-element-create"></a>
2424
## List Item 생성
2525

2626
새로운 empty list item을 생성한다.
@@ -86,9 +86,10 @@ try {
8686
2. timeout은 1초로 지정했다. 생성에 성공하면 future는 true를 반환한다.
8787
지정한 시간에 생성 결과가 넘어 오지 않거나 JVM의 과부하로 operation queue에서 처리되지 않을 경우
8888
TimeoutException이 발생한다.
89-
3. 생성 결과에 대한 상세 정보는 future.getOperationStatus().getResponse()를 통해 조회할 수 있다.
90-
89+
3. 생성 결과에 대한 상세 정보는 future.getOperationStatus().getResponse()를 통해 조회할 수 있다.
90+
9191

92+
<a id="list-element-insert"></a>
9293
## List Element 삽입
9394

9495
List에 하나의 element를 삽입하는 함수이다.
@@ -164,6 +165,7 @@ try {
164165
3. 삽입 결과에 대한 상세 정보는 future.getOperationStatus().getResponse()를 통해 조회할 수 있다.
165166

166167

168+
<a id="list-element-delete"></a>
167169
## List Element 삭제
168170

169171
List에서 index 위치에 있는 하나의 element 또는 index range에 포함되는 다수 element를 삭제하는 함수는 아래와 같다.
@@ -231,6 +233,7 @@ try {
231233
3. 정상적으로 삭제되면 true를 반환한다.
232234
삭제 결과에 따른 반환 값은 future.getOperationStatus().getResponse()로 확인한다.
233235

236+
<a id="list-element-get"></a>
234237
## List Element 조회
235238

236239
List 에서 하나의 index 또는 index range에 해당하는 element를 조회한다.
@@ -313,6 +316,7 @@ try {
313316
3. 조회 결과에 대한 상세 정보는 future.getOperationStatus().getResponse()를 통해 조회 할 수 있다.
314317

315318

319+
<a id="list-element-bulk-insert"></a>
316320
## List Element 일괄 삽입
317321

318322
두 유형의 bulk 삽입 기능을 제공한다.

docs/user-guide/05-set-API.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,19 @@ Set item은 하나의 key에 대해 unique value의 집합을 저장한다.
1010

1111
Set item에 수행가능한 기본 연산들은 다음과 같다.
1212

13-
- [Set Item 생성](05-set-API.md#set-item-생성) (Set item 삭제는 key-value item 삭제 함수로 수행한다)
14-
- [Set Element 삽입](05-set-API.md#set-element-삽입)
15-
- [Set Element 삭제](05-set-API.md#set-element-삭제)
16-
- [Set Element 존재여부 확인](05-set-API.md#set-element-존재여부-확인)
17-
- [Set Element 조회](05-set-API.md#set-element-조회)
13+
- [Set Item 생성](05-set-API.md#set-item-create) (Set item 삭제는 key-value item 삭제 함수로 수행한다)
14+
- [Set Element 삽입](05-set-API.md#set-element-insert)
15+
- [Set Element 삭제](05-set-API.md#set-element-delete)
16+
- [Set Element 존재여부 확인](05-set-API.md#set-element-exist)
17+
- [Set Element 조회](05-set-API.md#set-element-get)
1818

1919
여러 set element들에 대해 한 번에 일괄 수행하는 연산은 다음과 같다.
2020

21-
- [Set Element 일괄 삽입](05-set-API.md#set-element-일괄-삽입)
22-
- [Set Element 일괄 존재여부 확인](05-set-API.md#set-element-일괄-존재여부-확인)
21+
- [Set Element 일괄 삽입](05-set-API.md#set-element-bulk-insert)
22+
- [Set Element 일괄 존재여부 확인](05-set-API.md#set-element-bulk-exist)
2323

2424

25+
<a id="set-item-create"></a>
2526
## Set Item 생성
2627

2728
새로운 empty set item을 생성한다.
@@ -85,9 +86,10 @@ try {
8586
2. timeout은 1초로 지정했다. 생성에 성공하면 future는 true를 반환한다.
8687
지정한 시간에 생성 결과가 넘어 오지 않거나 JVM의 과부하로 operation queue에서 처리되지 않을 경우
8788
TimeoutException이 발생한다.
88-
3. 생성 결과에 대한 상세 정보는 future.getOperationStatus().getResponse()를 통해 조회할 수 있다.
89+
3. 생성 결과에 대한 상세 정보는 future.getOperationStatus().getResponse()를 통해 조회할 수 있다.
8990

9091

92+
<a id="set-element-insert"></a>
9193
## Set Element 삽입
9294

9395
Set에 하나의 element를 삽입하는 함수이다.
@@ -158,6 +160,7 @@ try {
158160
4. 삽입 결과에 대한 상세 정보는 future.getOperationStatus().getResponse()를 통해 조회할 수 있다.
159161

160162

163+
<a id="set-element-delete"></a>
161164
## Set Element 삭제
162165

163166
Set에서 주어진 value를 가진 element를 삭제하는 함수이다.
@@ -217,6 +220,7 @@ try {
217220
3. 정상적으로 삭제되면 true를 반환한다. 자세한 삭제 결과는 future.getOperationStatus().getResponse() 로 확인 할 수 있다.
218221

219222

223+
<a id="set-element-exist"></a>
220224
## Set Element 존재여부 확인
221225

222226
Set에서 주어진 value를 가진 element의 존재여부를 확인한다.
@@ -284,6 +288,7 @@ try {
284288
3. 조회 결과에 관한 자세한 내용은 future.getOperationStatus().getResponse()로 확인이 가능하다.
285289

286290

291+
<a id="set-element-get"></a>
287292
## Set Element 조회
288293

289294
Set element를 조회하는 함수이다. 이 함수는 임의의 count 개 element를 조회한다.
@@ -350,6 +355,7 @@ try {
350355
3. 조회 결과에 관한 자세한 내용은 future.getOperationStatus().getResponse() 로 확인이 가능하다.
351356

352357

358+
<a id="set-element-bulk-insert"></a>
353359
## Set Element 일괄 삽입
354360

355361
Set에 여러 element를 한 번에 삽입하는 함수는 두 가지가 있다.
@@ -438,6 +444,7 @@ try {
438444
6. Future로부터 얻은 Map의 Key가 입력된 값(bulkData)의 index이기 때문에 위와 같은 방법으로 실패 원인을 조회하면 된다.
439445

440446

447+
<a id="set-element-bulk-exist"></a>
441448
## Set Element 일괄 존재여부 확인
442449

443450
Set에서 여러 element의 존재여부를 한 번에 확인하는 함수이다.

docs/user-guide/06-map-API.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,19 @@ Map을 Java의 Map 자료형을 저장하는 용도로 사용하길 권장한다
1010

1111
Map item에 대해 수행가능한 기본 연산은 다음과 같다.
1212

13-
- [Map Item 생성](06-map-API.md#map-item-생성)
14-
- [Map Element 삽입](06-map-API.md#map-element-삽입)
13+
- [Map Item 생성](06-map-API.md#map-item-create)
14+
- [Map Element 삽입](06-map-API.md#map-element-insert)
1515
- [Map Element Upsert](06-map-API.md#map-element-upsert)
16-
- [Map Element 변경](06-map-API.md#map-element-변경)
17-
- [Map Element 삭제](06-map-API.md#map-element-삭제)
18-
- [Map Element 조회](06-map-API.md#map-element-조회)
16+
- [Map Element 변경](06-map-API.md#map-element-update)
17+
- [Map Element 삭제](06-map-API.md#map-element-delete)
18+
- [Map Element 조회](06-map-API.md#map-element-get)
1919

2020
여러 map element들에 대해 한 번에 일괄 수행하는 연산은 다음과 같다.
2121

22-
- [Map Element 일괄 삽입](06-map-API.md#map-element-일괄-삽입)
23-
- [Map Element 일괄 변경](06-map-API.md#map-element-일괄-변경)
22+
- [Map Element 일괄 삽입](06-map-API.md#map-element-bulk-insert)
23+
- [Map Element 일괄 변경](06-map-API.md#map-element-bulk-update)
2424

25+
<a id="map-item-create"></a>
2526
## Map Item 생성
2627

2728
새로운 empty map item을 생성한다.
@@ -95,6 +96,7 @@ try {
9596
4. 생성 결과에 대한 상세 정보는 future.getOperationStatus().getResponse()를 통해 조회 할 수 있다.
9697

9798

99+
<a id="map-element-insert"></a>
98100
## Map Element 삽입
99101

100102
Map에 하나의 element를 삽입한다.
@@ -162,6 +164,7 @@ try {
162164
TimeoutException이 발생한다.
163165
3. Insert결과에 대한 자세한 결과 코드를 확인하려면 future.getOperationStatus().getResponse()를 사용한다.
164166

167+
<a id="map-element-upsert"></a>
165168
## Map Element Upsert
166169

167170
Map에 하나의 element를 upsert한다.
@@ -232,6 +235,7 @@ try {
232235
TimeoutException이 발생한다.
233236
3. Upsert 결과에 대한 자세한 결과 코드를 확인하려면 future.getOperationStatus().getResponse()를 사용한다.
234237

238+
<a id="map-element-update"></a>
235239
## Map Element 변경
236240

237241
Map에서 하나의 element를 변경하는 함수이다. Element의 value를 변경한다.
@@ -262,6 +266,7 @@ CollectionFuture<Boolean> future = mc.asyncMopUpdate(key, mkey, value);
262266
Element 수정에 대한 자세한 수행 결과는 future.getOperationStatus().getResponse()를 통해 조회할 수 있다.
263267

264268

269+
<a id="map-element-delete"></a>
265270
## Map Element 삭제
266271

267272
Map에서 element를 삭제하는 함수들은 두 가지가 있다.
@@ -332,6 +337,7 @@ try {
332337
operation queue에서 처리되지 않을 경우 TimeoutException이 발생한다
333338
3. 삭제 결과에 대한 상세 정보는 future.getOperationStatus().getResponse()를 통해 조회 할 수 있다.
334339

340+
<a id="map-element-get"></a>
335341
## Map Element 조회
336342

337343
Map element를 조회하는 함수는 세 유형이 있다.
@@ -426,6 +432,7 @@ try {
426432
3. 조회 결과에 대한 상세 정보는 future.getOperationStatus().getResponse()으로 확인한다.
427433

428434

435+
<a id="map-element-bulk-insert"></a>
429436
## Map Element 일괄 삽입
430437

431438
Map에 여러 element를 한 번에 삽입하는 함수는 두 유형이 있다.
@@ -524,6 +531,7 @@ try {
524531
6. Future로부터 얻은 Map의 Key가 입력된 값(bulkData)의 mapKey이기 때문에 위와 같은 방법으로 실패 원인을 조회하면 된다.
525532

526533

534+
<a id="map-element-bulk-update"></a>
527535
## Map Element 일괄 변경
528536

529537
Map에서 주어진 elements에 해당하는 모든 element의 value를 일괄 변경한다.

0 commit comments

Comments
 (0)