spanner: add txn id to reads and remove promise support in runTransaction (#2148)

Author: callmehiphop

src/database.js

@@ -714,30 +714,6 @@ Database.prototype.runStream = function(query, options) {
  *     transaction.end();
  *   });
  * });
- *
- * //-
- * // If the callback is omitted, we'll return a Promise.
- * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     // Run a transactional query.
- *     return transaction.run('SELECT * FROM Singers')
- *       .then(function() {
- *         // Queue a mutation (note there is no callback passed to `insert`).
- *         transaction.insert('Singers', {
- *           SingerId: 'Id3b',
- *           Name: 'Joe West'
- *         });
- *
- *         // Commit the transaction.
- *         return transaction.commit();
- *       });
- *   })
- *   .then(function() {
- *     // Transaction committed successfully.
- *   });
  */
 Database.prototype.runTransaction = function(options, runFn) {
   if (is.fn(options)) {
@@ -1020,6 +996,7 @@ common.util.promisifyAll(Database, {
   exclude: [
     'delete',
     'getMetadata',
+    'runTransaction',
     'table',
     'updateSchema',
     'session_'

src/transaction-request.js

@@ -192,18 +192,19 @@ TransactionRequest.formatTimestampOptions_ = function(options) {
  * // If you anticipate many results, you can end a stream early to prevent
  * // unnecessary processing and API requests.
  * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     transaction.createReadStream('Singers', {
- *         keys: ['1'],
- *         columns: ['SingerId', 'name']
- *       })
- *       .on('data', function(row) {
- *         this.end();
- *       });
- *   });
+ * database.runTransaction(function(err, transaction) {
+ *   if (err) {
+ *     // Error handling omitted.
+ *   }
+ *
+ *   transaction.createReadStream('Singers', {
+ *       keys: ['1'],
+ *       columns: ['SingerId', 'name']
+ *     })
+ *     .on('data', function(row) {
+ *       this.end();
+ *     });
+ * });
  */
 TransactionRequest.prototype.createReadStream = function(table, query) {
   var self = this;
@@ -218,6 +219,12 @@ TransactionRequest.prototype.createReadStream = function(table, query) {
     table: table
   }, query);
 
+  if (this.transaction && this.id) {
+    reqOpts.transaction = {
+      id: this.id
+    };
+  }
+
   if (query.keys) {
     reqOpts.keySet = {
       keys: arrify(query.keys).map(function(key) {
@@ -284,26 +291,6 @@ TransactionRequest.prototype.createReadStream = function(table, query) {
  *     'Name2'
  *   ]
  * ];
- *
- * //-
- * // If you are using a Promise to retrieve the transaction.
- * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     // Queue this mutation until later calling `commit`.
- *     // Note that a callback is not passed to `deleteRows`.
- *     transaction.deleteRows('Singers', keys);
- *
- *     // Commit the transaction.
- *     return transaction.commit();
- *   })
- *   .then(function(data) {
- *     var apiResponse = data[0];
- *
- *     // The rows were deleted successfully.
- *   });
  */
 TransactionRequest.prototype.deleteRows = function(table, keys, callback) {
   var mutation = {};
@@ -396,26 +383,6 @@ TransactionRequest.prototype.deleteRows = function(table, keys, callback) {
  *     }
  *   });
  * });
- *
- * //-
- * // If you are using a Promise to retrieve the transaction.
- * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     // Queue this mutation until later calling `commit`.
- *     // Note that a callback is not passed to `insert`.
- *     transaction.insert('Singers', row);
- *
- *     // Commit the transaction.
- *     return transaction.commit();
- *   })
- *   .then(function(data) {
- *     var apiResponse = data[0];
- *
- *     // The row was inserted successfully.
- *   });
  */
 TransactionRequest.prototype.insert = function(table, keyVals, callback) {
   return this.mutate_('insert', table, keyVals, callback);
@@ -516,22 +483,6 @@ TransactionRequest.prototype.insert = function(table, keyVals, callback) {
  *     transaction.end();
  *   });
  * });
- *
- * //-
- * // If the callback is omitted, we'll return a Promise.
- * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     return transaction.read('Singers', query)
- *       .then(function(data) {
- *         var rows = data[0];
- *
- *         // End the transaction. Note that no callback is provided.
- *         transaction.end();
- *       });
- *   });
  */
 TransactionRequest.prototype.read = function(table, keyVals, callback) {
   var rows = [];
@@ -581,26 +532,6 @@ TransactionRequest.prototype.read = function(table, keyVals, callback) {
  *     }
  *   });
  * });
