Google Cloud Firestore 트리거(1세대)
Cloud Functions는 함수와 동일한 Google Cloud 프로젝트의 Cloud Firestore에서 이벤트를 처리할 수 있습니다. Firestore API 및 클라이언트 라이브러리를 사용하여 이러한 이벤트에 대한 응답으로 Cloud Firestore를 읽거나 업데이트 할 수 있습니다.
일반적인 처리 과정에서 Cloud Firestore 함수는 다음을 수행합니다.
특정 문서가 변경되기를 기다립니다.
이벤트가 발생하면 트리거되어 작업을 수행합니다.
영향을 받는 문서의 스냅샷이 있는 데이터 객체를 수신합니다.
write
또는update
이벤트의 경우 데이터 객체에는 이벤트 트리거 전후의 문서 상태를 나타내는 스냅샷이 포함됩니다.
이벤트 유형
Cloud Firestore는 create
, update
, delete
, write
이벤트를 지원합니다. write
이벤트는 문서에 대한 모든 수정사항을 포함합니다.
이벤트 유형 | 트리거 |
---|---|
providers/cloud.firestore/eventTypes/document.create (기본) |
문서를 처음으로 기록할 때 트리거됩니다. |
providers/cloud.firestore/eventTypes/document.update |
이미 존재하는 문서에서 값이 변경되었을 때 트리거됩니다. |
providers/cloud.firestore/eventTypes/document.delete |
데이터가 있는 문서가 삭제되면 트리거됩니다. |
providers/cloud.firestore/eventTypes/document.write |
문서가 생성, 업데이트 또는 삭제되면 트리거됩니다. |
와일드 카드는 다음과 같이 중괄호를 사용하여 트리거에 작성됩니다. "projects/YOUR_PROJECT_ID/databases/(default)/documents/collection/{document_wildcard}"
문서 경로 지정
함수를 트리거하려면 리슨할 문서 경로를 지정합니다. 함수는 문서 변경에만 응답하며 특정 필드나 컬렉션을 모니터링할 수 없습니다. 다음은 유효한 문서 경로의 몇 가지 예시입니다.
users/marie
: 유효한 트리거입니다. 단일 문서/users/marie
를 모니터링합니다.users/{username}
: 유효한 트리거입니다. 모든 사용자 문서를 모니터링합니다. 와일드 카드를 사용하면 컬렉션의 모든 문서를 모니터링할 수 있습니다.users/{username}/addresses
: 트리거가 잘못되었습니다. 문서가 아닌 하위 컬렉션addresses
를 나타냅니다.users/{username}/addresses/home
: 유효한 트리거입니다. 모든 사용자에 대한 집 주소 문서를 모니터링합니다.users/{username}/addresses/{addressId}
: 유효한 트리거입니다. 모든 주소 문서를 모니터링합니다.
와일드 카드 및 매개변수 사용
모니터링할 특정 문서를 알 수 없는 경우에는 문서 ID 대신 {wildcard}
를 사용합니다.
users/{username}
은 모든 사용자 문서에 대한 변경을 리슨합니다.
이 예시에서 users
의 문서에서 필드가 변경되면 필드는 {username}
라는 와일드 카드와 일치합니다.
users
의 문서에 하위 컬렉션이 있고, 이 하위 컬렉션 문서 중 하나에서 필드가 변경되면 {username}
와일드 카드가 트리거되지 않습니다.
와일드 카드 일치는 문서 경로에서 추출됩니다. 원하는 만큼 와일드 카드를 정의하여 명시적 컬렉션 또는 문서 ID를 대체할 수 있습니다.
이벤트 구조
이 트리거는 아래와 유사한 이벤트로 함수를 호출합니다.
{ "oldValue": { // Update and Delete operations only A Document object containing a pre-operation document snapshot }, "updateMask": { // Update operations only A DocumentMask object that lists changed fields. }, "value": { // A Document object containing a post-operation document snapshot } }
각 Document
객체에는 Value
객체가 하나 이상 포함됩니다. 유형 참조는 Value
문서를 참조하세요. 특히 Go와 같은 입력 언어를 사용하여 함수를 작성하는 경우에 유용합니다.
코드 샘플
아래의 Cloud 함수 샘플은 트리거하는 Cloud Firestore 이벤트의 필드를 출력합니다.
Node.js
Python
Go
Java
C#
Ruby
PHP
아래 예시에서는 사용자가 추가한 값을 검색하고 해당 위치의 문자열을 대문자로 변환한 후 해당 값을 대문자 문자열로 바꿉니다.
Node.js
Python
Go
Java
C#
Ruby
PHP
함수 배포
다음 gcloud
명령어는 /messages/{pushId}
문서의 쓰기 이벤트에 의해 트리거되는 함수를 배포합니다.
gcloud functions deploy FUNCTION_NAME \ --entry-point ENTRY_POINT \ --runtime RUNTIME \ --trigger-event "providers/cloud.firestore/eventTypes/document.write" \ --trigger-resource "projects/YOUR_PROJECT_ID/databases/(default)/documents/messages/{pushId}"
인수 | 설명 |
---|---|
FUNCTION_NAME |
배포 중인 Cloud 함수의 등록된 이름입니다.
소스 코드의 함수 이름 또는 임의의 문자열일 수 있습니다. FUNCTION_NAME이 임의의 문자열이면 --entry-point 플래그를 포함해야 합니다.
|
--entry-point ENTRY_POINT |
소스 코드의 함수 또는 클래스 이름입니다. FUNCTION_NAME 을 사용하여 배포 중에 실행할 소스 코드에 함수를 지정하지 않은 경우 선택사항입니다. 이러한 경우 --entry-point 를 사용하여 실행 가능한 함수의 이름을 제공해야 합니다.
|
--runtime RUNTIME |
사용 중인 런타임 이름입니다. 전체 목록은 gcloud 참조에서 확인할 수 있습니다.
|
--trigger-event NAME |
함수에서 모니터링할 이벤트 유형입니다(write , create , update 또는 delete 중 하나). |
--trigger-resource NAME |
함수가 리슨할 정규화된 데이터베이스 경로입니다.
"projects/YOUR_PROJECT_ID/databases/(default)/documents/PATH" 형식을 따라야 합니다. {pushId} 텍스트는 위의 문서 경로 지정에서 설명한 와일드 카드 매개변수입니다.
|
제한사항
Cloud Functions용 Firestore 트리거의 다음 제한사항에 유의하세요.
- Cloud Functions(1세대)는 Firestore 기본 모드의 기존 '(기본값)' 데이터베이스를 기본 요건으로 합니다. 이름이 지정된 Firestore 데이터베이스 또는 Datastore 모드는 지원하지 않습니다. 이러한 경우 Cloud Functions(2세대)를 사용하여 이벤트를 구성하세요.
- 순서는 보장되지 않습니다. 급격하게 변경하면 예기치 않은 순서로 함수 호출이 트리거될 수 있습니다.
- 이벤트는 최소 1회 전송되지만 하나의 이벤트에 함수가 여러 번 호출될 수 있습니다. 정확히 한 번에 처리하는 메커니즘에 의존하지 말고 멱등 함수를 작성하세요.
- Datastore 모드의 Cloud Firestore에는 Cloud Functions(2세대)가 필요합니다. Cloud Functions(1세대)는 Datastore 모드를 지원하지 않습니다.
- 트리거는 단일 데이터베이스와 연결됩니다. 여러 데이터베이스와 일치하는 트리거를 만들 수 없습니다.
- 데이터베이스를 삭제해도 해당 데이터베이스의 트리거가 자동으로 삭제되지 않습니다. 트리거가 이벤트 제공을 중지하지만 트리거를 삭제하기 전까지 계속 존재합니다.
- 일치하는 이벤트가 최대 요청 크기를 초과하면 이벤트가 Cloud Functions(1세대)로 전달되지 않을 수 있습니다.
- 요청 크기로 인해 전달되지 않은 이벤트는 플랫폼 로그에 로깅되고 프로젝트의 로그 사용량에 포함됩니다.
- 이러한 로그는 로그 탐색기에서 '크기가 1세대... 한도를 초과하여 Cloud 함수에 이벤트를 전송할 수 없음'이라는
error
심각도의 메시지와 함께 확인할 수 있습니다.functionName
필드에서 함수 이름을 확인할 수 있습니다.receiveTimestamp
필드가 지금부터 1시간 이내인 경우 타임스탬프 전후의 스냅샷과 함께 해당 문서를 읽어 실제 이벤트 콘텐츠를 추론할 수 있습니다. - 이러한 주기를 피하려면 다음을 수행하면 됩니다.
- Cloud Functions(2세대)로 마이그레이션 및 업그레이드
- 문서 크기 축소
- 해당 Cloud Functions 삭제
- 제외를 사용하여 로깅 자체를 사용 중지할 수 있지만 그래도 문제가 되는 이벤트가 전송되지 않습니다.