Firestore
Firestore 서비스는 사용자가 테넌트 설정에서 지정한 Firebase Admin 정보를 기반으로, 데이터베이스 연결과 데이터 조작을 손쉽게 수행할 수 있도록 해주는 기능을 제공합니다. 이 서비스를 통해 사용자는 복잡한 백엔드 구성 없이도 Firebase Firestore에 저장된 데이터를 조회, 추가, 수정, 삭제 작업을 간편하게 실행할 수 있습니다.
공통 구성 요소 설명
시스템명
서비스에서 사용 가능한 시스템 목록입니다.
모듈명
사용자가 선택한 시스템에 등록된 모듈들을 표시합니다. Firestore에서는 데이터베이스 작업을 위한 다양한 모듈이 제공됩니다. Query, Save, Update, Delete 모듈이 있으며, 이를 통해 사용자는 Firestore 데이터베이스에서 원하는 작업을 수행할 수 있습니다.
Firestore 컬렉션
Firestore의 컬렉션 명칭입니다. 서비스는 이 컬렉션을 대상으로 하여 동작하게 됩니다. 사용자는 특정 컬렉션 내의 문서에 대한 조회, 저장, 업데이트, 삭제 작업을 실행할 수 있습니다.
Query 구성 요소 설명
정렬과 검색을 같이 사용할 경우 Firestore에서 색인 등록이 필요합니다. Firestore 색인 등록 페이지에서 관련 설정을 확인하고 등록할 수 있습니다.
정렬 순서 설정
결과를 특정 필드를 기준으로 정렬하여 받아올 수 있습니다.
대상필드명
Firestore에서 결과를 정렬할 때 사용할 기준 필드명입니다. 선택한 필드를 기준으로 정렬이 이루어집니다.
정렬순서
결과의 정렬 순서를 오름차순 또는 내림차순으로 지정할 수 있습니다. 이 설정에 따라 쿼리 결과의 순서가 결정됩니다.
검색
Firestore 서비스에서 Query를 설정할 때, 조건부 검색을 통해 필요한 데이터를 효과적으로 필터링할 수 있습니다.
필드 명
쿼리 조건을 적용할 대상 필드명입니다. 이 필드를 기준으로 지정한 조건에 따라 데이터를 검색하게 됩니다.
Operator
필드에 적용할 조건 연산자입니다.
지원하는 연산자로는 == , != , < , <= , > , >= 이 있습니다.
필드값 컬렉션 키
조건 비교 대상이 되는 값을 가진 컬렉션 키를 지정합니다. 이 컬렉션 키에 해당하는 값과 필드 명에 지정된 필드의 값이 지정된 연산자에 따라 비교됩니다.
Update 구성 요소 설명
Update 타입
Firestore 의 문서를 업데이트 하는 타입을 지정할 수 있습니다.
전체 수정 : 보내진 데이터를 그대로 사용하여 대상 문서를 덮어씁니다.
부분 수정 : 지정된 필드만을 수정합니다.
필드 명
업데이트할 대상 필드명입니다. 이 필드에 지정된 값이 업데이트 작업의 대상이 됩니다.
Update Value 타입
업데이트할 값의 타입을 지정합니다.
컬렉션키: 보내진 데이터 중 해당 컬렉션키에 해당하는 값으로 필드를 업데이트합니다.
FieldValue 함수: Firestore의
FieldValue함수(increment,delete)를 사용하여 필드 값을 업데이트합니다.
필드 값 컬렉션 키
업데이트할 값이 있는 컬렉션키를 지정합니다. 보네는 데이터에서 해당 키 값으로 지정된 필드가 업데이트됩니다.
필드 값 함수
필드 값을 조작하는 함수입니다.
increment(1): 값을 1만큼 증가시킵니다.
increment(-1): 값을 1만큼 감소시킵니다.
delete(): 해당 필드를 문서에서 삭제합니다.
추가설명
모듈별 이벤트 데이터
| 모듈명 | 보내는 데이터 | 받는 데이터 |
|---|---|---|
Query | ParamBlock1의 첫 번째 섹터를 조건 데이터로 사용합니다. 이 데이터는 쿼리 실행 시 검색 조건으로 활용됩니다. | 쿼리 실행 결과로 조회된 데이터를 반환합니다. |
Save | ParamBlock1의 모든 섹터를 그대로 데이터베이스에 저장합니다. 이 과정에서 전달된 모든 데이터는 새로운 문서로 생성됩니다. | 저장된 문서의 _SUID를 포함한 저장 결과를 반환합니다. |
Update | ParamBlock1의 모든 섹터를 업데이트 조건에 맞게 수정하여 저장합니다. 이 데이터는 기존 문서를 업데이트하는 데 사용됩니다. | 업데이트된 문서의 _SUID를 포함한 업데이트 결과를 반환합니다. |
Delete | ParamBlock1의 모든 섹터에 해당하는 문서를 삭제합니다. 이 데이터는 삭제할 문서의 식별자로 사용됩니다. | 삭제된 문서의 _SUID를 반환합니다. |
Last updated
