Package google.firestore.v1

map<string, Value>

집계 함수의 결과입니다(예: COUNT(*) AS total_docs).

키는 입력 시 집계 함수에 할당된 alias이며 이 맵의 크기는 쿼리의 집계 함수 수와 같습니다.

Value

배열의 값입니다.

string

필수 항목입니다. 데이터베이스 이름입니다. 형식은 projects/{project_id}/databases/{database_id}입니다.

string

검색할 문서의 이름입니다. 형식은 projects/{project_id}/databases/{database_id}/documents/{document_path}입니다. 문서가 지정된 database의 하위 리소스가 아닌 경우 요청이 실패합니다. 중복된 이름은 생략됩니다.

DocumentMask

반환할 필드입니다. 설정하지 않으면 모든 필드가 반환됩니다.

문서에 이 마스크에 없는 필드가 있으면 해당 필드는 응답으로 반환되지 않습니다.

bytes

트랜잭션의 문서를 읽습니다.

TransactionOptions

새 트랜잭션을 시작하고 문서를 읽습니다. 기본값은 읽기 전용 트랜잭션입니다. 새 트랜잭션 ID가 스트림의 첫 번째 응답으로 반환됩니다.

Timestamp

지정된 시점의 문서를 읽습니다.

지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 1분짜리 타임스탬프일 수도 있습니다.

bytes

이 요청의 일부로 시작된 트랜잭션입니다. 요청에서 BatchGetDocumentsRequest.new_transaction가 설정된 경우에만 첫 번째 응답에서만 설정됩니다.

Timestamp

문서를 읽은 시간입니다. 이는 단조 증가할 수 있습니다. 이 경우 결과 스트림의 이전 문서가 read_time과 이 문서 간에 변경되지 않은 것이 보장됩니다.

Document

요청된 문서입니다.

string

요청했지만 존재하지 않는 문서 이름입니다. 형식은 projects/{project_id}/databases/{database_id}/documents/{document_path}입니다.

string

필수 항목입니다. 데이터베이스 이름입니다. 형식은 projects/{project_id}/databases/{database_id}입니다.

Write

적용할 쓰기입니다.

메서드는 쓰기를 원자적으로 적용하지 않으며 순서를 보장하지 않습니다. 각 쓰기는 독립적으로 성공하거나 실패합니다. 동일한 문서에 요청당 두 번 이상 작성할 수 없습니다.

map<string, string>

이 일괄 쓰기와 연결된 라벨입니다.

WriteResult

쓰기를 적용한 결과입니다.

이 i번째 쓰기 결과는 요청의 i번째 쓰기에 해당합니다.

Status

쓰기 적용 상태입니다.

이 i번째 쓰기 상태는 요청의 i번째 쓰기에 해당합니다.

string

필수 항목입니다. 데이터베이스 이름입니다. 형식은 projects/{project_id}/databases/{database_id}입니다.

TransactionOptions

거래 옵션입니다. 기본값은 읽기-쓰기 트랜잭션입니다.

bytes

시작된 트랜잭션입니다.

bytes

비트 시퀀스를 인코딩하는 바이트입니다. 길이는 0일 수도 있습니다.

int32

'패딩'으로 무시할 bitmap에서 마지막 바이트의 비트 수입니다. bitmap의 길이가 0이면 이 값은 0이어야 합니다. 그 외의 경우에는 이 값은 0 이상, 7 이하여야 합니다.

BitSequence

블룸 필터 데이터입니다.

int32

알고리즘에서 사용하는 해시 수입니다.

string

필수 항목입니다. 데이터베이스 이름입니다. 형식은 projects/{project_id}/databases/{database_id}입니다.

Write

적용할 쓰기입니다.

항상 원자적으로 순서대로 실행됩니다.

bytes

설정되면 이 트랜잭션의 모든 쓰기를 적용하고 커밋합니다.

WriteResult

쓰기를 적용한 결과입니다.

이 i번째 쓰기 결과는 요청의 i번째 쓰기에 해당합니다.

Timestamp

커밋이 발생한 시간입니다. read_time가 같거나 큰 읽기에서는 커밋의 효과가 나타납니다.

string

필수 항목입니다. 상위 리소스입니다. 예를 들면 projects/{project_id}/databases/{database_id}/documents 또는 projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}입니다.

string

필수 항목입니다. 나열할 컬렉션 ID(parent 기준)입니다. 예를 들면 chatrooms입니다.

string

이 문서에 사용할 클라이언트가 할당한 문서 ID입니다.

선택사항입니다. 지정하지 않으면 서비스에서 ID를 할당합니다.

Document

필수 항목입니다. 만들 문서입니다. name를 설정하면 안 됩니다.

DocumentMask

반환할 필드입니다. 설정하지 않으면 모든 필드가 반환됩니다.

문서에 이 마스크에 없는 필드가 있으면 해당 필드는 응답으로 반환되지 않습니다.

Value

쿼리의 order by 절에 표시되는 순서대로 위치를 나타내는 값입니다.

order by 절에 지정된 것보다 적은 수의 값을 포함할 수 있습니다.

bool

위치가 쿼리에서 정의한 정렬 순서를 기준으로 지정된 값의 바로 앞 또는 바로 뒤에 있는 경우

string

필수 항목입니다. 삭제할 문서의 리소스 이름입니다. 형식은 projects/{project_id}/databases/{database_id}/documents/{document_path}입니다.

Precondition

