Stable API

개요

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

Stable API 기능은 지정한 API 버전 과 호환되는 동작으로 서버가 작업을 실행하도록 합니다. API 버전은 다루는 작업의 예상 동작과 서버 응답 형식을 정의합니다. 작업 및 서버 응답은 지정하는 API 버전에 따라 다를 수 있습니다.

정식 MongoDB 드라이버와 함께 Stable API 기능을 사용하면 Stable API에서 다루는 명령의 이전 버전과의 호환성 문제를 걱정하지 않고 드라이버 또는 서버를 업데이트할 수 있습니다.

서버에서 다루는 명령에 대해 자세히 알아보려면 MongoDB 서버 매뉴얼에서 stable API 를 참조하세요.

API 버전 지정

To specify an API version, define a ServerApi struct and set the server_api field of your ClientOptions instance to this struct. The ServerApi struct contains the API version and options. To learn more about setting options, see the Modify Behavior section of this guide.

API 버전을 지정하면 클라이언트는 해당 버전과 호환되는 작업만 실행합니다.

let server_api = ServerApi::builder().version(ServerApiVersion::V1).build();
client_options.server_api = Some(server_api);
let client = Client::with_options(client_options)?;

동작 수정

ServerApi 구조체의 필드를 설정하여 Stable API 기능의 동작을 수정할 수 있습니다.

ServerApi 구조체의 필드를 수동으로 설정할 수도 있지만, 빌더 디자인 패턴을 사용하여 구조체를 더 효율적으로 정의할 수 있습니다.

let mut client_options = ClientOptions::parse(uri)?;
let server_api = ServerApi::builder()
    .version(ServerApiVersion::V1)
    .strict(true)
    .deprecation_errors(true)
    .build();
client_options.server_api = Some(server_api);
let client = Client::with_options(client_options)?;

추가 정보

MongoDB 인스턴스 또는 복제본 세트에 연결하는 방법에 대해 자세히 알아보려면 연결 가이드를 참조하세요.