문서 샘플링 & 유효성 검사

POST /groups/{groupId}/apps/{appId}/services/{datasourceId}/commands/validate_documents

컬렉션의 문서 하위 집합을 쿼리하고 스키마와 비교하여 각 일치 항목의 유효성을 검사합니다.

경로 매개변수

application/json

body 필수 사항

  • database_name 문자열 필수 사항

    유효성을 검사할 컬렉션이 포함된 데이터베이스의 이름입니다.

  • collection_name 문자열 필수 사항

    유효성을 검사할 컬렉션의 이름입니다.

  • from_schema 객체 필수 사항

    샘플링된 문서의 유효성을 검사하기 위한 EJSON 스키마입니다.

  • 쿼리 객체

    컬렉션의 문서와 일치하는 MongoDB 쿼리입니다. 이 쿼리를 실행한 결과는 샘플 모집단입니다. 이를 사용하여 컬렉션에 있는 문서의 하위 집합으로 샘플 범위를 좁힙니다.

    기본값은 {} (비어 있음)입니다.

  • limit 숫자

    샘플링할 최대 문서 수입니다.

    기본값은 10000 입니다.

  • sort 객체

    컬렉션에 대한 MongoDB 정렬입니다. 이를 사용하여 샘플링을 시작할 범위 쿼리의 끝을 결정합니다.

    기본값은 {} (비어 있음)입니다.

응답

POST /groups/{groupId}/apps/{appId}/services/{datasourceId}/commands/validate_documents
curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services/{datasourceId}/commands/validate_documents' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"database_name":"string","collection_name":"string","from_schema":{},"query":{},"limit":10000,"sort":{}}'
요청 예시
{
  "database_name": "string",
  "collection_name": "string",
  "from_schema": {},
  "query": {},
  "limit": 10000,
  "sort": {}
}
응답 예시(200)
{
  "errors": [
    {
      "error_code": "false",
      "error_count": 42.0,
      "field": "(root)._id",
      "failed_ids": [
        "string"
      ],
      "failed_documents_query": {}
    }
  ],
  "total_processed_count": 42.0,
  "total_error_count": 42.0
}