- *
- * //-
- * // If you are using a Promise to retrieve the transaction.
- * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     // Queue this mutation until later calling `commit`.
- *     // Note that a callback is not passed to `replace`.
- *     transaction.replace('Singers', row);
- *
- *     // Commit the transaction.
- *     return transaction.commit();
- *   })
- *   .then(function(data) {
- *     var apiResponse = data[0];
- *
- *     // The row was replaced successfully.
- *   });
  */
 TransactionRequest.prototype.replace = function(table, keyVals, callback) {
   return this.mutate_('replace', table, keyVals, callback);
@@ -659,26 +590,6 @@ TransactionRequest.prototype.requestStream = function() {};
  *     }
  *   });
  * });
- *
- * //-
- * // If you are using a Promise to retrieve the transaction.
- * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     // Queue this mutation until later calling `commit`.
- *     // Note that a callback is not passed to `update`.
- *     transaction.update('Singers', row);
- *
- *     // Commit the transaction.
- *     return transaction.commit();
- *   })
- *   .then(function(data) {
- *     var apiResponse = data[0];
- *
- *     // The row was updated successfully.
- *   });
  */
 TransactionRequest.prototype.update = function(table, keyVals, callback) {
   return this.mutate_('update', table, keyVals, callback);
@@ -719,26 +630,6 @@ TransactionRequest.prototype.update = function(table, keyVals, callback) {
  *     }
  *   });
  * });
- *
- * //-
- * // If you are using a Promise to retrieve the transaction.
- * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     // Queue this mutation until later calling `commit`.
- *     // Note that a callback is not passed to `upsert`.
- *     transaction.upsert('Singers', row);
- *
- *     // Commit the transaction.
- *     return transaction.commit();
- *   })
- *   .then(function(data) {
- *     var apiResponse = data[0];
- *
- *     // The row was updated or inserted successfully.
- *   });
  */
 TransactionRequest.prototype.upsert = function(table, keyVals, callback) {
   return this.mutate_('insertOrUpdate', table, keyVals, callback);

src/transaction.js

@@ -221,27 +221,6 @@ Transaction.prototype.begin = function(callback) {
  *     }
  *   });
  * });
- *
- * //-
- * // If the callback is omitted, we'll return a Promise.
- * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     // Queue a mutation (note that there is no callback passed to `insert`).
- *     transaction.insert('Singers', {
- *       SingerId: 'Id3b',
- *       Name: 'Joe West'
- *     });
- *
- *     return transaction.commit();
- *   })
- *   .then(function(data) {
- *     var apiResponse = data[0];
- *
- *     // Mutations were committed successfully.
- *   });
  */
 Transaction.prototype.commit = function(callback) {
   var self = this;
@@ -342,19 +321,6 @@ Transaction.prototype.requestStream = function(config) {
  *     }
  *   });
  * });
- *
- * //-
- * // If the callback is omitted, we'll return a Promise.
- * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     return transaction.rollback();
- *   })
- *   .then(function() {
- *     // Transaction rolled back successfully.
- *   });
  */
 Transaction.prototype.rollback = function(callback) {
   var self = this;
@@ -440,19 +406,6 @@ Transaction.prototype.rollback = function(callback) {
  *
  *   transaction.run(query, function(err, rows) {});
  * });
- *
- * //-
- * // If the callback is omitted, we'll return a Promise.
- * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
- *
- *     transaction.run(query)
- *       .then(function(data) {
- *         var rows = data[0];
- *       });
- *   });
  */
 Transaction.prototype.run = function(query, callback) {
   var rows = [];
@@ -482,7 +435,7 @@ Transaction.prototype.run = function(query, callback) {
  * @example
  * var query = 'SELECT * FROM Singers';
  *
- * database.runTransaction(function(err) {
+ * database.runTransaction(function(err, transaction) {
  *   if (err) {
  *     // Error handling omitted.
  *   }
@@ -504,7 +457,7 @@ Transaction.prototype.run = function(query, callback) {
  * // The SQL query string can contain parameter placeholders. A parameter
  * // placeholder consists of '@' followed by the parameter name.
  * //-
- * database.runTransaction(function(err) {
+ * database.runTransaction(function(err, transaction) {
  *   if (err) {
  *     // Error handling omitted.
  *   }
@@ -526,15 +479,16 @@ Transaction.prototype.run = function(query, callback) {
  * // If you anticipate many results, you can end a stream early to prevent
  * // unnecessary processing and API requests.
  * //-
- * database.runTransaction()
- *   .then(function(data) {
- *     var transaction = data[0];
+ * database.runTransaction(function(err, transaction) {
+ *   if (err) {
+ *     // Error handling omitted.
+ *   }
  *
- *     transaction.runStream(query)
- *       .on('data', function(row) {})
- *       .on('end', function() {
- *         // All results retrieved.
- *       });
+ *   transaction.runStream(query)
+ *     .on('data', function(row) {
+ *       this.end();
+ *     })
+ *     .on('end', function() {});
  *   });
  */
 Transaction.prototype.runStream = function(query) {