본문으로 건너뛰기

키-값 저장소 (kvstore)

진도처럼 작은 값을 서버에 저장하고 읽습니다. 값은 나 · 이 자료 단위이고, 누구의 값인지는 서버가 토큰으로 정합니다.

개인정보 금지

key · 값에 학습자 개인정보(이름 · 연락처 · 학번 등)를 저장하지 마세요. 값은 서버에 남고 교육자 · 운영자 · 튜터가 볼 수 있습니다. 누구의 값인지는 서버가 토큰으로 정하므로 이름이나 id를 값에 넣을 필요가 없습니다.

await sdk.kvstore.post({ key: 'userProgress', value: { step: 3, completed: false } });
const step = await sdk.kvstore.get<number>({ key: 'userProgress.step' }); // 3
await sdk.kvstore.delete('userProgress');

// 저장한 값 전체: 맨 위 key별 { key: value }
const all = await sdk.kvstore.get({ key: '' }); // { userProgress: { … }, … }

key 규칙​

  • 영문 · 숫자 · _ · 한글(가–힣) 이름을 .로 이은 경로입니다(최대 256자). 예: userProgress.step
  • post · delete는 빈 key를 받지 않습니다. get({ key: '' })은 맨 위 key 전체를 { key: value }로 돌려줍니다.
  • 형식이 틀리면 서버에 묻기 전에 invalid_param입니다.

동작​

  • 없는 값은 null이고, 없는 key의 delete는 오류가 아닙니다.
  • post는 경로 중간의 없는 객체를 만듭니다. 경로 중간 값이 객체가 아니면 invalid_input입니다.
  • 값은 JSON으로 저장되고, key · 값 안의 이름(userProgress, snake_key 등)은 바꾸지 않고 그대로 주고받습니다.
  • 튜터는 보고 있는 학생의 값을 읽습니다. 튜터의 저장 · 삭제는 read_only_mode입니다.

한도​

한도넘으면
이 자료의 내 값 전체 512KBstorage_limit_exceeded
저장 · 삭제 초당 20번rate_limited