PHPC-165: Rename WriteBatch to BulkWrite

Author: bjori

bin/prep-release.php

@@ -86,7 +86,7 @@ function get_files() {
         "src/libmongoc/src/mongoc/*.{c,h,def,defs}",
 
         "tests/onnect/*.{phpt}",
-        "tests/batch/*.{phpt}",
+        "tests/bulk/*.{phpt}",
         "tests/bson/*.{phpt}",
         "tests/functional/*.{phpt}",
         "tests/generic/*.{phpt}",

config.m4

@@ -180,7 +180,7 @@ if test "$PHONGO" != "no"; then
       src/MongoDB/ReadPreference.c \
       src/MongoDB/Result.c \
       src/MongoDB/Server.c \
-      src/MongoDB/WriteBatch.c \
+      src/MongoDB/BulkWrite.c \
       src/MongoDB/WriteConcern.c \
       src/MongoDB/WriteConcernError.c \
       src/MongoDB/WriteError.c \

docs/batch.md renamed to docs/bulk.md

@@ -19,16 +19,16 @@ $jonpall = array(
 	"citizen" => "Iceland",
 );
 
-/* Ordered batch is executed in the same order as we add the operations to it.
+/* Ordered bulk is executed in the same order as we add the operations to it.
  * If operation fails the execution stops and no further operations executed.
- * For unordered batch, the operations can be executed in any order by the database
+ * For unordered bulk, the operations can be executed in any order by the database
  * in an attempt to optimize its workload. An operation failure will not stop
  * the exection of the rest of the operations.
  * Default: true
  */
 $ordered = true;
 
-$batch = new MongoDB\Driver\WriteBatch($ordered);
+$bulk = new MongoDB\Driver\BulkWrite($ordered);
 
 ?>
 ```
@@ -41,9 +41,9 @@ $batch = new MongoDB\Driver\WriteBatch($ordered);
 /* Argument#1 The document (array/object) to insert.
  * Returns the generated BSON\ObjectID if no _id was provided
  */
-$hannes_id  = $batch->insert($hannes);
-$hayley_id  = $batch->insert($hayley);
-$jonpall_id = $batch->insert($jonpall);
+$hannes_id  = $bulk->insert($hannes);
+$hayley_id  = $bulk->insert($hayley);
+$jonpall_id = $bulk->insert($jonpall);
 
 ?>
 ```
@@ -64,17 +64,17 @@ $jonpall_id = $batch->insert($jonpall);
  *					true: Insert new document matching the criteria
  *					false: Do not insert new document if no matches are found
  */
-$batch->update(
+$bulk->update(
 	array("_id" => $hayley_id),
 	array('$set' => array("citizen" => "Iceland")),
 	array("limit" => 1, "upsert" => false)
 );
-$batch->update(
+$bulk->update(
 	array("citizen" => "Iceland"),
 	array('$set' => array("viking" => true)),
 	array("limit" => 0, "upsert" => false)
 );
-$batch->update(
+$bulk->update(
 	array("name" => "Chuck Norris"),
 	array('$set' => array("viking" => false)),
 	array("limit" => 1, "upsert" => true)
@@ -95,7 +95,7 @@ $batch->update(
  *					0: Delete all matching documents
  *					1: Only delete the first matching document
  */
-$batch->delete(array("_id" => $jonpall_id), array("limit" => 1));
+$bulk->delete(array("_id" => $jonpall_id), array("limit" => 1));
 
 ?>
 ```
@@ -106,7 +106,7 @@ $batch->delete(array("_id" => $jonpall_id), array("limit" => 1));
 <?php
 $manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
 $wc      = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY);
-$result  = $manager->executeWriteBatch("db.collection", $batch, $wc);
+$result  = $manager->executeBulkWrite("db.collection", $bulk, $wc);
 
 printf("insertedCount: %d\n", $result->getInsertedCount());
 printf("matchedCount: %d\n", $result->getMatchedCount());
@@ -122,7 +122,7 @@ $query  = new MongoDB\Driver\Query(array("viking" => false));
 $cursor = $manager->executeQuery("db.collection", $query);
 /* Note that var_dump()ing the $cursor will print out all sorts of debug information
  * about the cursor, such as ReadPreferences used, the query executed, namespace,
- * query flags, and the current batch information */
+ * query flags, and the current bulk information */
 var_dump(iterator_to_array($cursor));
 
 ?>

mkdocs.yml

@@ -4,7 +4,7 @@ theme: spacelab
 pages:
     - [index.md, Home]
     - [crud.md, "CRUD", "Basic"]
-    - [batch.md, "CRUD", "Batches"]
+    - [bulk.md, "CRUD", "Bulks"]
     - [commands.md, Commands]
     - [ods.md, Object Document Serialization]
 extra_javascript:

php_phongo.c

@@ -492,60 +492,60 @@ bool phongo_split_namespace(char *namespace, char **dbname, char **cname) /* {{{
 	return true;
 } /* }}} */
 
-mongoc_bulk_operation_t *phongo_writebatch_init(zend_bool ordered) { /* {{{ */
+mongoc_bulk_operation_t *phongo_bulkwrite_init(zend_bool ordered) { /* {{{ */
 	return mongoc_bulk_operation_new(ordered);
 } /* }}} */
 
 int phongo_execute_single_insert(mongoc_client_t *client, char *namespace, bson_t *doc, mongoc_write_concern_t *write_concern, zval *return_value, int return_value_used TSRMLS_DC) /* {{{ */
 {
 	bool retval = false;
-	mongoc_bulk_operation_t *batch;
+	mongoc_bulk_operation_t *bulk;
 
-	batch = phongo_writebatch_init(true);
-	mongoc_bulk_operation_insert(batch, doc);
+	bulk = phongo_bulkwrite_init(true);
+	mongoc_bulk_operation_insert(bulk, doc);
 
-	retval = phongo_execute_write(client, namespace, batch, write_concern, 0, return_value, return_value_used TSRMLS_CC);
-	mongoc_bulk_operation_destroy(batch);
+	retval = phongo_execute_write(client, namespace, bulk, write_concern, 0, return_value, return_value_used TSRMLS_CC);
+	mongoc_bulk_operation_destroy(bulk);
 
 	return retval;
 } /* }}} */
 
 int phongo_execute_single_update(mongoc_client_t *client, char *namespace, bson_t *query, bson_t *update, mongoc_write_concern_t *write_concern, mongoc_update_flags_t flags, zval *return_value, int return_value_used TSRMLS_DC) /* {{{ */
 {
 	bool retval = false;
-	mongoc_bulk_operation_t *batch;
+	mongoc_bulk_operation_t *bulk;
 
-	batch = phongo_writebatch_init(true);
+	bulk = phongo_bulkwrite_init(true);
 	if (flags & MONGOC_UPDATE_MULTI_UPDATE) {
-		mongoc_bulk_operation_update_one(batch, query, update, !!(flags & MONGOC_UPDATE_UPSERT));
+		mongoc_bulk_operation_update_one(bulk, query, update, !!(flags & MONGOC_UPDATE_UPSERT));
 	} else {
-		mongoc_bulk_operation_update(batch, query, update, !!(flags & MONGOC_UPDATE_UPSERT));
+		mongoc_bulk_operation_update(bulk, query, update, !!(flags & MONGOC_UPDATE_UPSERT));
 	}
-	retval = phongo_execute_write(client, namespace, batch, write_concern, 0, return_value, return_value_used TSRMLS_CC);
-	mongoc_bulk_operation_destroy(batch);
+	retval = phongo_execute_write(client, namespace, bulk, write_concern, 0, return_value, return_value_used TSRMLS_CC);
+	mongoc_bulk_operation_destroy(bulk);
 
 	return retval;
 } /* }}} */
 
 int phongo_execute_single_delete(mongoc_client_t *client, char *namespace, bson_t *query, mongoc_write_concern_t *write_concern, mongoc_delete_flags_t flags, zval *return_value, int return_value_used TSRMLS_DC) /* {{{ */
 {
 	bool retval = false;
-	mongoc_bulk_operation_t *batch;
+	mongoc_bulk_operation_t *bulk;
 
-	batch = phongo_writebatch_init(true);
+	bulk = phongo_bulkwrite_init(true);
 	if (flags & MONGOC_DELETE_SINGLE_REMOVE) {
-		mongoc_bulk_operation_remove_one(batch, query);
+		mongoc_bulk_operation_remove_one(bulk, query);
 	} else {
-		mongoc_bulk_operation_remove(batch, query);
+		mongoc_bulk_operation_remove(bulk, query);
 	}
 
-	retval = phongo_execute_write(client, namespace, batch, write_concern, 0, return_value, return_value_used TSRMLS_CC);
-	mongoc_bulk_operation_destroy(batch);
+	retval = phongo_execute_write(client, namespace, bulk, write_concern, 0, return_value, return_value_used TSRMLS_CC);
+	mongoc_bulk_operation_destroy(bulk);
 
 	return retval;
 } /* }}} */
 
-bool phongo_execute_write(mongoc_client_t *client, char *namespace, mongoc_bulk_operation_t *batch, mongoc_write_concern_t *write_concern, int server_hint, zval *return_value, int return_value_used TSRMLS_DC) /* {{{ */
+bool phongo_execute_write(mongoc_client_t *client, char *namespace, mongoc_bulk_operation_t *bulk, mongoc_write_concern_t *write_concern, int server_hint, zval *return_value, int return_value_used TSRMLS_DC) /* {{{ */
 {
 	bson_error_t error;
 	bson_t reply;
@@ -558,18 +558,18 @@ bool phongo_execute_write(mongoc_client_t *client, char *namespace, mongoc_bulk_
 		return false;
 	}
 
-	mongoc_bulk_operation_set_database(batch, dbname);
-	mongoc_bulk_operation_set_collection(batch, collname);
-	mongoc_bulk_operation_set_client(batch, client);
-	mongoc_bulk_operation_set_write_concern (batch, write_concern);
+	mongoc_bulk_operation_set_database(bulk, dbname);
+	mongoc_bulk_operation_set_collection(bulk, collname);
+	mongoc_bulk_operation_set_client(bulk, client);
+	mongoc_bulk_operation_set_write_concern (bulk, write_concern);
 	efree(dbname);
 	efree(collname);
 
 	if (server_hint) {
-		mongoc_bulk_operation_set_hint(batch, server_hint);
+		mongoc_bulk_operation_set_hint(bulk, server_hint);
 	}
 
-	hint = mongoc_bulk_operation_execute(batch, &reply, &error);
+	hint = mongoc_bulk_operation_execute(bulk, &reply, &error);
 
 	/* If there is no error then the command succeeded, but the write not */
 	if (!hint && (error.code || error.domain)) {
@@ -1608,7 +1608,7 @@ PHP_MINIT_FUNCTION(phongo)
 	PHP_MINIT(ReadPreference)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(Result)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(Server)(INIT_FUNC_ARGS_PASSTHRU);
-	PHP_MINIT(WriteBatch)(INIT_FUNC_ARGS_PASSTHRU);
+	PHP_MINIT(BulkWrite)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(WriteConcern)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(WriteConcernError)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(WriteError)(INIT_FUNC_ARGS_PASSTHRU);

php_phongo.h

@@ -102,8 +102,8 @@ PHONGO_API zend_object_handlers *phongo_get_std_object_handlers(void);
 
 void phongo_server_init                              (zval *return_value, int server_hint, mongoc_host_list_t *host TSRMLS_DC);
 bool                     phongo_query_init           (php_phongo_query_t *query, zval *filter, zval *options TSRMLS_DC);
-mongoc_bulk_operation_t* phongo_writebatch_init      (zend_bool ordered);
-bool                     phongo_execute_write        (mongoc_client_t *client, char *namespace, mongoc_bulk_operation_t *batch, mongoc_write_concern_t *write_concern, int server_hint, zval *return_value, int return_value_used TSRMLS_DC);
+mongoc_bulk_operation_t* phongo_bulkwrite_init      (zend_bool ordered);
+bool                     phongo_execute_write        (mongoc_client_t *client, char *namespace, mongoc_bulk_operation_t *bulk, mongoc_write_concern_t *write_concern, int server_hint, zval *return_value, int return_value_used TSRMLS_DC);
 int                      phongo_execute_command      (mongoc_client_t *client, char *db, bson_t *command, mongoc_read_prefs_t *read_preference, zval *return_value, int return_value_used TSRMLS_DC);
 int                      phongo_execute_query        (mongoc_client_t *client, char *namespace, php_phongo_query_t *query, mongoc_read_prefs_t *read_preference, zval *return_value, int return_value_used TSRMLS_DC);
 int                      phongo_execute_single_insert(mongoc_client_t *client, char *namespace, bson_t *doc, mongoc_write_concern_t *write_concern, zval *return_value, int return_value_used TSRMLS_DC);

php_phongo_classes.h

@@ -101,8 +101,8 @@ typedef struct {
 
 typedef struct {
 	zend_object              std;
-	mongoc_bulk_operation_t *batch;
-} php_phongo_writebatch_t;
+	mongoc_bulk_operation_t *bulk;
+} php_phongo_bulkwrite_t;
 
 typedef struct {
 	zend_object              std;
@@ -193,7 +193,7 @@ extern PHONGO_API zend_class_entry *php_phongo_query_ce;
 extern PHONGO_API zend_class_entry *php_phongo_readpreference_ce;
 extern PHONGO_API zend_class_entry *php_phongo_result_ce;
 extern PHONGO_API zend_class_entry *php_phongo_server_ce;
-extern PHONGO_API zend_class_entry *php_phongo_writebatch_ce;
+extern PHONGO_API zend_class_entry *php_phongo_bulkwrite_ce;
 extern PHONGO_API zend_class_entry *php_phongo_writeconcern_ce;
 extern PHONGO_API zend_class_entry *php_phongo_writeconcernerror_ce;
 extern PHONGO_API zend_class_entry *php_phongo_writeerror_ce;
@@ -234,7 +234,7 @@ PHP_MINIT_FUNCTION(Query);
 PHP_MINIT_FUNCTION(ReadPreference);
 PHP_MINIT_FUNCTION(Result);
 PHP_MINIT_FUNCTION(Server);
-PHP_MINIT_FUNCTION(WriteBatch);
+PHP_MINIT_FUNCTION(BulkWrite);
 PHP_MINIT_FUNCTION(WriteConcern);
 PHP_MINIT_FUNCTION(WriteConcernError);
 PHP_MINIT_FUNCTION(WriteError);