문서의 전제 조건(선택사항)입니다. 이 값이 설정되고 대상 문서에서 충족되지 않으면 요청이 실패합니다.

string

문서의 리소스 이름입니다(예: projects/{project_id}/databases/{database_id}/documents/{document_path}).

map<string, Value>

Timestamp

출력 전용입니다. 문서가 생성된 시간입니다.

이 값은 문서를 삭제한 다음 다시 만들면 일정하게 증가합니다. 또한 다른 문서의 값 및 쿼리의 read_time와 비교할 수 있습니다.

Timestamp

출력 전용입니다. 문서가 마지막으로 변경된 시간입니다.

이 값은 처음에 create_time로 설정되며 문서가 변경될 때마다 일정하게 증가합니다. 또한 다른 문서의 값 및 쿼리의 read_time와 비교할 수 있습니다.

Document

Document의 새로운 상태입니다.

mask가 설정되면 업데이트되거나 추가된 필드만 포함됩니다.

int32

이 문서와 일치하는 타겟의 타겟 ID 집합입니다.

int32

이 문서와 더 이상 일치하지 않는 타겟의 타겟 ID 집합입니다.

string

삭제된 Document의 리소스 이름입니다.

int32

이전에 이 항목과 일치했던 타겟의 타겟 ID 집합입니다.

Timestamp

삭제가 관찰된 읽기 타임스탬프입니다.

삭제 commit_time보다 크거나 같습니다.

string

마스크의 필드 경로 목록입니다. 필드 경로 구문 참조는 Document.fields를 참고하세요.

string

뷰에서 사라진 Document의 리소스 이름입니다.

int32

이전에 이 문서와 일치했던 대상의 타겟 ID 집합입니다.

Timestamp

삭제가 관찰된 읽기 타임스탬프입니다.

변경/삭제/삭제의 commit_time보다 크거나 같습니다.

string

변환할 문서의 이름입니다.

FieldTransform

문서의 필드에 적용할 변환 목록을 순서대로 표시합니다. 필수 입력란입니다.

string

필드의 경로입니다. 필드 경로 구문 참조는 Document.fields를 참고하세요.

ServerValue

필드를 지정된 서버 값으로 설정합니다.

Value

지정된 값을 필드의 현재 값에 추가합니다.

정수 또는 double 값이어야 합니다. 필드가 정수 또는 double이 아니거나 필드가 아직 존재하지 않는 경우, 변환은 필드를 지정된 값으로 설정합니다. 지정된 값 또는 현재 필드 값 중 하나가 double인 경우 두 값 모두 double로 해석됩니다. double 값의 이중 산술과 표현은 IEEE 754 시맨틱을 따릅니다. 양의 정수/음의 정수 오버플로가 있는 경우, 필드는 가장 큰 양의 정수/음의 정수로 확인됩니다.

Value

필드를 현재 값과 지정된 값의 최댓값으로 설정합니다.

정수 또는 double 값이어야 합니다. 필드가 정수 또는 double이 아니거나 필드가 아직 존재하지 않는 경우, 변환은 필드를 지정된 값으로 설정합니다. 필드와 입력 값이 혼합된 유형 (즉, 1은 정수이고 1은 double)인 최대 연산이 적용되는 경우 필드는 더 큰 피연산자의 유형을 취합니다. 피연산자가 같은 경우 (예: 3과 3.0) 필드는 변경되지 않습니다. 0, 0.0 및 -0.0은 모두 0입니다. 저장 값 0과 입력 값 0의 최댓값은 항상 저장 값입니다. 숫자 값 x 및 NaN의 최댓값은 NaN입니다.

Value

필드를 현재 값과 지정된 값의 최솟값으로 설정합니다.

정수 또는 double 값이어야 합니다. 필드가 정수 또는 double이 아니거나 필드가 아직 존재하지 않는 경우, 변환은 필드를 입력 값으로 설정합니다. 필드와 입력 값이 혼합된 유형 (즉, 1은 정수이고 1은 double)인 최소 연산이 적용되는 경우 필드는 더 작은 피연산자의 유형을 취합니다. 피연산자가 같은 경우 (예: 3과 3.0) 필드는 변경되지 않습니다. 0, 0.0 및 -0.0은 모두 0입니다. 저장 값 0과 입력 값 0의 최솟값은 항상 저장 값입니다. 숫자 값 x 및 NaN의 최솟값은 NaN입니다.

ArrayValue

지정된 요소가 현재 필드 값에 아직 없는 경우 순서대로 추가합니다. 필드가 배열이 아니거나 필드가 아직 존재하지 않는 경우 먼저 빈 배열로 설정됩니다.

다른 유형 (예: 3L 및 3.0)에 상응하는 값은 값이 누락되었는지 확인할 때 동일한 것으로 간주됩니다. NaN은 NaN과 같고 Null은 Null과 같습니다. 입력에 동일한 값이 여러 개 포함되어 있으면 첫 번째 값만 고려됩니다.

해당하는 transform_result가 null 값이 됩니다.

ArrayValue

필드의 배열에서 지정된 요소를 모두 삭제합니다. 필드가 배열이 아니거나 필드가 아직 존재하지 않는 경우 빈 배열로 설정됩니다.

요소를 삭제해야 하는지 여부를 결정할 때 서로 다른 유형 (예: 3L 및 3.0)의 등가는 동일한 것으로 간주됩니다. NaN은 NaN과 같고 Null은 Null과 같습니다. 중복이 있는 경우 상응하는 모든 값이 삭제됩니다.

