참고
Stable API 기능을 사용하려면 MongoDB Server 5.0 이상이 필요합니다.
개요
이 가이드에서는 stable API MongoDB deployment에 연결할 때 호환성을 지정하는 방법을 배울 수 있습니다.
Stable API 기능은 서버가 지정한 API 버전과 호환되는 동작으로 작업을 실행하도록 강제합니다. Stable API를 사용하면 서버의 일관된 응답을 보장하고 애플리케이션에 장기적인 API 안정성을 제공할 수 있습니다.
다음 섹션에서는 MongoDB 클라이언트 에 대해 Stable API 활성화 하고 사용자 지정하는 방법을 설명합니다. 지원하는 명령 목록을 포함하여 Stable API 에 대한 자세한 내용은 MongoDB Server 매뉴얼에서Stable API 참조하세요.
stable API활성화
Stable API 활성화 하려면 Mongo::Client 인스턴스 생성할 때 Stable API 버전을 지정하는 해시를 선택적 server_api 매개변수에 전달합니다.
다음 코드 예시에서는 stable API 버전 1을 지정하는 방법을 보여줍니다.
client = Mongo::Client.new(uri, server_api: { version: '1' })
지정된 API 버전으로 Client 인스턴스 생성하면 클라이언트 로 실행 모든 명령이 지정된 버전을 사용합니다. 두 개 이상의 Stable API 버전을 사용하여 명령을 실행 해야 하는 경우 새 Client을 만듭니다.
stable API구성
다음 표에서는 server_api 해시에 지정하여 설정하다 수 있는 Stable API 옵션에 대해 설명합니다. 이러한 옵션을 사용하여 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 |
deprecation_errors | Optional. When true, if you call a command that is deprecated in the
declared API version, the driver raises an exception.Default: false |
다음 코드 예시 ServerApi 인스턴스 에서 두 옵션을 설정하다 방법을 보여줍니다.
client = Mongo::Client.new(uri, server_api: { version: '1', strict: true, deprecation_errors: true })
문제 해결
다음 섹션에서는 Stable API 사용할 때 발생할 수 있는 일반적인 문제에 대해 설명합니다.
서버의 인식할 수 없는 필드 'apiVersion'
Ruby 운전자 API 버전을 지정하고 Stable API 지원 하지 않는 MongoDB 서버 에 연결하는 경우 이 예외를 발생시킵니다. MongoDB Server v5.0 이상 실행 배포서버 에 연결하고 있는지 확인합니다.
apiStrict:true를 제공했지만 명령 수가 API 버전에 없음
Ruby 운전자 Client 가 지정한 Stable API 버전이 아닌 작업을 실행하는 경우 이 예외를 발생시킵니다. 이 오류를 방지하려면 지정된 Stable API 버전에서 지원하는 대체 작업을 사용하거나 ServerApi 객체 구성할 때 strict 옵션을 false (으)로 설정하다 .
API 문서
Ruby 운전자 에서 Stable API 사용하는 방법에 대한 자세한 내용은 다음 API 설명서를 참조하세요.