Docs Menu
Docs Home
/ / /
C 드라이버
/

Stable API

이 페이지의 내용

  • 개요
  • stable API활성화
  • stable 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. mongoc_server_api_t 객체를 생성하고 stable API 버전을 지정합니다. mongoc_server_api_t 열거형에 정의된 stable API 버전을 사용해야 합니다.

  2. mongoc_client_t 객체 를 생성합니다.

  3. 클라이언트 와 Stable API 객체 를 mongoc_client_set_server_api 함수에 전달합니다.

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

#include <mongoc/mongoc.h>
int main ()
{
bson_error_t error;
mongoc_init ();
mongoc_server_api_t *stable_api = mongoc_server_api_new (MONGOC_SERVER_API_V1);
mongoc_client_t *client = mongoc_client_new ("<connection string>");
if (!mongoc_client_set_server_api (client, stable_api, &error))
{
fprintf (stderr, "Failed to set Stable API: %s\n", error.message);
return EXIT_FAILURE;
}
// Use the client for operations...
mongoc_server_api_destroy (stable_api);
mongoc_cleanup ();
return EXIT_SUCCESS;
}

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

다음 표에서는 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 객체 를 구성할 때 두 옵션을 모두 true(으)로 설정하다 하는 방법을 보여 줍니다.

mongoc_server_api_t *stable_api = mongoc_server_api_new (MONGOC_SERVER_API_V1);
mongoc_server_api_strict (stable_api, true);
mongoc_server_api_deprecation_errors (stable_api, true);
mongoc_client_t *client = mongoc_client_new ("<connection string>");
if (!mongoc_client_set_server_api (client, stable_api, &error)) {
fprintf (stderr, "Failed to set Stable API: %s\n", error.message);
return EXIT_FAILURE;
}

C 운전자 에서 Stable API 를 사용하는 방법에 대한 자세한 내용은 다음 API 설명서를 참조하세요.

돌아가기

MongoClient 만들기