해당하는 transform_result가 null 값이 됩니다.

int64

문서, 프로젝션, 집계 결과, 키를 포함하여 반환된 총 결과 수입니다.

Duration

백엔드에서 쿼리를 실행하는 데 소요된 총 시간입니다.

int64

청구 가능한 총 읽기 작업 수입니다.

Struct

쿼리 실행의 디버깅 통계입니다. 디버깅 통계는 Firestore가 발전함에 따라 변경될 수 있습니다. 다음과 같은 값을 포함할 수 있습니다. { "indexes_entries_sCAN": "1000", "documents_sCAN": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

int32

이 필터가 적용되는 타겟 ID입니다.

int32

target_id과(와) 일치하는 총 문서 수입니다.

일치하는 클라이언트의 문서 수와 다른 경우 클라이언트는 더 이상 대상과 일치하지 않는 문서를 수동으로 확인해야 합니다.

클라이언트는 unchanged_names 블룸 필터를 사용하여 필터와 비교하여 모든 문서 이름을 테스트하여 이러한 판단을 지원할 수 있습니다. 문서 이름이 필터에 없으면 문서가 더 이상 타겟과 일치하지 않는 것입니다.

BloomFilter

블룸 필터는 이름에도 불구하고 target_id과 일치하는 모든 문서의 리소스 이름에 대한 UTF-8 바이트 인코딩을 projects/{project_id}/databases/{database_id}/documents/{document_path} 형식으로 포함합니다.

블룸(bloom) 필터는 클라이언트가 이 필터를 사용하지 않는다고 판단되거나 계산 또는 전송하기에 계산 비용이 너무 높은 경우와 같이 서버의 재량에 따라 생략될 수 있습니다. 클라이언트는 이 필드가 존재하기 전에 사용된 로직으로 대체하여 이 필드가 없는 상태에서 적절하게 처리해야 합니다. 즉, 재개 토큰 없이 타겟을 다시 추가하여 클라이언트 캐시에 있는 어떤 문서가 동기화되지 않았는지 확인합니다.

PlanSummary

쿼리의 계획 단계 정보

ExecutionStats

쿼리 실행에서 집계된 통계입니다. ExplainOptions.analyze가 true로 설정된 경우에만 표시됩니다.

bool

선택사항입니다. 이 쿼리를 실행할지 여부입니다.

false (기본값)로 설정하면 쿼리가 계획되어 계획 단계의 측정항목만 반환됩니다.

true인 경우 쿼리가 계획 및 실행되어 계획 및 실행 단계 측정항목과 함께 전체 쿼리 결과가 반환됩니다.

string

필수 항목입니다. 가져올 문서의 리소스 이름입니다. 형식은 projects/{project_id}/databases/{database_id}/documents/{document_path}입니다.

DocumentMask

반환할 필드입니다. 설정하지 않으면 모든 필드가 반환됩니다.

문서에 이 마스크에 없는 필드가 있으면 해당 필드는 응답으로 반환되지 않습니다.

bytes

트랜잭션에서 문서를 읽습니다.

Timestamp

지정된 시간에 문서의 버전을 읽습니다.

지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 1분짜리 타임스탬프일 수도 있습니다.

string

필수 항목입니다. 상위 문서입니다. 형식은 projects/{project_id}/databases/{database_id}/documents/{document_path}입니다. 예를 들면 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom입니다.

int32

반환할 최대 결과 수입니다.

string

페이지 토큰입니다. ListCollectionIdsResponse의 값이어야 합니다.

Timestamp

지정된 시점의 문서를 읽습니다.

지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 1분짜리 타임스탬프일 수도 있습니다.

string

컬렉션 ID입니다.

string

목록을 계속 이어지는 데 사용할 수 있는 페이지 토큰입니다.

string

필수 항목입니다. 상위 리소스 이름입니다. 형식: projects/{project_id}/databases/{database_id}/documents 또는 projects/{project_id}/databases/{database_id}/documents/{document_path}

예를 들면 projects/my-project/databases/my-database/documents 또는 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom입니다.

string

선택사항입니다. 나열할 컬렉션 ID(parent 기준)입니다.

예를 들면 chatrooms 또는 messages입니다.

이는 선택사항이며, 제공되지 않으면 Firestore는 제공된 parent에 있는 모든 컬렉션의 문서를 나열합니다.

int32

선택사항입니다. 단일 응답에서 반환할 최대 문서 수입니다.

Firestore는 이 값보다 적은 수의 값을 반환할 수 있습니다.

string

선택사항입니다. 이전 ListDocuments 응답에서 수신된 페이지 토큰입니다.

후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나눌 때 다른 모든 매개변수 (page_size 제외)는 페이지 토큰을 생성한 요청에 설정된 값과 일치해야 합니다.

string

선택사항입니다. 반환할 문서의 순서입니다(선택사항).

예를 들면 priority desc, __name__ desc입니다.

Firestore 쿼리에서 사용되는 ORDER BY를 미러링하지만 문자열로 표현됩니다. 이 항목이 없으면 __name__ ASC 기준으로 문서가 정렬됩니다.

DocumentMask

선택사항입니다. 반환할 필드입니다. 설정하지 않으면 모든 필드가 반환됩니다.

문서에 이 마스크에 없는 필드가 있으면 해당 필드는 응답으로 반환되지 않습니다.

bool

목록에 누락된 문서가 표시되어야 하는지 여부

문서가 없는 경우 누락된 문서가 있는데 그 아래에 하위 문서가 중첩되어 있습니다. true인 경우 누락된 문서가 키와 함께 반환되지만 필드, create_time 또는 update_time가 설정되지 않습니다.

show_missing가 있는 요청은 where 또는 order_by를 지정할 수 없습니다.

bytes

이미 활성화된 트랜잭션의 일부로 읽기를 수행합니다.

Timestamp

제공된 시간에 읽기를 실행합니다.

지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 1분짜리 타임스탬프일 수도 있습니다.

Document

문서를 찾았습니다.

string

문서의 다음 페이지를 검색하기 위한 토큰입니다.

이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

string

필수 항목입니다. 데이터베이스 이름입니다. 형식은 projects/{project_id}/databases/{database_id}입니다.

map<string, string>

이 타겟 변경과 관련된 라벨이 있습니다.

Target

이 스트림에 추가할 타겟입니다.

int32

이 스트림에서 삭제할 대상의 ID입니다.

TargetChange

대상이 변경되었습니다.

DocumentChange

Document가 변경되었습니다.

DocumentDelete

Document이(가) 삭제되었습니다.

DocumentRemove

Document는 더 이상 타겟과 관련이 없으므로 타겟에서 삭제되었습니다.

ExistenceFilter

지정된 타겟에 대해 이전에 반환된 문서 집합에 적용할 필터입니다.

지정된 대상에서 문서가 삭제되었을 수 있지만 정확한 문서를 알 수 없는 경우 반환됩니다.

map<string, Value>

지도의 필드입니다.

맵 키는 필드 이름을 나타냅니다. 정규 표현식 __.*__과 일치하는 필드 이름은 예약되어 있습니다. 예약된 필드 이름은 문서화된 특정 컨텍스트를 제외하고 금지됩니다. UTF-8로 표시되는 맵 키는 1,500바이트를 초과할 수 없으며 비워 둘 수 없습니다.

string

필수 항목입니다. 상위 리소스 이름입니다. 형식은 projects/{project_id}/databases/{database_id}/documents입니다. 문서 리소스 이름은 지원되지 않습니다. 데이터베이스 리소스 이름만 지정할 수 있습니다.

int64

원하는 최대 파티션 지점 수입니다. 파티션은 여러 결과 페이지에 걸쳐 반환될 수 있습니다. 숫자는 양수여야 합니다. 반환되는 파티션의 실제 수는 더 적을 수 있습니다.

예를 들어 이는 실행할 병렬 쿼리 수보다 1개 적게 설정되거나, 데이터 파이프라인 작업 실행 시 사용 가능한 작업자 또는 컴퓨팅 인스턴스 수보다 1개 적게 설정될 수 있습니다.

string

추가 결과 집합을 가져오는 데 사용할 수 있는 PartitionQuery에 대한 이전 호출에서 반환된 next_page_token 값입니다. 결과 집합 간의 순서는 보장되지 않습니다. 따라서 여러 결과 집합을 사용하려면 서로 다른 결과 집합을 병합해야 합니다.

예를 들어 page_token을 사용한 두 번의 후속 호출은 다음을 반환할 수 있습니다.

• 커서 B, 커서 M, 커서 Q
• 커서 A, 커서 U, 커서 W

PartitionQuery에 제공된 쿼리 결과를 기준으로 정렬된 전체 결과 집합을 가져오려면 결과 집합을 병합해야 합니다(커서 A, 커서 B, 커서 M, 커서 Q, 커서 U, 커서 W).

int32

이 호출에서 반환할 파티션의 최대 개수이며 partition_count에 따라 달라집니다.

예를 들어 partition_count = 10 및 page_size = 8이면 PartitionQuery에 대한 첫 번째 호출은 최대 8개의 파티션을 반환하고, 결과가 더 있으면 next_page_token을 반환합니다. PartitionQuery를 두 번째 호출하면 최대 2개의 파티션이 반환되어 partition_count에 지정된 총 10개의 작업이 완료됩니다.

StructuredQuery

구조화된 쿼리입니다. 쿼리는 모든 하위 요소가 포함된 컬렉션을 지정하고 이름 오름차순으로 정렬해야 합니다. 다른 필터, 정렬 기준, 제한, 오프셋, 시작/끝 커서는 지원되지 않습니다.

Timestamp

지정된 시점의 문서를 읽습니다.

지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 1분짜리 타임스탬프일 수도 있습니다.

Cursor

파티션 결과 각 파티션은 RunQuery에서 쿼리 결과의 시작 또는 끝 지점으로 사용할 수 있는 분할 지점입니다. 이 PartitionQuery 요청에 제공된 것과 동일한 쿼리를 사용하여 RunQuery 요청을 해야 합니다. 파티션 커서는 PartitionQuery에 제공된 쿼리 결과와 동일한 순서에 따라 정렬됩니다.

예를 들어 PartitionQuery 요청이 파티션 커서 A와 B를 반환하는 경우 다음 세 가지 쿼리를 실행하면 원래 쿼리의 전체 결과 집합이 반환됩니다.

• 쿼리, A 종료
• 쿼리, start_at A, end_at B
• 쿼리, B에서 시작

결과가 비어 있으면 파티션을 나눌 수 있는 결과가 너무 적거나 쿼리의 파티션 나누기가 아직 지원되지 않음을 나타낼 수 있습니다.

string

추가 결과 집합을 요청하는 데 사용할 수 있는 페이지 토큰으로, PartitionQuery 요청에서 partition_count에 의해 지정된 개수까지 가능합니다. 비워 두면 더 이상 결과가 표시되지 않습니다.

Struct

쿼리에 선택된 색인입니다. 예: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

true로 설정하면 대상 문서가 있어야 합니다. false로 설정하면 대상 문서가 존재하지 않아야 합니다.

Timestamp

설정되면 대상 문서가 존재하고 해당 시점에 최종 업데이트된 적이 있어야 합니다. 타임스탬프는 마이크로초로 정렬해야 합니다.

string

필수 항목입니다. 데이터베이스 이름입니다. 형식은 projects/{project_id}/databases/{database_id}입니다.

bytes

필수 항목입니다. 롤백할 트랜잭션입니다.

string

필수 항목입니다. 상위 리소스 이름입니다. 형식: projects/{project_id}/databases/{database_id}/documents 또는 projects/{project_id}/databases/{database_id}/documents/{document_path} 예: projects/my-project/databases/my-database/documents 또는 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

선택사항입니다. 쿼리의 옵션을 설명합니다. 설정하면 추가 쿼리 통계가 반환됩니다. 그렇지 않으면 쿼리 결과만 반환됩니다.

StructuredAggregationQuery

집계 쿼리입니다.

bytes

이미 활성 상태인 트랜잭션 내에서 집계를 실행합니다.

이 값은 쿼리를 실행할 불투명한 트랜잭션 ID입니다.

TransactionOptions

쿼리의 일부로 새 트랜잭션을 시작합니다. 기본값은 읽기 전용입니다.

새 트랜잭션 ID가 스트림의 첫 번째 응답으로 반환됩니다.

Timestamp

지정된 타임스탬프에 쿼리를 실행합니다.

지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 1분짜리 타임스탬프일 수도 있습니다.

AggregationResult

단일 집계 결과입니다.

부분 진행 상황을 보고할 때는 표시되지 않습니다.

bytes

이 요청의 일부로 시작된 트랜잭션입니다.

요청이 새 트랜잭션의 시작을 요청한 경우에만 첫 번째 응답에 표시됩니다.

Timestamp

집계 결과가 계산된 시간입니다. 이 수치는 항상 단조롭게 증가합니다. 이 경우 결과 스트림의 이전 AggregationResult는 read_time와 이 항목 간에 변경되지 않습니다.

쿼리에서 반환된 결과가 없으면 read_time 응답과 result 응답 없음이 전송되며, 쿼리가 실행된 시간을 나타냅니다.

ExplainMetrics

쿼리 설명 측정항목 RunAggregationQueryRequest.explain_options가 제공된 경우에만 존재하며 스트림의 마지막 응답과 함께 한 번만 전송됩니다.

string

필수 항목입니다. 상위 리소스 이름입니다. 형식: projects/{project_id}/databases/{database_id}/documents 또는 projects/{project_id}/databases/{database_id}/documents/{document_path} 예: projects/my-project/databases/my-database/documents 또는 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

선택사항입니다. 쿼리의 옵션을 설명합니다. 설정하면 추가 쿼리 통계가 반환됩니다. 그렇지 않으면 쿼리 결과만 반환됩니다.

StructuredQuery

구조화된 쿼리입니다.

bytes

이미 활성 상태인 트랜잭션 내에서 쿼리를 실행합니다.

이 값은 쿼리를 실행할 불투명한 트랜잭션 ID입니다.

TransactionOptions

새 트랜잭션을 시작하고 문서를 읽습니다. 기본값은 읽기 전용 트랜잭션입니다. 새 트랜잭션 ID가 스트림의 첫 번째 응답으로 반환됩니다.

Timestamp

지정된 시점의 문서를 읽습니다.

지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 1분짜리 타임스탬프일 수도 있습니다.

bytes

이 요청의 일부로 시작된 트랜잭션입니다. 요청에서 RunQueryRequest.new_transaction가 설정된 경우에만 첫 번째 응답에서만 설정할 수 있습니다. 설정되면 이 응답에 다른 필드가 설정되지 않습니다.

Document

쿼리 결과이며 부분적 진행 상황을 보고할 때는 설정되지 않습니다.

Timestamp

문서를 읽은 시간입니다. 이는 일정하게 증가할 수 있습니다. 이 경우 결과 스트림의 이전 문서가 read_time와 이 문서 간에 변경되지 않았습니다.

쿼리에서 반환된 결과가 없으면 read_time 응답과 document 응답 없음이 전송되며, 쿼리가 실행된 시간을 나타냅니다.

int32

마지막 응답과 현재 응답 사이의 오프셋으로 인해 건너뛴 결과의 수입니다.

ExplainMetrics

쿼리 설명 측정항목 RunQueryRequest.explain_options가 제공된 경우에만 존재하며 스트림의 마지막 응답과 함께 한 번만 전송됩니다.

bool

요청이 있으면 Firestore에서 요청을 완전히 완료했으며 더 이상 문서가 반환되지 않습니다.

Aggregation

선택사항입니다. structured_query의 결과에 적용할 일련의 집계입니다.

요구사항:

• 쿼리당 집계는 최소 1개에서 최대 5개입니다.

StructuredQuery

중첩된 구조화된 쿼리입니다.

string

선택사항입니다. 집계 결과를 저장할 필드의 이름입니다(선택사항).

입력하지 않으면 Firestore에서 field_<incremental_id++> 형식에 따라 기본 이름을 선택합니다. 예를 들면 다음과 같습니다.

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2),
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*)
OVER (
  ...
);

