Stable API
이 페이지의 내용
참고
Stable API 기능을 사용하려면 MongoDB Server 5.0 이상이 필요합니다.
개요
이 가이드에서는 stable API MongoDB deployment에 연결할 때 호환성을 지정하는 방법을 배울 수 있습니다.
Stable API 기능은 서버가 지정한 API 버전과 호환되는 동작으로 작업을 실행하도록 강제합니다. Stable API를 사용하면 서버의 일관된 응답을 보장하고 애플리케이션에 장기적인 API 안정성을 제공할 수 있습니다.
다음 섹션에서는 클라이언트를 위해 stable API 를 활성화하고 MongoDB 사용자 지정하는 방법을 설명합니다. 지원하는 명령 목록을 포함하여 에 대한 자세한 stable API stable API 내용은 MongoDB Server 매뉴얼에서 를 참조하세요.
stable API활성화
stable API 를 활성화하려면 다음 단계를 수행하세요.
ServerApi
객체를 생성하고 stable API 버전을 지정합니다.ServerApiVersion
열거형에 정의된 stable API 버전을 사용해야 합니다.MongoClientSettings.Builder
클래스를 사용하여MongoClientSettings
객체 를 생성합니다.MongoClient.create()
메서드를 사용하여MongoClient
(을)를 인스턴스화하고MongoClientSettings
인스턴스를 매개 변수로 전달합니다.
다음 코드 예시에서는 stable API 버전 1을 지정하는 방법을 보여줍니다.
val serverApi = ServerApi.builder() .version(ServerApiVersion.V1) .build() // Replace the uri string placeholder with your MongoDB deployment's connection string val uri = "<connection string>" val settings = MongoClientSettings.builder() .applyConnectionString(ConnectionString(uri)) .serverApi(serverApi) .build() val client = MongoClient.create(settings)
지정된 API 버전으로 MongoClient
인스턴스 를 생성하면 클라이언트 로 실행 하는 모든 명령이 지정된 버전을 사용합니다. If you must run commands using more than one version of the Stable API, create a new MongoClient
.
stable API구성
다음 표에서는 ServerApi
클래스의 매개변수에 대해 설명합니다. 이러한 매개변수를 사용하여 stable API 의 동작을 사용자 지정할 수 있습니다.
옵션 이름 | 설명 |
---|---|
strict | Optional. When True , if you call a command that isn't part of
the declared API version, the driver raises an exception.Default: False |
deprecationErrors | Optional. When True , if you call a command that is deprecated in the
declared API version, the driver raises an exception.Default: False |
다음 코드 예시 에서는 ServerApi.Builder
에서 메서드를 연결하여 ServerApi
인스턴스 에서 두 옵션을 설정하다 하는 방법을 보여 줍니다.
val serverApi = ServerApi.builder() .version(ServerApiVersion.V1) .strict(true) .deprecationErrors(true) .build()
문제 해결
서버의 인식할 수 없는 필드 'apiVersion'
Kotlin Sync 드라이버는 API 버전을 지정하고 Stable API를 지원하지 않는 MongoDB 서버에 연결하는 경우 이 예외를 발생시킵니다. MongoDB Server v5.0 이상을 실행하는 배포에 연결하고 있는지 확인합니다.
apiStrict:true를 제공했지만 명령 수가 API 버전에 없음
코틀린 동기 (Kotlin Sync) 운전자 에서 MongoClient
이(가) 지정한 Stable API 버전이 아닌 작업을 실행하는 경우 이 예외가 발생합니다. 이 오류를 방지하려면 지정된 Stable API 버전에서 지원하는 대체 작업을 사용하거나 ServerApi
객체 를 구성할 때 strict
옵션을 False
으)로 설정하다 하세요.
API 문서
코틀린 동기 (Kotlin Sync) 운전자 에서 Stable API 를 사용하는 방법에 대한 자세한 내용은 다음 API 문서를 참조하세요.