Get Started with Couchbase Collections Using the Demo App

컬렉션은 Couchbase 6.5의 새로운 기능입니다. 컬렉션을 사용하면 관계형 데이터베이스의 테이블이 각 데이터베이스 내에서 유사한 레코드를 수집하는 것처럼 각 버킷 내에서 유사한 문서를 그룹화할 수 있습니다. 컬렉션은 Couchbase 7.0에서 완전히 지원될 예정이지만, 지금 바로 Couchbase 6.5 릴리스에서 개발자 프리뷰 기능으로 사용해 볼 수 있습니다. 데모 애플리케이션에서는 이미 컬렉션을 사용하고 있습니다.

컬렉션이란 무엇인가요?
관계형 데이터베이스의 세계에서 왔다면 컬렉션을 테이블로 생각할 수 있습니다. 관계형 테이블의 모든 레코드가 같은 유형인 것처럼 카우치베이스 컬렉션 내의 모든 문서는 같은 유형이어야 합니다. 관계형 스키마에는 '고객' 테이블이나 '제품' 테이블이 있을 수 있고, 마찬가지로 카우치베이스 버킷에는 '고객' 컬렉션이 있을 수 있습니다.

이전 버전의 Couchbase에서는 데이터가 다음과 같이 구성되었습니다:

클러스터
- 버킷
  - 문서

Couchbase 6.5에서는 다음과 같이 두 개의 레이어가 더 있습니다:

클러스터
- 버킷
  - 범위
    - 컬렉션
      - 문서

컬렉션은 어떻게 유용할까요?

컬렉션은 가장 낮은 수준의 문서 정리이며 문서를 직접 포함합니다. 컬렉션은 이전보다 더 정확하게 문서를 그룹화할 수 있기 때문에 유용합니다. 다양한 유형의 문서(제품, 주문, 고객)를 모두 하나의 버킷에 덤프하고 유형 필드로 구분하는 대신 각 유형에 대해 컬렉션을 만들 수 있습니다. 그리고 쿼리할 때 전체 버킷이 아닌 컬렉션을 대상으로 쿼리할 수 있습니다. 또한 궁극적으로는 컬렉션 수준에서 액세스를 제어할 수 있게 됩니다.

범위는 컬렉션보다 상위의 조직 수준입니다. 범위에는 컬렉션이 포함되고 컬렉션에는 문서가 포함됩니다. Couchbase 클러스터의 용도에 따라 범위를 사용하는 방법은 여러 가지가 있습니다. 회사의 다양한 내부 애플리케이션을 지원하는 경우 각 애플리케이션마다 고유한 범위를 가져야 합니다. 클러스터가 각각 애플리케이션의 자체 복사본을 실행하는 여러 클라이언트 조직에 서비스를 제공하는 데 사용되는 경우, 각 복사본은 자체 범위를 가져야 합니다. 마찬가지로, 개발 그룹에서 클러스터를 테스트용으로 사용하는 경우 할당 단위는 스코프여야 합니다. 각각의 경우에 소유자는 할당된 범위 내에서 원하는 컬렉션을 만들 수 있습니다.

범위는 해당 버킷 내에서 고유해야 하고 컬렉션은 해당 범위 내에서 고유해야 합니다. 따라서 '기본' 버킷에는 각각 고유한 '제품' 및 '고객' 컬렉션이 있는 두 개의 범위 'dev'와 'prod'가 포함될 수 있습니다.

컬렉션 사용

최신 버전의 카우치베이스 데모 애플리케이션에서 사용 중인 컬렉션과 범위는 여기에서 확인할 수 있습니다:

https://github.com/couchbaselabs/try-cb-java/tree/6.5.0-branch

이 애플리케이션은 기존의 '여행 샘플' 버킷을 그대로 사용하여 사용자가 항공편과 호텔을 검색할 수 있도록 하되, 자체 사용자 및 예약 데이터를 컬렉션에 저장합니다. 사용 중인 구조는 다음과 같습니다:

버킷: 기본값
- 범위: 라슨 여행
  - 수집: 사용자
  - 수집: 항공편