다음과 같이 변환됩니다.

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2) AS field_1,
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*) AS field_2
OVER (
  ...
);

요구사항:

• 모든 집계 별칭에서 고유해야 합니다.
• document field name 제한사항을 준수합니다.

Count

집계 애그리게이터입니다.

Sum

합계 애그리게이터입니다.

Avg

평균 애그리게이터입니다.

FieldReference

집계할 필드입니다.

Int64Value

선택사항입니다. 계산할 최대 문서 수에 대한 선택적 제약조건입니다.

이를 통해 스캔할 문서 수의 상한선을 설정하여 지연 시간 및 비용을 제한할 수 있습니다.

지정되지 않으면 경계가 없는 것으로 해석됩니다.

대략적인 예:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

요구사항:

• 있는 경우 0보다 커야 합니다.

FieldReference

집계할 필드입니다.

Projection

반환할 필드의 선택적 하위 집합입니다.

쿼리에서 반환된 문서에 대해 DocumentMask 역할을 합니다. 설정하지 않으면 호출자가 모든 필드가 반환되기를 원한다고 가정합니다.

CollectionSelector

쿼리할 컬렉션입니다.

Filter

적용할 필터입니다.

Order

쿼리 결과에 적용할 순서입니다.

Firestore를 사용하면 호출자가 전체 순서 지정 또는 부분 순서 지정을 제공하거나 아예 순서 지정을 제공하지 않을 수 있습니다. 모든 경우에 Firestore는 다음 규칙을 통해 안정적인 순서를 보장합니다.

