REST Resource: projects.databases.collectionGroups.fields
리소스: 필드
데이터베이스의 단일 필드를 나타냅니다.
필드는 ID가 동일한 데이터베이스의 모든 컬렉션을 나타내는 '컬렉션 그룹'으로 그룹화됩니다.
JSON 표현 |
{
"name": string,
"indexConfig": {
object (IndexConfig )
}
} |
필드 |
name |
string
projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} 형식의 필드 이름
필드 경로는 다음과 같은 간단한 필드 이름일 수 있습니다. address 또는 mapValue 내의 필드 경로(예: address.city 또는 특수 필드 경로입니다. 유일하게 유효한 특수 필드는 모든 필드를 나타내는 * 입니다. 필드 경로는 ASCII 기호 문자뿐 아니라 (backtick). The only character that needs
to be escaped within a quoted field path is the backtick character itself,
escaped using a backslash. Special characters in field paths that
must be quoted include: *, .,
``` (backtick), [, ]`를 사용하여 따옴표로 묶을 수 있습니다. 예: (참고: 이 주석은 마크다운 구문으로 작성되므로 코드 블록을 나타내는 추가 백틱 레이어가 있음) \ address.city`represents a field named address.city, not the map key
cityin the field address.
`*`represents a field named *`(필드가 아님) 특별한 Field 에는 모든 필드의 기본 색인 생성 설정이 포함되어 있습니다. 이 필드의 리소스 이름: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* 이 Field 에 정의된 색인은 자체 Field 색인 구성이 없는 모든 필드에 적용됩니다.
|
indexConfig |
object (IndexConfig )
이 필드의 색인 구성입니다. 설정하지 않으면 필드 색인 생성이 ancestorField 에서 정의한 구성으로 되돌아갑니다. 이 필드의 모든 색인을 명시적으로 삭제하려면 빈 색인 목록을 사용하여 색인 구성을 지정하세요.
|
색인 구성
JSON 표현 |
{
"indexes": [
{
object (Index )
}
],
"usesAncestorConfig": boolean,
"ancestorField": string,
"reverting": boolean
} |
필드 |
indexes[] |
object (Index )
이 필드에 지원되는 색인입니다.
|
usesAncestorConfig |
boolean
출력 전용입니다. true인 경우 Field 의 색인 구성은 ancestorField 에 지정된 구성에서 설정됩니다. false인 경우 Field 의 색인 구성이 명시적으로 정의됩니다.
|
ancestorField |
string
출력 전용입니다. 이 필드의 색인 구성이 설정되거나 (usesAncestorConfig 이 true인 경우) 이 필드에 색인 구성이 없는 경우 (usesAncestorConfig 가 false인 경우) 설정될 Field 의 리소스 이름을 지정합니다.
|
reverting |
boolean
출력 전용 true인 경우 Field 의 색인 구성을 되돌리는 중입니다. 완료되면 색인 구성이 ancestorField 로 지정된 필드와 동일한 상태로 전환되며 이때 usesAncestorConfig 는 true 이 되고 reverting 는 false 이 됩니다.
|
메소드 |
|
필드의 메타데이터 및 구성을 가져옵니다. |
|
이 데이터베이스의 필드 구성 및 메타데이터를 나열합니다. |
|
필드 구성을 업데이트합니다. |
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2024-08-22(UTC)
[null,null,["최종 업데이트: 2024-08-22(UTC)"],[],[]]