사용자가 계정을 만들면 '사용자' 컬렉션에 문서가 생성됩니다. 사용자가 항공편을 예약하면 '항공편' 컬렉션에 문서가 생성되고 '사용자' 컬렉션의 사용자 문서에서 참조할 수 있습니다.

이 디자인을 사용하면 여러 애플리케이션이 동일한 버킷을 공유할 수 있습니다. 다른 여행사에서 사용하는 데모 앱의 두 번째 인스턴스가 있는 경우, 자체 "사용자" 및 "항공편" 컬렉션이 있는 다른 범위를 만들고 application.properties 파일을 업데이트하여 두 번째 인스턴스가 이 범위를 가리키도록 하면 됩니다. 두 인스턴스는 서로 간섭하지 않고 나란히 작동합니다.

코드 예시

우선, 사용자 및 예약 정보가 포함된 버킷과 범위의 이름은 application.properties 파일에 지정됩니다:

storage.clientorg.bucket=default
storage.clientorg.scope=larson-travel

1 2	스토리지.클라이언트.버킷=기본값 스토리지.클라이언트.범위=larson-여행

이러한 구성 값은 Database.java 파일에서 가져옵니다:

@Configuration
public class Database {

    ...

    @Value("${storage.clientorg.bucket}")
    private String clientOrgBucket;

    @Value("${storage.clientorg.scope}")
    private String clientOrgScope;

    ...

    public Bucket clientOrgBucket() {
        return loginCluster().bucket(clientOrgBucket);
    }

    public @Bean Scope clientOrgScope() {
        return clientOrgBucket().scope(clientOrgScope);
    }

}

@Configuration