• order_by는 불일치 필터와 함께 사용되는 모든 필드를 참조하는 데 필요합니다.
• order_by에 있어야 하지만 아직 없는 모든 필드는 필드 이름의 사전순으로 추가됩니다.
• __name__의 주문을 지정하지 않으면 기본적으로 추가됩니다.

필드는 지정된 마지막 순서와 동일한 정렬 방향 또는 'ASCENDING'으로 추가됩니다. 표시됩니다. 예를 들면 다음과 같습니다.

• ORDER BY a이(가) ORDER BY a ASC, __name__ ASC(으)로 변경됨
• ORDER BY a DESC이(가) ORDER BY a DESC, __name__ DESC(으)로 변경됨
• WHERE a > 1이(가) WHERE a > 1 ORDER BY a ASC, __name__ ASC(으)로 변경됨
• WHERE __name__ > ... AND a > 1이(가) WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC(으)로 변경됨

Cursor

결과 집합에서 쿼리를 시작할 위치의 잠재 접두사입니다.

결과 세트의 순서는 원래 쿼리의 ORDER BY 절에 따라 결정됩니다.

SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;

이 쿼리의 결과는 (b ASC, __name__ ASC)을 기준으로 정렬됩니다.

커서는 전체 순서 또는 위치의 접두사를 참조할 수 있지만 제공된 ORDER BY에 있는 것보다 더 많은 필드를 참조할 수는 없습니다.

