Stable API

이 페이지의 내용

개요

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

참고

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

연결 중인 모든 MongoDB 서버가 이 기능을 지원하는 경우에만 Stable API 기능을 사용합니다.

개요

본 가이드에서는 MongoDB 인스턴스 혹은 복제본 세트에 연결할 때 Stable API 를 지정하는 방법을 힉습할 수 있습니다. Stable API 기능을 사용하여 서버가 지정된 API 버전과 호환되는 동작으로 작업을 실행하도록 할 수 있습니다. API 버전은 다루는 작업의 예상 동작과 서버 응답 포맷을 정의합니다. 다른 API 버전으로 변경하면 작업의 호환성이 보장되지 않고 서버 응답도 유사하지 않습니다.

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

지원되는 명령어 목록 등 자세한 내용은 Stable API 에서 MongoDB 참고 페이지를 참조합니다.

다음 섹션에서는 MongoDB 클라이언트에 Stable API를 활성화하는 방법과 지정할 수 있는 옵션에 대해 설명합니다.

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

Stable API를 활성화하려면 MongoClient 에 전달된 MongoClientOptions 파일에 API 버전을 지정해야 합니다. 지정된 API 버전으로 MongoClient 인스턴스를 인스턴스화하는 경우 해당 클라이언트로 실행하는 명령어는 모두 해당 버전의 Stable API를 사용합니다.

팁

명령을 실행하려는 Stable API의 각 버전에 대해: 새 클라이언트를 만들어야 합니다.

Stable API에서 처리되지 않는 명령을 실행하려면 '엄격성' 옵션이 비활성화돼 있는지 확인하세요. 자세한 내용은 Stable API 옵션 섹션을 참조하세요.

아래 예제에서는 다음 작업을 수행하여 Stable API 버전을 설정하고 서버에 연결하는 MongoClient를 인스턴스화하는 방법을 보여 줍니다:

연결할 서버 URI를 지정합니다.
ServerApiVersion 객체의 상수를 사용해 MongoClientOptions 객체에서 Stable API 버전을 지정합니다.
MongoClient를 인스턴스화해 생성자에게 URI와 MongoClientOptions을 전달합니다.

const { MongoClient, ServerApiVersion } = require("mongodb");
// Replace the placeholders in the connection string uri with your credentials
const uri = "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
// Create a client with options to specify Stable API Version 1
const client = new MongoClient(uri, { serverApi: ServerApiVersion.v1 });

경고

API 버전을 지정하고 Stable API를 지원하지 않는 MongoDB 서버에 연결할 경우 애플리케이션에서 MongoDB 서버에 연결할 때 다음 텍스트와 함께 오류가 발생할 수 있습니다.

MongoParseError: Invalid server API version=...

이 섹션에 언급된 메서드 및 클래스에 대한 자세한 내용은 다음 API 문서를 참조하세요.

Stable API 옵션

다음 표에 설명된 대로 Stable API와 관련된 선택적 동작을 활성화하거나 비활성화할 수 있습니다.

옵션 이름	설명
버전	Required. Specifies the version of the Stable API. Default: null
strict	Optional. When set, if you call a command that is not part of the declared API version, the driver raises an exception. Default: false
deprecationErrors	Optional. When set, if you call a command that is deprecated in the declared API version, the driver raises an exception. Default: false

다음 예시에서는 ServerApi 인터페이스의 옵션을 설정하는 방법을 보여 줍니다.

const { MongoClient, ServerApiVersion } = require("mongodb");
// Replace the placeholders in the connection string uri with your credentials
const uri = "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
/* Create a client with options to specify Stable API Version 1, return
errors for commands outside of the API version, and raise exceptions
for deprecated commands */
const client = new MongoClient(uri,
    {
        serverApi: {
            version: ServerApiVersion.v1,
            strict: true,
            deprecationErrors: true,
        }
    });

이 섹션의 옵션에 대한 자세한 내용은 다음 API 문서를 참조하세요.

서버API

돌아가기

SOCKS5 프록시 지원

인증