public 클래스 데이터베이스 {

...

@Value("${storage.clientorg.bucket}")

비공개 문자열 클라이언트 조직 버킷;

@Value("${storage.clientorg.scope}")

비공개 문자열 클라이언트 조직 범위;

...

public 버킷 클라이언트 조직 버킷() {

반환 로그인클러스터().버킷(클라이언트 조직 버킷);

}

public @Bean 범위 클라이언트 조직 범위() {

반환 클라이언트 조직 버킷().범위(클라이언트 조직 범위);

}

User.java에서는 사용자에 대한 새 항공편이 등록되는 방법을 볼 수 있습니다. 위에서 생성한 범위 빈이 전달됩니다. 사용자 이름은 사용자가 로그인한 아이디입니다.

    public Result<Map<String, Object>> registerFlightForUser(final Scope scope, 
        final String username, final JsonArray newFlights) {

1 2	public 결과<지도<문자열, 개체>> 등록 비행 사용자(final 범위 범위, final 문자열 사용자 이름, final JsonArray 새로운 항공편) {

사용자 문서의 ID는 사용자의 사용자 이름입니다. 애플리케이션은 애플리케이션에서 사용하는 컬렉션의 "사용자" 컬렉션에서 가져오는 것을 알고 있습니다.

        String userId = username;
        Collection usersCollection = scope.collection(USERS_COLLECTION_NAME);
        Collection flightsCollection = scope.collection(FLIGHTS_COLLECTION_NAME);
        Optional<GetResult> userDataFetch = usersCollection.get(userId);
        if (!userDataFetch.isPresent()) {
            throw new IllegalStateException();
        }
        JsonObject userData = userDataFetch.get().contentAsObject();

        if (newFlights == null) {
            throw new IllegalArgumentException("No flights in payload");
        }

        JsonArray added = JsonArray.empty();

문자열 userId = 사용자 이름;

컬렉션 사용자 컬렉션 = 범위.컬렉션(사용자_컬렉션_이름);

컬렉션 항공편 컬렉션 = 범위.컬렉션(항공편_수집_이름);

선택 사항<GetResult> 사용자 데이터 가져오기 = 사용자 컬렉션.get(userId);

만약 (!사용자 데이터 가져오기.isPresent()) {

throw new 불법 상태 예외();

}

JsonObject 사용자 데이터 = 사용자 데이터 가져오기.get().contentAsObject();

만약 (새로운 항공편 == null) {

throw new IllegalArgumentException("페이로드에 항공편 없음");

}

JsonArray 추가 = JsonArray.빈();

사용자가 예약한 항공편은 사용자 문서에 '항공편'이라는 이름의 배열로 저장됩니다.

        JsonArray allBookedFlights = userData.getArray("flights");
        if(allBookedFlights == null) {
            allBookedFlights = JsonArray.create();
        }

JsonArray 모든 예약 항공편 = 사용자 데이터.getArray("항공편");

만약(모든 예약 항공편 == null) {

모든 예약 항공편 = JsonArray.create();

}

기존 항공편에 새 항공편을 추가합니다.

        for (Object newFlight : newFlights) {
            checkFlight(newFlight);
            JsonObject t = ((JsonObject) newFlight);
            t.put("bookedon", "try-cb-java");
            String flightId = UUID.randomUUID().toString();
            flightsCollection.insert(flightId, t);
            allBookedFlights.add(flightId);
            added.add(t);
        }

        userData.put("flights", allBookedFlights);

에 대한 (개체 새로운 비행 : 새로운 항공편) {

체크플라이트(새로운 비행);

JsonObject t = ((JsonObject) 새로운 비행);

t.put("bookedon", "try-cb-java");

문자열 flightId = UUID.randomUUID().toString();

항공편 컬렉션.삽입(flightId, t);

모든 예약 항공편.추가(flightId);

추가.추가(t);

}

사용자 데이터.put("항공편", 모든 예약 항공편);

그런 다음 새 버전의 사용자 문서를 저장합니다.

        usersCollection.upsert(userId, userData);

        JsonObject responseData = JsonObject.create()
            .put("added", added);

        return Result.of(responseData.toMap(), 
            "Booked flight in Couchbase document " + userId);
    }

사용자 컬렉션.업서트(userId, 사용자 데이터);

JsonObject 응답데이터 = JsonObject.create()

.put("추가된", 추가);

반환 결과.의(응답데이터.toMap(),

"카우치베이스 문서에서 예약한 항공편" + userId);

}

바로 아래에서 사용자의 항공편이 검색되는 방식을 확인할 수 있습니다.

    public List<Map<String, Object>> getFlightsForUser(final Scope scope, 
        final String username) {

1 2	public 목록<지도<문자열, 개체>> getFlightsForUser(final 범위 범위, final 문자열 사용자 이름) {

'사용자' 컬렉션에서 사용자 문서를 가져옵니다.

        Collection users = scope.collection(USERS_COLLECTION_NAME);
        Optional<GetResult> doc = users.get(username);
        if (!doc.isPresent()) {
            return Collections.emptyList();
        }
        JsonObject data = doc.get().contentAsObject();

컬렉션 사용자 = 범위.컬렉션(사용자_컬렉션_이름);

선택 사항<GetResult> doc = 사용자.get(사용자 이름);

만약 (!doc.isPresent()) {

반환 컬렉션.빈 목록();

}

JsonObject 데이터 = doc.get().contentAsObject();

사용자 문서에서 '항공편' 배열을 가져옵니다. 여기에는 항공편 ID 목록이 포함됩니다.

        JsonArray flights = data.getArray("flights");
        if (flights == null) {
            return Collections.emptyList();
        }

JsonArray 항공편 = 데이터.getArray("항공편");

만약 (항공편 == null) {

반환 컬렉션.빈 목록();

}

ID로 '항공편' 컬렉션에서 각 항공편 문서를 검색합니다.

        // The "flights" array contains flight ids. Convert them to actual objects.
        Collection flightsCollection = scope.collection(FLIGHTS_COLLECTION_NAME);
        List<Map<String, Object>> results = new ArrayList<Map<String, Object>>();
        for (int i = 0; i < flights.size(); i++) {
            String flightId = flights.getString(i);
            Optional<GetResult> res = flightsCollection.get(flightId);
            if (!res.isPresent()) {
                throw new RuntimeException("Unable to retrieve flight id " + flightId);
            }
            Map<String, Object> flight = res.get().contentAsObject().toMap();
            results.add(flight);
        }
        return results;
    }

// "항공편" 배열에는 항공편 ID가 포함됩니다. 이를 실제 객체로 변환합니다.

컬렉션 항공편 컬렉션 = 범위.컬렉션(항공편_수집_이름);

목록<지도<문자열, 개체>> 결과 = new ArrayList<지도<문자열, 개체>>();

에 대한 (int i = 0; i < 항공편.크기(); i++) {

문자열 flightId = 항공편.getString(i);

선택 사항<GetResult> res = 항공편 컬렉션.get(flightId);

만약 (!res.isPresent()) {

throw new 런타임 예외("항공편 ID를 검색할 수 없습니다." + flightId);

}

지도<문자열, 개체> 비행 = res.get().contentAsObject().toMap();

결과.추가(비행);

}

반환 결과;

}

이전 코드에서 변경된 사항

컬렉션을 사용하지 않았던 이전 버전에서는 사용자 및 사용자 항공편에 대한 작업 코드가 상당히 달랐습니다. 이전 버전에서는 예약된 항공편이 사용자 문서에 직접 저장되었습니다. 사용자 문서는 '여행 샘플' 테이블에 직접 저장되었습니다. 다음은 registerFlightForUser() 함수의 원본 코드입니다.

   public Result<Map<String, Object>> registerFlightForUser(final Bucket bucket,
 	final String username, final JsonArray newFlights) {

1 2	public 결과<지도<문자열, 개체>> 등록 비행 사용자(final 버킷 버킷, final 문자열 사용자 이름, final JsonArray 새로운 항공편) {

문서 유형을 표시하기 위해 접두사를 사용하는 것을 주목하세요. 컬렉션을 사용할 수 있게 되면 이 접두사는 필요하지 않습니다.

        JsonDocument userData = bucket.get("user::" + username);
        if (userData == null) {
            throw new IllegalStateException();
        }

        if (newFlights == null) {
            throw new IllegalArgumentException("No flights in payload");
        }

        JsonArray added = JsonArray.empty();

JsonDocument 사용자 데이터 = 버킷.get("user::" + 사용자 이름);

만약 (사용자 데이터 == null) {

throw new 불법 상태 예외();

}

만약 (새로운 항공편 == null) {

throw new IllegalArgumentException("페이로드에 항공편 없음");

}

JsonArray 추가 = JsonArray.빈();

문서에 이미 있는 항공편 배열을 검색합니다.

        JsonArray allBookedFlights = userData.content().getArray("flights");
        if(allBookedFlights == null) {
            allBookedFlights = JsonArray.create();
        }

        for (Object newFlight : newFlights) {
            checkFlight(newFlight);
            JsonObject t = ((JsonObject) newFlight);
            t.put("bookedon", "try-cb-java");

JsonArray 모든 예약 항공편 = 사용자 데이터.콘텐츠().getArray("항공편");

만약(모든 예약 항공편 == null) {

모든 예약 항공편 = JsonArray.create();

}

에 대한 (개체 새로운 비행 : 새로운 항공편) {

체크플라이트(새로운 비행);

JsonObject t = ((JsonObject) 새로운 비행);

t.put("bookedon", "try-cb-java");

예약된 항공편 배열에 항공편을 추가합니다.

            allBookedFlights.add(t);
            added.add(t);
        }

        userData.content().put("flights", allBookedFlights);

모든 예약 항공편.추가(t);

추가.추가(t);

}

사용자 데이터.콘텐츠().put("항공편", 모든 예약 항공편);

그리고 사용자 문서를 저장합니다.

        JsonDocument response = bucket.upsert(userData);

        JsonObject responseData = JsonObject.create()
            .put("added", added);

        return Result.of(responseData.toMap(), "Booked flight in Couchbase document " + response.id());
    }

JsonDocument 응답 = 버킷.업서트(사용자 데이터);

JsonObject 응답데이터 = JsonObject.create()

.put("추가된", 추가);

반환 결과.의(응답데이터.toMap(), "카우치베이스 문서에서 예약한 항공편" + 응답.id());

}

물론 장난감 애플리케이션에서 예약된 항공편을 사용자로부터 분리하는 것은 그다지 매력적이지 않습니다. 하지만 각 사용자에 대한 다양한 유형의 정보를 저장하는 프로덕션 애플리케이션에서는 일부 기록, 특히 규모가 크거나 수가 많거나 자주 변경되기 쉬운 기록은 사용자 문서 외부에 저장하는 것이 합리적일 수 있습니다.

범위 및 컬렉션 문서

범위 및 컬렉션으로 직접 작업하는 방법에 대해 자세히 알아보려면 다음을 참조하세요. 이 문서에서 두 가지 작업을 위한 RESTful API, 관련 CLI 명령 및 다음에서 사용할 수 있는 컬렉션에 대한 정보를 설명합니다. cbstats.

요약

테이블과 스키마로 관계형 데이터베이스 내에서 행을 정리하는 것처럼 컬렉션과 범위를 사용하면 Couchbase 버킷 내에서 문서를 정리할 수 있습니다. 현재 Couchbase 6.5 GA 릴리즈는 개발자 프리뷰 기능으로 컬렉션 및 범위를 제한적으로 초기 지원합니다. 컬렉션 및 범위를 시작하려면 지금 바로 Java 데모 애플리케이션으로 작업을 시작할 수 있습니다.

리소스

다운로드

Couchbase Server 6.5 다운로드

문서

카우치베이스 컬렉션 6.5 문서

카우치베이스 서버 6.5 릴리스 노트

카우치베이스 서버 6.5의 새로운 기능

블로그

컬렉션 소개 - 카우치베이스 서버 6.5의 개발자 프리뷰

Couchbase Server 6.5 발표 - 새로운 기능 및 개선 사항

6.5 블로그 모두 보기

요한 라슨

댓글 하나

우마이르 말릭 8월 16, 2019에서 2:46 오전

안녕하세요 요한, 이것은 데이터 판별자 속성을 기반으로 다중 테넌시를 구현하는 애플리케이션을 위해 특별히 좋은 기능입니다. 그래서 한 가지 알고 싶은 것은 여러 범위에서 쿼리를 실행할 수 있습니까? 일부 쿼리의 경우 여러 범위에서 데이터를 가져오고 다른 쿼리의 경우 단일 범위에서 데이터를 가져와야하는 것처럼. 그렇다면 카우치베이스 6.5 버전에서 가능한가요? 고마워요

로그인 하여 답글 남기기
요한 라슨 8월 16, 2019에서 5:25 오전

안녕하세요, Malik. 6.5에서는 컬렉션에 대해 N1QL 쿼리를 작성할 수 없습니다. 현재 N1QL 쿼리는 과거와 마찬가지로 컬렉션에 대해서는 작동하지 않고 버킷에 대해서만 작동합니다. 컬렉션에 대한 N1QL은 7.0에서 제공될 예정이며, 아마도 2020년에 출시될 것입니다.

컬렉션에서 N1QL이 작동하게 되면, 현재 여러 버킷에 걸쳐 있는 N1QL 쿼리를 작성할 수 있는 것처럼 여러 범위에 걸쳐 있는 쿼리를 작성할 수 있게 됩니다.

로그인 하여 답글 남기기
pccb 6월 29, 2021에서 9:44 오전

"관계형 테이블의 모든 레코드가 동일한 유형인 것처럼 카우치베이스 컬렉션 내의 모든 문서는 동일한 유형이어야 한다"는 의미는 컬렉션 내의 모든 문서가 동일한 필드를 가져야 한다는 의미인가요?

고마워요

로그인 하여 답글 남기기

Platform

Self-Managed

Services

Capabilities

Why Couchbase?

Migrate to Capella

By Use Case

By Industry

By Application Need

Popular Docs

By Developer Role

Quickstart

Resource Center

About

Partnerships

Our Services

Partners: Register a Deal

Ready to register a deal with Couchbase?

Marriott

모든 게시물

데모 앱을 사용하여 카우치베이스 컬렉션 시작하기

리소스

작성자

게시자 요한 라슨

댓글 하나

댓글 남기기 응답 취소