위의 예를 계속 진행하면 다음 시작 커서를 연결하면 다양한 영향을 미칩니다.

• START BEFORE (2, /k/123): a = 1 AND b > 2 AND __name__ > /k/123 직전에 쿼리를 시작합니다.
• START AFTER (10): a = 1 AND b > 10 바로 뒤에서 쿼리를 시작합니다.

건너뛰려면 처음 N개의 결과를 검색해야 하는 OFFSET와 달리 시작 커서를 사용하면 쿼리를 논리적 위치에서 시작할 수 있습니다. 이 위치는 실제 결과와 일치하지 않아도 되며 이 위치에서 앞으로 스캔하여 다음 문서를 찾습니다.

요구사항:

• 값의 수는 ORDER BY 절에 지정된 필드 수보다 클 수 없습니다.

Cursor

결과 집합에서 쿼리를 종료할 위치의 잠재 접두사입니다.

START_AT와 유사하지만 시작 위치가 아닌 종료 위치를 제어합니다.

요구사항:

• 값의 수는 ORDER BY 절에 지정된 필드 수보다 클 수 없습니다.

int32

첫 번째 결과를 반환하기 전에 건너뛸 문서 수입니다.

이는 WHERE, START AT 및 END AT이지만 LIMIT 절 앞에 있습니다.

요구사항:

• 지정된 경우 값은 0보다 크거나 같아야 합니다.

Int32Value

반환할 최대 결과 수입니다.

다른 모든 제약 조건 뒤에 적용됩니다.

요구사항:

• 지정된 경우 값은 0보다 크거나 같아야 합니다.

FindNearest

선택사항입니다. 잠재적인 최근접 이웃 검색입니다.

다른 모든 필터 및 순서 뒤에 적용됩니다.

지정된 쿼리 벡터에 가장 가까운 벡터 임베딩을 찾습니다.

string

컬렉션 ID입니다. 설정하면 이 ID가 있는 컬렉션만 선택됩니다.

bool

false인 경우 포함하는 RunQueryRequest에 지정된 parent의 직계 하위 요소인 컬렉션만 선택합니다. true인 경우 모든 하위 컬렉션을 선택합니다.

Operator

여러 필터를 결합하는 연산자입니다.

Filter

결합할 필터의 목록입니다.

요구사항:

• 필터가 1개 이상 있습니다.

FieldReference

필터링할 필드입니다.

Operator

필터링할 연산자입니다.

Value

비교할 값입니다.

string

문서의 필드에 대한 참조입니다.

요구사항:

