집계 빌더
이 페이지의 내용
개요
이 가이드 에서는 Laravel 통합 집계 빌더를 사용하여 애그리게이션을 수행하고 파이프라인을 구성하는 방법을 학습 수 있습니다. 집계 빌더를 사용하면 형식 안정 구문을 사용하여 MongoDB 집계 파이프라인 을 구성할 수 있습니다.
집계 파이프라인은 MongoDB database 의 데이터에 대해 변환 및 계산을 순차적으로 수행한 다음 결과를 새 문서 또는 문서 세트로 출력하는 데이터 처리 파이프라인입니다.
집계 파이프라인은 집계 단계 로 구성됩니다. 애그리게이션 단계에서는 연산자를 사용하여 입력 데이터를 처리하고 다음 단계에서 입력으로 사용할 데이터를 생성합니다.
Laravel MongoDB 애그리게이션 빌더를 사용하면 애그리게이션 단계와 집계 파이프라인을 구축할 수 있습니다. 다음 섹션에서는 집계 빌더를 사용하여 집계 파이프라인의 단계를 생성하는 방법의 예를 보여줍니다.
팁
집계 빌더 기능 은 Laravel MongoDB 버전 4.3 이상에서만 사용할 수 있습니다. 집계 빌더를 사용하지 않고 애그리게이션을 실행 방법에 학습 보려면 쿼리 빌더 가이드 에서 애그리게이션 을 참조하세요.
애그리게이션 빌더 종속성 추가
애그리게이션 빌더는 MongoDB/builder 패키지의 일부입니다. 이 패키지를 사용하려면 프로젝트에 종속성으로 추가해야 합니다. 다음 명령을 실행하여 애플리케이션에 애그리게이션 빌더 종속성을 추가합니다.
composer require mongodb/builder:^0.2
설치가 완료되면 composer.json
파일에 require
객체에 다음 줄이 포함되어 있는지 확인합니다.
"mongodb/builder": "^0.2",
집계 파이프라인 만들기
집계 파이프라인을 시작하려면 Model::aggregate()
메서드를 호출합니다. 그런 다음 실행하려는 시퀀스에 따라 애그리게이션 단계 메서드를 연결합니다.
애그리게이션 빌더에는 애그리게이션 단계를 빌드하기 위해 가져올 수 있는 다음과 같은 네임스페이스가 포함되어 있습니다.
MongoDB\Builder\Accumulator
MongoDB\Builder\Expression
MongoDB\Builder\Query
MongoDB\Builder\Type
팁
빌더 클래스에 학습 보려면 mongodb/mongodb-php-builder GitHub 리포지토리.
이 섹션에서는 일반적인 애그리게이션 단계를 사용하고 단계를 결합하여 집계 파이프라인을 구축하는 방법을 보여주는 다음 예제를 제공합니다.
MongoDB 애그리게이션 연산자에 대해 자세히 알아보려면 MongoDB Server 매뉴얼의 애그리게이션 단계 를 참조하세요.
샘플 문서
다음 예시에서는 User
모델로 표시되는 컬렉션에서 집계 파이프라인을 실행합니다. 다음 insert()
메서드를 실행하여 샘플 데이터를 추가할 수 있습니다.
User::insert([ ['name' => 'Alda Gröndal', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('2002-01-01'))], ['name' => 'Francois Soma', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1998-02-02'))], ['name' => 'Janet Doe', 'occupation' => 'designer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1987-03-03'))], ['name' => 'Eliud Nkosana', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1984-04-04'))], ['name' => 'Bran Steafan', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1998-05-05'))], ['name' => 'Ellis Lee', 'occupation' => 'designer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1996-06-06'))], ]);
매치 단계 예시
match()
메서드를 집계 파이프라인에 연결하여 쿼리 필터를 지정할 수 있습니다. 이 단계를 생략하면 aggregate()
메서드는 다음 단계에서 모델 컬렉션에 있는 모든 문서를 출력합니다.
이 애그리게이션 단계는 사용 가능한 인덱스를 사용하여 데이터를 검색하고 후속 단계에서 처리하는 데이터의 양을 줄이기 위해 가장 먼저 배치되는 경우가 많습니다.
팁
match()
메서드를 생략하면 집계 파이프라인은 다른 집계 단계 이전의 모델에 해당하는 컬렉션의 모든 문서를 일치시킵니다.
이 예시 에서는 MongoDB\Builder\Query
빌더를 사용하여 일치 집계 단계에 대한 쿼리 필터하다 를 구성합니다. 매치 단계에는 다음 기준이 포함됩니다.
Query::or()
함수를 사용하여 쿼리 필터 중 하나와 일치하는 결과를 반환합니다.Query::query()
및Query::eq()
함수를 사용하여 값이"designer"
인occupation
필드가 포함된 문서를 일치시킵니다.Query::query()
및Query::eq()
함수를 사용하여 값이"Eliud Nkosana"
인name
필드가 포함된 문서를 일치시킵니다.
VIEW OUTPUT 버튼을 클릭하면 코드를 실행하여 반환된 문서를 볼 수 있습니다.
$pipeline = User::aggregate() ->match(Query::or( Query::query(occupation: Query::eq('designer')), Query::query(name: Query::eq('Eliud Nkosana')), )); $result = $pipeline->get();
[ { "_id": ..., "name": "Janet Doe", "occupation": "designer", "birthday": { "$date": { "$numberLong": "541728000000" } } }, { "_id": ..., "name": "Eliud Nkosana", "occupation": "engineer", "birthday": { "$date": { "$numberLong": "449884800000" } } }, { "_id": ..., "name": "Ellis Lee", "occupation": "designer", "birthday": { "$date": { "$numberLong": "834019200000" } } } ]
팁
Query::or()
함수는 $or
MongoDB 쿼리 연산자에 해당합니다. 이 연산자에 대해 자세히 알아보려면 MongoDB Server 매뉴얼에서 $or 를 참조하세요.
그룹 스테이지 예시
group()
메서드를 집계 파이프라인에 연결하여 계산을 수행하고 공통 필드 값을 기준으로 그룹화하여 데이터 구조를 수정할 수 있습니다.
이 애그리게이션 단계는 데이터 후속 단계 프로세스를 줄이기 위해 매치 단계 바로 뒤에 배치되는 경우가 많습니다.
이 예제에서는 MongoDB\Builder\Expression
빌더를 사용하여 그룹 애그리게이션 단계에서 그룹 키를 정의합니다. 그룹 단계는 다음과 같은 그룹화 동작을 지정합니다.
_id
필드로 표시되는 그룹 키 값을Expression
빌더가 정의한 필드 값으로 설정합니다.Expression::fieldPath()
함수를 호출하여occupation
필드의 문서 값을 참조합니다.
VIEW OUTPUT 버튼을 클릭하면 코드를 실행하여 반환된 문서를 볼 수 있습니다.
$pipeline = User::aggregate() ->group(_id: Expression::fieldPath('occupation')); $result = $pipeline->get();
[ { "_id": "engineer" }, { "_id": "designer" } ]
팁
이 예시 단계는 distinct()
쿼리 빌더 메서드와 유사한 작업을 수행합니다. distinct()
메서드에 대해 자세히 알아보려면 고유 필드 값 조회 사용 예시를 참조하세요.
정렬 단계 예시
sort()
메서드를 집계 파이프라인에 연결하여 문서의 출력 순서를 지정할 수 있습니다.
이 애그리게이션 단계는 파이프라인의 어느 곳에서나 추가할 수 있습니다. 그룹화된 데이터에 의존할 수 있으므로 그룹 단계 뒤에 배치되는 경우가 많습니다. 처리하는 데이터를 제한하기 위해 정렬 단계를 파이프라인에서 가능한 한 늦게 배치하는 것이 좋습니다.
정렬을 지정하려면 필드 값을 오름차순 정렬의 경우 Sort::Asc
열거형으로 설정하고 내림차순 정렬의 경우 Sort::Desc
열거형으로 설정합니다.
이 예에서는 name
필드를 기준으로 문서를 알파벳 역순에 해당하는 Sort::Desc
로 정렬하는 sort()
집계 파이프라인 단계를 보여줍니다. VIEW OUTPUT 버튼을 클릭하면 코드를 실행하여 반환된 문서를 볼 수 있습니다.
$pipeline = User::aggregate() ->sort(name: Sort::Desc); $result = $pipeline->get();
[ { "_id": ..., "name": "Janet Doe", "occupation": "designer", "birthday": { "$date": { "$numberLong": "541728000000" } } }, { "_id": ..., "name": "Francois Soma", "occupation": "engineer", "birthday": { "$date": { "$numberLong": "886377600000" } } }, { "_id": ..., "name": "Ellis Lee", "occupation": "designer", "birthday": { "$date": { "$numberLong": "834019200000" } } }, { "_id": ..., "name": "Eliud Nkosana", "occupation": "engineer", "birthday": { "$date": { "$numberLong": "449884800000" } } }, { "_id": ..., "name": "Bran Steafan", "occupation": "engineer", "birthday": { "$date": { "$numberLong": "894326400000" } } }, { "_id": ..., "name": "Alda Gröndal", "occupation": "engineer", "birthday": { "$date": { "$numberLong": "1009843200000" } } } ]
프로젝트 단계 예시
project()
메서드를 집계 파이프라인에 연결하여 이 단계에서 표시할 문서의 필드를 지정할 수 있습니다.
포함할 필드를 지정하려면 필드 이름과 1
또는 true
과 같은 진실 값을 전달합니다. 다른 모든 필드는 출력에서 생략됩니다.
또는 제외할 필드를 지정하려면 각 필드 이름과 거짓 값(예: 0
또는 false
을 전달합니다. 다른 모든 필드는 출력에 포함됩니다.
팁
포함할 필드를 지정하면 _id
필드가 기본적으로 포함됩니다. _id
필드를 제외하려면 프로젝션 단계에서 명시적으로 제외합니다.
이 예에서는 project()
메서드 애그리게이션 단계를 사용하여 name
필드만 포함하고 다른 모든 필드는 출력에서 제외하는 방법을 보여 줍니다. VIEW OUTPUT 버튼을 클릭하면 코드를 실행하여 반환된 데이터를 볼 수 있습니다.
$pipeline = User::aggregate() ->project(_id: 0, name: 1); $result = $pipeline->get();
[ { "name": "Alda Gröndal" }, { "name": "Francois Soma" }, { "name": "Janet Doe" }, { "name": "Eliud Nkosana" }, { "name": "Bran Steafan" }, { "name": "Ellis Lee" } ]
집계 파이프라인 예시
이 집계 파이프라인 예제는 여러 단계를 연결합니다. 각 단계는 이전 각 단계에서 검색된 출력에서 실행됩니다. 이 예제에서 단계는 다음 작업을 순차적으로 수행합니다.
birth_year
문서에 필드를 추가하고birthday
필드에서 추출한 연도로 값을 설정합니다.occupation
필드 값을 기준으로 문서를 그룹화하고Accumulator::avg()
함수를 사용하여 각 그룹의birth_year
평균값을 계산합니다. 계산 결과를birth_year_avg
필드에 할당합니다.그룹 키 필드를 기준으로 문서를 오름차순으로 정렬합니다.
그룹 키 필드의 값에서
profession
필드를 만들고birth_year_avg
필드를 포함하고_id
필드를 생략합니다.
VIEW OUTPUT 버튼을 클릭하면 코드를 실행하여 반환된 데이터를 볼 수 있습니다.
$pipeline = User::aggregate() ->addFields( birth_year: Expression::year( Expression::dateFieldPath('birthday'), ), ) ->group( _id: Expression::fieldPath('occupation'), birth_year_avg: Accumulator::avg(Expression::numberFieldPath('birth_year')), ) ->sort(_id: Sort::Asc) ->project(profession: Expression::fieldPath('_id'), birth_year_avg: 1, _id: 0);
[ { "birth_year_avg": 1991.5, "profession": "designer" }, { "birth_year_avg": 1995.5, "profession": "engineer" } ]
참고
이 파이프라인은 match()
단계를 생략하므로 초기 단계의 입력은 컬렉션의 모든 문서로 구성됩니다.
사용자 지정 연산자 팩토리 만들기
집계 빌더를 사용하여 집계 파이프라인을 생성할 때 사용자 지정 연산자 팩토리 에서 작업 또는 단계를 정의할 수 있습니다. 사용자 지정 연산자 팩토리는 집계 파이프라인의 표현식 또는 단계를 반환하는 함수입니다. 이러한 함수를 생성하여 코드 가독성과 재사용을 개선할 수 있습니다.
이 예제에서는 지정된 날짜 필드에서 연도를 추출하는 표현식을 반환하는 사용자 지정 연산자 팩토리를 만들고 사용하는 방법을 보여 줍니다.
다음 함수는 날짜가 포함된 필드의 이름을 받아들이고 날짜에서 연도를 추출하는 표현식을 반환합니다.
public function yearFromField(string $dateFieldName): YearOperator { return Expression::year( Expression::dateFieldPath($dateFieldName), ); }
예제 집계 파이프라인에는 다음 단계가 포함됩니다.
addFields()
사용자 지정 연산자 팩토리 함수를 호출하여birthday
필드에서 연도를 추출하고 이를birth_year
필드에 할당합니다.project()
, 출력에name
및birth_year
필드만 포함
VIEW OUTPUT 버튼을 클릭하면 코드를 실행하여 반환된 데이터를 볼 수 있습니다.
$pipeline = User::aggregate() ->addFields(birth_year: $this->yearFromField('birthday')) ->project(_id: 0, name: 1, birth_year: 1);
[ { "name": "Alda Gröndal", "birth_year": 2002 }, { "name": "Francois Soma", "birth_year": 1998 }, { "name": "Janet Doe", "birth_year": 1987 }, { "name": "Eliud Nkosana", "birth_year": 1984 }, { "name": "Bran Steafan", "birth_year": 1998 }, { "name": "Ellis Lee", "birth_year": 1996 } ]