JSON Schema 유효성 검사 지정

호환성

다음 환경에서 호스팅되는 배포에 JSON schema 유효성 검사를 사용할 수 있습니다.

• MongoDB Atlas: 클라우드에서의 MongoDB 배포를 위한 완전 관리형 서비스

• MongoDB Enterprise: MongoDB의 구독 기반 자체 관리 버전

• MongoDB Community: MongoDB의 소스 사용 가능 무료 자체 관리 버전

Context

MongoDB는 핵심 사양과 유효성 검사 사양을 비롯한 JSON schema 초안 4를 지원하지만, 몇 가지 차이점이 있습니다. 자세한 내용은 확장 및 생략을 참조하세요.

JSON Schema에 대한 자세한 내용은 공식 웹사이트를 참조하세요.

제한 사항

다음의 스키마 유효성 검사를 지정할 수 없습니다:

• admin , local, config 데이터베이스 컬렉션

• 시스템 컬렉션

collection에서 클라이언트 측 필드 수준 암호화 또는 Queryable Encryption 을 활성화한 경우 유효성 검사에는 다음 제한 사항이 적용됩니다.

• CSFLE의 경우 collMod를 실행할 때 libmongocrypt 라이브러리는 명령에 지정된 JSON 암호화 스키마를 선호합니다. 이렇게 하면 아직 스키마가 없는 컬렉션에 스키마를 설정할 수 있습니다.

• Queryable Encryption의 경우 암호화된 필드를 포함하는 JSON schema로 인해 쿼리 분석 오류가 발생합니다.

단계

이 예에서는 students 유효성 검사 규칙이 있는 컬렉션을 만들고 유효하지 않은 문서를 삽입하려고 시도한 후 결과를 관찰합니다.

db.createCollection("students", {
   validator: {
      $jsonSchema: {
         bsonType: "object",
         title: "Student Object Validation",
         required: [ "address", "major", "name", "year" ],
         properties: {
            name: {
               bsonType: "string",
               description: "'name' must be a string and is required"
            },
            year: {
               bsonType: "int",
               minimum: 2017,
               maximum: 3017,
               description: "'year' must be an integer in [ 2017, 3017 ] and is required"
            },
            gpa: {
               bsonType: [ "double" ],
               description: "'gpa' must be a double if the field exists"
            }
         }
      }
   }
} )

db.students.insertOne( {
   name: "Alice",
   year: Int32( 2019 ),
   major: "History",
   gpa: Int32(3),
   address: {
      city: "NYC",
      street: "33rd Street"
   }
} )

MongoServerError: Document failed validation
Additional information: {
  failingDocumentId: ObjectId("630d093a931191850b40d0a9"),
  details: {
    operatorName: '$jsonSchema',
    title: 'Student Object Validation',
    schemaRulesNotSatisfied: [
      {
        operatorName: 'properties',
        propertiesNotSatisfied: [
          {
            propertyName: 'gpa',
            description: "'gpa' must be a double if the field exists",
            details: [
              {
                operatorName: 'bsonType',
                specifiedAs: { bsonType: [ 'double' ] },
                reason: 'type did not match',
                consideredValue: 3,
                consideredType: 'int'
              }
            ]
          }
        ]
      }
    ]
  }
}

config.set("inspectDepth", Infinity)

db.students.insertOne( {
   name: "Alice",
   year: NumberInt(2019),
   major: "History",
   gpa: Double(3.0),
   address: {
      city: "NYC",
      street: "33rd Street"
   }
} )

db.students.find()

[
   {
      _id: ObjectId("62bb413014b92d148400f7a5"),
      name: 'Alice',
      year: 2019,
      major: 'History',
      gpa: 3,
      address: { city: 'NYC', street: '33rd Street' }
   }
]

추가 정보

JSON Schema 유효성 검사와 쿼리 연산자 유효성검사를 결합할 수 있습니다.

예를 들어 이 스키마 유효성 검사를 사용하는 sales 컬렉션을 생각해 보겠습니다.

 db.createCollection("sales", {
   validator: {
     "$and": [
       // Validation with query operators
       {
         "$expr": {
           "$lt": ["$lineItems.discountedPrice", "$lineItems.price"]
         }
       },
       // Validation with JSON Schema
       {
         "$jsonSchema": {
           "properties": {
             "items": { "bsonType": "array" }
           }
          }
        }
      ]
    }
  }
)

sales 컬렉션의 문서에 대해 다음과 같은 규칙을 적용하는 유효성 검사가 이루어집니다:

• lineItems.discountedPrice lineItems.price보다 작아야 합니다. 이 규칙은 $lt 연산자를 사용하여 지정됩니다.

• items 필드는 배열이어야 합니다. 이 규칙은 $jsonSchema를 사용하여 지정됩니다.

자세히 알아보기

• JSON schema에서 허용되는 키워드의 전체 목록을 보려면 사용 가능한 키워드를 참조하세요.

• 특정 필드에 포함할 수 있는 값을 제한하려면 허용된 필드 값 지정을 참조하세요.

• JSON Schema 유효성 검사 관련 문제를 방지하려면 JSON Schema 유효성 검사를 위한 팁을 참조하세요.