• 각 세그먼트가 document field name 제한사항을 준수하는 세그먼트의 점으로 구분된(.) 문자열이어야 합니다(MUST).

CompositeFilter

복합 필터

FieldFilter

문서 필드의 필터

UnaryFilter

정확히 1개의 인수를 사용하는 필터입니다.

FieldReference

필수 항목입니다. 검색할 색인이 지정된 벡터 필드입니다. 차원이 query_vector와 일치하는 벡터가 포함된 문서만 반환될 수 있습니다.

Value

필수 항목입니다. 검색 중인 쿼리 벡터입니다. 차원이 2,048개를 넘지 않는 벡터여야 합니다.

DistanceMeasure

필수 항목입니다. 사용할 거리 측정입니다(필수).

Int32Value

필수 항목입니다. 반환할 최근접 이웃 수입니다. 1,000 이하의 양의 정수여야 합니다.

FieldReference

정렬 기준이 되는 필드입니다.

Direction

정렬 기준입니다. 기본값은 ASCENDING입니다.

FieldReference

반환할 필드입니다.

비어 있으면 모든 필드가 반환됩니다. 문서의 이름만 반환하려면 ['__name__']를 사용합니다.

Operator

적용할 단항 연산자입니다.

FieldReference

연산자를 적용할 필드입니다.

int32

스트림에서 타겟을 식별하는 타겟 ID입니다. 0이 아닌 양수여야 합니다.

target_id가 0이거나 지정되지 않은 경우 서버는 이 타겟의 ID를 할당하고 TargetChange::ADD 이벤트에서 반환합니다. target_id=0가 있는 타겟이 추가되면 이후의 모든 타겟에도 target_id=0가 있어야 합니다. target_id=0인 타겟이 추가된 후 target_id != 0가 포함된 AddTarget 요청이 서버로 전송되면 서버는 즉시 TargetChange::Remove 이벤트가 포함된 응답을 전송합니다.

클라이언트가 ID 없이 여러 AddTarget 요청을 보내면 TargetChage.target_ids에서 반환되는 ID의 순서가 정의되지 않습니다. 따라서 클라이언트는 서버에 의존하여 ID를 할당하는 대신 타겟 ID를 제공해야 합니다.

target_id가 0이 아닌 경우 이 스트림에 ID가 동일한 기존 활성 타겟이 있어서는 안 됩니다.

bool

타겟이 최신 상태이고 일관되면 삭제해야 하는지 여부입니다.

Int32Value

재개 토큰 또는 읽기 시간에 쿼리와 마지막으로 일치한 문서 수입니다.

이 값은 resume_type가 제공된 경우에만 관련이 있습니다. 이 값은 존재하며 0보다 큰 값은 클라이언트가 ExistenceFilter.unchanged_names를 응답에 포함하고자 함을 나타냅니다.

QueryTarget

쿼리로 지정된 대상.

DocumentsTarget

문서 이름 집합으로 지정된 대상.

bytes

동일한 타겟에 관한 이전 TargetChange의 재개 토큰입니다.

다른 타겟으로 재개 토큰을 사용하는 것은 지원되지 않으며 실패할 수 있습니다.

Timestamp

특정 read_time 후에 리슨을 시작합니다.

이때 클라이언트는 일치하는 문서의 상태를 알고 있어야 합니다.

string

검색할 문서의 이름입니다. 형식은 projects/{project_id}/databases/{database_id}/documents/{document_path}입니다. 문서가 지정된 database의 하위 리소스가 아닌 경우 요청이 실패합니다. 중복된 이름은 생략됩니다.

string

상위 리소스 이름입니다. 형식: projects/{project_id}/databases/{database_id}/documents 또는 projects/{project_id}/databases/{database_id}/documents/{document_path} 예: projects/my-project/databases/my-database/documents 또는 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

구조화된 쿼리입니다.

TargetChangeType

발생한 변경 유형입니다.

int32

변경된 타겟의 타겟 ID입니다.

비어 있으면 변경사항이 모든 대상에 적용됩니다.

타겟 ID의 순서가 정의되지 않았습니다.

Status

변경이 발생한 오류입니다(해당하는 경우).

bytes

지정된 target_ids 또는 target_ids가 비어 있는 경우 모든 대상의 스트림을 재개하는 데 사용할 수 있는 토큰입니다.

타겟을 변경할 때마다 설정되지는 않습니다.

Timestamp

지정된 target_ids의 일관된 read_time (target_ids가 일관된 스냅샷에 있지 않은 경우 생략됨)

스트림은 전체 스트림이 일관된 새 스냅샷에 도달할 때마다 target_ids가 비어 있는 read_time를 전송합니다. ADD, CURRENT, RESET 메시지는 결과적으로 새로운 일관된 스냅샷을 얻게 됩니다(NO_CHANGE 및 REMOVE 메시지는 그렇지 않음).

지정된 스트림에서 read_time는 단조 증가하도록 보장됩니다.

ReadOnly

트랜잭션은 읽기 작업에만 사용할 수 있습니다.

ReadWrite

트랜잭션은 읽기 및 쓰기 작업 모두에 사용할 수 있습니다.

Timestamp

지정된 시간에 문서를 읽습니다.

지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 1분짜리 타임스탬프일 수도 있습니다.

bytes

다시 시도할 트랜잭션(선택사항)입니다.

Document

필수 항목입니다. 업데이트된 문서입니다. 문서가 없으면 새로 만듭니다.

DocumentMask

