Stable API

이 페이지의 내용

개요

MongoDB 클라이언트에서 Stable API를 활성화합니다.
Stable API 옵션
API 문서

참고

Stable API 기능을 사용하려면 MongoDB Server 5.0 이상이 필요합니다.

연결하려는 모든 MongoDB Server가 이 기능을 지원하는 경우에만 stable API 기능을 사용해야 합니다.

개요

이 가이드에서는 MongoDB 인스턴스 혹은 복제본 세트에 연결할 때 Stable API 호환성을 지정하는 방법을 알아봅니다.

stable API 기능은 지정한 API 버전과 호환되는 동작으로 서버가 작업을 실행하도록 합니다. 드라이버나 서버를 업데이트하면 API 버전이 변경되어 이러한 작업의 동작 방식이 변경될 수 있습니다. stable API 를 사용하면 서버의 일관된 응답이 보장되고 애플리케이션에 장기적인 API 안정성이 제공됩니다.

다음 섹션에서는 MongoDB 클라이언트 에 대해 Stable API 를 활성화 하고 사용자 지정하는 방법을 설명합니다. Stable API에 포함된 명령 목록을 포함하여 Stable API 에 대한 자세한 내용은 MongoDB 참조 페이지를 참조하세요.

MongoDB 클라이언트에서 Stable API를 활성화합니다.

Stable API를 활성화하려면 MongoDB 클라이언트 설정에서 API 버전을 지정해야 합니다. 지정된 API 버전으로 MongoClient 인스턴스를 인스턴스화하면 클라이언트로 실행하는 모든 명령은 해당 버전의 stable API를 사용합니다.

팁

MongoClient 을(를) 생성한 후에는 Stable API 버전을 변경할 수 없습니다. 두 개 이상의 Stable API 버전을 사용하여 명령을 실행 해야 하는 경우 해당 버전으로 별도의 클라이언트 를 인스턴스화합니다.

Stable API에서 다루지 않는 명령을 실행해야 하는 경우 "엄격" 옵션이 비활성화되어 있는지 확인합니다. 자세한 내용은 Stable API 옵션 섹션을 참조하세요.

다음 예시는 Stable API 버전으로 MongoClient를 인스턴스화하고 다음 작업을 통해 서버에 연결하는 방법을 보여줍니다.

ServerApi 인스턴스 를 생성하고 Stable API 버전을 지정합니다.
MongoClientSettings 객체를 생성하고 ServerApi 속성을 설정합니다.
MongoClientSettings 객체를 사용하여 MongoClient 를 만듭니다.

var serverApi = new ServerApi(ServerApiVersion.V1);
var settings = new MongoClientSettings { ServerApi = serverApi };
var client = new MongoClient(settings);

경고

API 버전을 지정하고 Stable API를 지원하지 않는 MongoDB 서버에 연결하는 경우, 코드가 MongoDB 서버에서 명령을 실행할 때 예외가 발생할 수 있습니다. API 버전을 지정하는 MongoClient를 사용하여 해당 버전을 지원하지 않는 서버를 쿼리하는 경우, 다음 텍스트가 포함된 예외 메시지와 함께 쿼리가 실패할 수 있습니다.

Unrecognized field 'apiVersion' on server...

Stable API 옵션

다음 표의 옵션을 사용하여 stable API 의 동작을 사용자 지정할 수 있습니다.

옵션 이름	설명
엄격한	Optional. When `true`, if you call a command that is not 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 객체를 구성할 때 이러한 옵션을 설정하는 방법을 보여줍니다.

var serverApi = new ServerApi(ServerApiVersion.V1, strict: true,
    deprecationErrors: true);

API 문서

/ 드라이버에서 를 사용하는 방법에 대한 자세한 내용은 stable API MongoDB .NETC# 다음 API 문서를 참조하세요.

돌아가기

Atlas Search

인증