Docs Menu

Docs Home애플리케이션 개발Python 드라이버PyMongo

Stable API

이 페이지의 내용

  • 개요
  • stable API활성화
  • stable API구성
  • 문제 해결
  • 서버의 인식할 수 없는 필드 'apiVersion'
  • apiStrict:true를 제공했지만 명령 수가 API 버전에 없음
  • API 문서

참고

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

이 가이드에서는 stable API MongoDB deployment에 연결할 때 호환성을 지정하는 방법을 배울 수 있습니다.

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

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

stable API 를 활성화하려면 다음 단계를 수행하세요.

  1. ServerApi 객체를 생성하고 stable API 버전을 지정합니다. ServerApiVersion 열거형에 정의된 stable API 버전을 사용해야 합니다.

  2. server_api 인수에 대해 ServerApi 객체를 전달하여 MongoClient 객체를 생성합니다.

다음 코드 예시에서는 stable API 버전 1을 지정하는 방법을 보여줍니다.

from pymongo import MongoClient
from pymongo.server_api import ServerApi
client = MongoClient("mongodb://<username>:<password>@<hostname:<port>",
server_api=ServerApi("1"))

지정된 API 버전으로 MongoClient 인스턴스를 생성하면 클라이언트로 실행하는 모든 명령이 지정된 버전을 사용합니다. 두 개 이상의 stable API 버전을 사용하여 명령을 실행해야 하는 경우 새 MongoClient을 만듭니다.

다음 표에서는 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
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 객체를 구성할 때 이러한 매개변수를 사용하는 방법을 보여줍니다.

from pymongo import MongoClient
from pymongo.server_api import ServerApi
client = MongoClient("mongodb://<username>:<password>@<hostname:<port>",
server_api=ServerApi("1",
strict=True,
deprecation_errors=True))

API 버전을 지정하고 Stable API를 지원하지 않는 MongoDB 서버에 연결하는 경우 PyMongo에서 이 예외가 발생합니다. MongoDB Server v5.0 이상을 실행하는 배포에 연결하고 있는지 확인합니다.

에서 지정한 버전이 아닌 작업을 실행하는PyMongo 경우 이 예외가 발생합니다.MongoClient stable API 이 오류를 방지하려면 지정된 stable API 버전에서 지원하는 대체 작업을 사용하거나 ServerApi 객체를 구성할 때 strict 옵션을 False 로 설정합니다.

에서 를 사용하는 방법에 대한 stable API PyMongo 자세한 API 내용은 다음 문서를 참조하세요.

← MongoDB 서버 선택 사용자 지정