업데이트할 필드입니다. 마스크의 필드 경로는 예약된 이름을 포함할 수 없습니다.

문서가 서버에 있고 마스크에서 참조되지 않은 필드가 있는 경우 변경되지 않습니다. 마스크에서는 참조되었지만 입력 문서에는 없는 필드는 서버의 문서에서 삭제됩니다.

DocumentMask

반환할 필드입니다. 설정하지 않으면 모든 필드가 반환됩니다.

문서에 이 마스크에 없는 필드가 있으면 해당 필드는 응답으로 반환되지 않습니다.

Precondition

문서의 전제 조건(선택사항)입니다. 이 값이 설정되고 대상 문서에서 충족되지 않으면 요청이 실패합니다.

NullValue

null 값입니다.

bool

부울 값

int64

정수 값입니다.

double

double 값입니다.

Timestamp

타임스탬프 값입니다.

마이크로초 단위까지만 정확합니다. 저장 시 추가 정밀도는 내림됩니다.

string

문자열 값입니다.

UTF-8로 표시되는 문자열은 1MiB~89바이트를 초과하면 안 됩니다. UTF-8 표현의 처음 1,500바이트만 쿼리에서 고려됩니다.

bytes

바이트 값입니다.

1MiB~89바이트를 초과하면 안 됩니다. 처음 1,500바이트만 쿼리에서 고려됩니다.

string

문서에 대한 참조입니다. 예를 들면 projects/{project_id}/databases/{database_id}/documents/{document_path}입니다.

LatLng

지구 표면의 한 지점을 나타내는 지리적 점 값입니다.

ArrayValue

배열 값입니다.

다른 배열 값을 직접 포함할 수는 없지만 다른 배열이 포함된 맵을 포함할 수 있습니다.

MapValue

맵 값입니다.

DocumentMask

이 쓰기에서 업데이트할 필드입니다.

이 필드는 작업이 update인 경우에만 설정할 수 있습니다. update에 마스크가 설정되어 있지 않고 문서가 있는 경우 기존 데이터를 모두 덮어씁니다. 마스크가 설정되어 있고 서버의 문서에 마스크가 적용되지 않는 필드가 있으면 변경되지 않습니다. 마스크에서는 참조되었지만 입력 문서에는 없는 필드는 서버의 문서에서 삭제됩니다. 이 마스크의 필드 경로는 예약된 필드 이름을 포함할 수 없습니다.

FieldTransform

업데이트 후에 수행할 변환입니다.

이 필드는 작업이 update인 경우에만 설정할 수 있습니다. 있는 경우 이 쓰기는 동일한 문서에 update 및 transform를 원자적으로 순서대로 실행하는 것과 같습니다.

Precondition

문서의 전제 조건(선택사항)입니다.

이 값을 설정하고 대상 문서에서 충족하지 않으면 쓰기가 실패합니다.

Document

작성할 문서입니다.

string

삭제할 문서 이름입니다. 형식은 projects/{project_id}/databases/{database_id}/documents/{document_path}입니다.

DocumentTransform

문서에 변환을 적용합니다.

string

필수 항목입니다. 데이터베이스 이름입니다. 형식은 projects/{project_id}/databases/{database_id}입니다. 이 작업은 첫 번째 메시지에만 필요합니다.

string

다시 시작할 쓰기 스트림의 ID입니다. 첫 번째 메시지에서만 설정할 수 있습니다. 비워 두면 새 쓰기 스트림이 생성됩니다.

Write

적용할 쓰기입니다.

항상 원자적으로 순서대로 실행됩니다. 첫 번째 요청에서는 비어 있어야 합니다. 마지막 요청에서는 비어 있을 수 있습니다. 다른 모든 요청에서는 이 필드를 비워 둘 수 없습니다.

bytes

서버에서 이전에 전송한 스트림 토큰입니다.

클라이언트는 이 필드를 가장 최근에 수신한 WriteResponse의 토큰으로 설정해야 합니다. 클라이언트가 이 토큰까지 응답을 수신했음을 나타냅니다. 이 토큰을 전송한 후에는 이전 토큰을 더 이상 사용할 수 없습니다.

확인되지 않은 응답이 너무 많으면 서버가 스트림을 닫을 수 있습니다.

새 스트림을 만들 때는 이 필드를 설정하지 마세요. 특정 지점에서 스트림을 재개하려면 이 필드와 stream_id 필드를 설정합니다.

새 스트림을 만들 때는 이 필드를 설정하지 마세요.

map<string, string>

이 쓰기 요청과 연결된 라벨입니다.

string

스트림의 ID입니다. 새 스트림이 만들어지는 첫 번째 메시지에만 설정됩니다.

bytes

스트림에서 이 응답의 위치를 나타내는 토큰입니다. 클라이언트는 이 시점에서 스트림을 재개하는 데 사용할 수 있습니다.

이 필드는 항상 설정됩니다.

WriteResult

쓰기를 적용한 결과입니다.

이 i번째 쓰기 결과는 요청의 i번째 쓰기에 해당합니다.

Timestamp

커밋이 발생한 시간입니다. read_time가 같거나 큰 읽기에서는 쓰기의 효과가 나타납니다.

Timestamp

쓰기를 적용한 후 문서의 마지막 업데이트 시간입니다. delete 이후에는 설정되지 않습니다.

쓰기로 인해 실제로 문서가 변경되지 않았다면 이전 update_time이 됩니다.

Value

각 DocumentTransform.FieldTransform를 동일한 순서로 적용한 결과