Skip to content

CDRIVER-3991 Add versioned API connection examples #805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 25, 2021
Merged

CDRIVER-3991 Add versioned API connection examples #805

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
10a5cd3
CDRIVER-3991 Add versioned API connection examples
alcaeus Jun 22, 2021
21c4a21
Use mongoc_client_new in public examples
alcaeus Jun 24, 2021
d5e134b
Test versioned API samples on 4.9+ only
alcaeus Jun 24, 2021
f1c7c4a
Free client and server_api object in tests
alcaeus Jun 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 146 additions & 2 deletions src/libmongoc/tests/test-mongoc-sample-commands.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3464,11 +3464,11 @@ with_transaction_example (bson_error_t *error)
* members in the URI string; e.g.
* uri_repl = "mongodb://mongodb0.example.com:27017,mongodb1.example.com:" \
* "27017/?replicaSet=myRepl";
* client = test_framework_client_new (uri_repl);
* client = mongoc_client_new (uri_repl);
* For a sharded cluster, connect to the mongos instances; e.g.
* uri_sharded =
* "mongodb://mongos0.example.com:27017,mongos1.example.com:27017/";
* client = test_framework_client_new (uri_sharded);
* client = mongoc_client_new (uri_sharded);
*/

client = get_client ();
Expand Down Expand Up @@ -3572,6 +3572,146 @@ callback (mongoc_client_session_t *session,
}
/* End Transactions withTxn API Example 1 */

static void
_test_sample_versioned_api_example_1 (void)
{
/* Start Versioned API Example 1 */
mongoc_client_t *client = NULL;
mongoc_server_api_t *server_api = NULL;
mongoc_server_api_version_t server_api_version;
bson_error_t error;

/* For a replica set, include the replica set name and a seedlist of the
* members in the URI string; e.g.
* uri_repl = "mongodb://mongodb0.example.com:27017,mongodb1.example.com:" \
* "27017/?replicaSet=myRepl";
* client = mongoc_client_new (uri_repl);
* For a sharded cluster, connect to the mongos instances; e.g.
* uri_sharded =
* "mongodb://mongos0.example.com:27017,mongos1.example.com:27017/";
* client = mongoc_client_new (uri_sharded);
*/

client = get_client ();

mongoc_server_api_version_from_string ("1", &server_api_version);
server_api = mongoc_server_api_new (server_api_version);

mongoc_client_set_server_api (client, server_api, &error);
/* End Versioned API Example 1 */
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a mongoc_client_destroy (client) and mongoc_server_api_destroy (server_api).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in all 4 tests (outside of the sample code)


mongoc_client_destroy (client);
mongoc_server_api_destroy (server_api);
}

static void
_test_sample_versioned_api_example_2 (void)
{
/* Start Versioned API Example 2 */
mongoc_client_t *client = NULL;
mongoc_server_api_t *server_api = NULL;
mongoc_server_api_version_t server_api_version;
bson_error_t error;

/* For a replica set, include the replica set name and a seedlist of the
* members in the URI string; e.g.
* uri_repl = "mongodb://mongodb0.example.com:27017,mongodb1.example.com:" \
* "27017/?replicaSet=myRepl";
* client = mongoc_client_new (uri_repl);
* For a sharded cluster, connect to the mongos instances; e.g.
* uri_sharded =
* "mongodb://mongos0.example.com:27017,mongos1.example.com:27017/";
* client = mongoc_client_new (uri_sharded);
*/

client = get_client ();

mongoc_server_api_version_from_string ("1", &server_api_version);
server_api = mongoc_server_api_new (server_api_version);
mongoc_server_api_strict (server_api, true);

mongoc_client_set_server_api (client, server_api, &error);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a mongoc_client_destroy (client) and mongoc_server_api_destroy (server_api).

/* End Versioned API Example 2 */

mongoc_client_destroy (client);
mongoc_server_api_destroy (server_api);
}

static void
_test_sample_versioned_api_example_3 (void)
{
/* Start Versioned API Example 3 */
mongoc_client_t *client = NULL;
mongoc_server_api_t *server_api = NULL;
mongoc_server_api_version_t server_api_version;
bson_error_t error;

/* For a replica set, include the replica set name and a seedlist of the
* members in the URI string; e.g.
* uri_repl = "mongodb://mongodb0.example.com:27017,mongodb1.example.com:" \
* "27017/?replicaSet=myRepl";
* client = mongoc_client_new (uri_repl);
* For a sharded cluster, connect to the mongos instances; e.g.
* uri_sharded =
* "mongodb://mongos0.example.com:27017,mongos1.example.com:27017/";
* client = mongoc_client_new (uri_sharded);
*/

client = get_client ();

mongoc_server_api_version_from_string ("1", &server_api_version);
server_api = mongoc_server_api_new (server_api_version);
mongoc_server_api_strict (server_api, false);

mongoc_client_set_server_api (client, server_api, &error);
/* End Versioned API Example 3 */
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a mongoc_client_destroy (client) and mongoc_server_api_destroy (server_api).


mongoc_client_destroy (client);
mongoc_server_api_destroy (server_api);
}

static void
_test_sample_versioned_api_example_4 (void)
{
/* Start Versioned API Example 4 */
mongoc_client_t *client = NULL;
mongoc_server_api_t *server_api = NULL;
mongoc_server_api_version_t server_api_version;
bson_error_t error;

/* For a replica set, include the replica set name and a seedlist of the
* members in the URI string; e.g.
* uri_repl = "mongodb://mongodb0.example.com:27017,mongodb1.example.com:" \
* "27017/?replicaSet=myRepl";
* client = mongoc_client_new (uri_repl);
* For a sharded cluster, connect to the mongos instances; e.g.
* uri_sharded =
* "mongodb://mongos0.example.com:27017,mongos1.example.com:27017/";
* client = mongoc_client_new (uri_sharded);
*/

client = get_client ();

mongoc_server_api_version_from_string ("1", &server_api_version);
server_api = mongoc_server_api_new (server_api_version);
mongoc_server_api_deprecation_errors (server_api, true);

mongoc_client_set_server_api (client, server_api, &error);
/* End Versioned API Example 4 */
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a mongoc_client_destroy (client) and mongoc_server_api_destroy (server_api).


mongoc_client_destroy (client);
mongoc_server_api_destroy (server_api);
}

static void
test_sample_versioned_api (void)
{
_test_sample_versioned_api_example_1 ();
_test_sample_versioned_api_example_2 ();
_test_sample_versioned_api_example_3 ();
_test_sample_versioned_api_example_4 ();
}

static void
test_sample_commands (void)
{
Expand Down Expand Up @@ -3649,6 +3789,10 @@ test_sample_commands (void)
test_sample_txn_commands (client);
}

if (test_framework_max_wire_version_at_least (WIRE_VERSION_4_9)) {
test_sample_versioned_api ();
}

mongoc_collection_drop (collection, NULL);

mongoc_collection_destroy (collection);
Expand Down