Merge latest nodejs-adapter from 7.3 to 7.4

Author: jdduncan

storage/ndb/nodejs/.bzrignore

@@ -8,3 +8,4 @@ perftest/jscrund.config
 test/disabled-tests.conf
 config.gypi
 config.waf
+benchmark_logs

storage/ndb/nodejs/API-documentation/Batch

@@ -330,6 +330,12 @@ save(String tableName, Object values, [callback], [...]);
  */
 isBatch();
 
+/** How many operations are currently defined in this batch?
+ * @return number of operations in batch
+ * IMMEDIATE
+ */
+getOperationCount();
+
 /** execute()
  * ASYNC
  * Execute this batch. All operations are executed and for each operation

storage/ndb/nodejs/API-documentation/Errors

@@ -31,12 +31,16 @@ var Sqlstates = {
   "22000" : "Data error",
   "22001" : "String too long",
   "22003" : "Numeric value out of range",
-  "22008" : "Invalid datetime",
+  "22007" : "Invalid datetime",
 
   // Constraint violations
   // 23000 includes both duplicate primary key and duplicate unique key
   "23000" : "Integrity Constraint Violation",
 
+  // 0Fxxx "Locator Exception" SQLStates relate to BLOB values
+  // (which must represented in JavaScript as Node Buffers)
+  "0F001" : "Invalid BLOB value",
+
   // misc. errors
   "25000" : "Invalid Transaction State",  
   "2C000" : "Invalid character set name",  

storage/ndb/nodejs/API-documentation/Mynode

@@ -28,6 +28,17 @@ ConnectionProperties(implName_or_connectionProperties);
 TableMapping(tableName_or_tableMapping);
 
 
+/**
+ * Projection()
+ * IMMEDIATE
+ * CONSTRUCTOR
+ *
+ * The Projection constructor is visible as a top-level function.
+ * Refer to the Projection documentation for details.
+ */
+Projection(constructor);
+
+ 
 /**
  * connect()
  * ASYNC

storage/ndb/nodejs/API-documentation/Projection

@@ -0,0 +1,73 @@
+/** @class Projection 
+ *
+ * A Projection describes the projection of a domain object in the application.
+ * A Projection specifies the complete set of fields and relationships to be
+ * instantiated when the operation with which it is used is executed.
+ *
+ * A *default* Projection is one where each field is specified. 
+ *
+ */
+Projection = {
+  domainObject       :  "" ,  /** function */
+  error              :  "",   /** error report for this projection */
+  fields             :  "" ,  /** field names */
+  relationships      : null   /** relationships, which consist of a name and projection */
+};
+
+
+/** Projection constructor 
+ *
+ * @class Projection
+ * @constructor
+ * @param {function} [constructor] 
+*/
+function Projection(constructor) {};
+
+
+
+/*****                      Projection methods 
+                            --------------------                      *****/
+  
+/* @method addFields
+   addFields(fields)
+   IMMEDIATE
+   
+   Add fields by name to the projection
+  
+   @param fields String or [String]
+   The fields parameter is the name of a field or an array of field names.  It can be a string
+   or an array of strings. Multiple field names are accepted as parameters.
+
+    @return {Projection} @chainable
+    addFields() returns the current Projection object, so that method
+    invocations can be chained.
+*/
+  function addFields(fields) {};
+
+/* @method addField
+   ALIAS for addFields for ease of use
+   addField(fields)
+   IMMEDIATE
+   @see addFields
+   
+   Add fields to the projection
+  
+ */
+  function addField(fields) {};
+
+
+/* @method addRelationship
+   addRelationship(name, projection)
+   IMMEDIATE 
+   
+   Add a relationship to the projection.
+   
+   @param name {String} name of the relationship field in the domain object
+   @param projection {Projection} the projection to be assigned to the relationship
+   @return Projection @chainable
+*/
+  function addRelationship(name, projection) {};
+
+
+/* This file is a JavaScript module */
+exports.Projection = Projection;

storage/ndb/nodejs/API-documentation/Session

@@ -214,6 +214,10 @@ remove(String tableName, Object keys, [callback], [...]);
  * If the instance does not exist in the database, an error is reported.
  * This method cannot be used to change the primary key.
  *
+ * To efficiently perform read/modify/write, the user should find the object,
+ * modify the fields to be updated, set the fields *not* to be updated
+ * to undefined, and call update on the object.
+ *
  * This function returns a promise.  On success, the promise will be fulfilled.
  * The optional callback receives only an error value.  Any extra arguments 
  * passed after the callback will be passed to the callback function verbatim
@@ -490,7 +494,17 @@ listTables(databaseName, callback);
 getTableMetadata(databaseName, tableName, callback);
 }
 
-
+/** Use the projection for find and query operations on the domain object.
+ * projection:= {constructor: domainObject, 
+ *   fields: [field, field...], 
+ *   relationships: [relationship, relationship...]}
+ * The domain object must be mapped and will be validated by this function.
+ * If fields is omitted, all fields in the mapping will be fetched.
+ * If relationships is omitted, no relationships in the mapping will be fetched.
+ * This method returns a promise and can use a callback.
+ * ASYNC
+ */
+useProjection(projection, callback);
 
 /* 
  * Users may find useful a "user" property of session and batch.

storage/ndb/nodejs/API-documentation/Stats

@@ -66,56 +66,15 @@
 /********* WRITING APPLICATION-LEVEL STATISTICS **********/
 
 /**
- * To write statistics, obtain a StatWriter for a particular domain, and then
- * use the writer's incr(), set(), and push() methods.
- *
- */
+ * To maintain statistics, a module keeps its own statistics object,
+ * and registers that object with the stats module.
 
-/** Get a stats writer for a domain.
+/** Register statistics for a domain.
  *  IMMEDIATE
  *
- *  The domain is specified as an array literal
  *  EXAMPLES:
- *    var stats = stats_module.get_writer(["app"]);
- *    var stats = stats_module.get_writer(["app","user_connections"]);
- *
- *    stats.incr(["created"]);
- *    stats.incr(["get","cached"]);
- *    stats.set(["login"],"enabled");
- *    stats.push(["users"], current_user);
- */
-  getWriter([ domain ]);
-
-
-/*** StatWriter methods ***/
-  
-/** Coerce the value at domain to a Number, then set it to 1 (if new) 
- *  or increment it (if existing).
- *  The domain is specified as an array literal.
- *  A single-part domain can alternately be given as a string
- *  IMMEDIATE
- * 
- */
- statWriter.incr(domain);
- 
- 
-/** Set the current value at "domain" to "value".
- *  IMMEDIATE
- *  The domain is specified as an array literal.
- *  A single-part domain can alternately be given as a string
- *
- */
- statWriter.set(domain, value);
-
-
-/** Coerce the value at "domain" to an Array, then push value to it.
- *  IMMEDIATE
- *  The domain is specified as an array literal.
- *  A single-part domain can alternately be given as a string
- *
- *  Note that pop(), etc. are missing; to access the array directly, use query() 
- *  to fetch it.
+ *    stats_module.register(my_stats, "app");
+ *    stats_module.register(module_stats, "app","sub_module_1");
  *
  */
- statWriter.push(domain, value);
-
+  register(stats_container, domain_part, ... );

storage/ndb/nodejs/API-documentation/TableMapping

@@ -6,6 +6,8 @@
  * A *default* TableMapping is one where each column in a table is mapped
  * to a field of the same name. 
  *
+ * Errors that are detected during construction of a TableMapping, including
+ * field mapping functions, are reported via the error field. 
  */
 TableMapping = {
   table                  :  "" ,  /** Table name @type String */
@@ -18,11 +20,12 @@ TableMapping = {
                                       @property mapAllColumns @type Boolean 
                                       @default true 
                                   */
-  fields                 : null   /** Holds an array of FieldMapping objects.
+  fields                 : null,  /** Holds an array of FieldMapping objects.
                                       Can also be called "field",
                                       and can also hold a single FieldMapping. 
-                                      @property fields @type Array 
-                                   */
+                                      @property fields @type Array */
+  error                  : ''     /** Reports errors during construction */ 
+ 
 };
 
 

storage/ndb/nodejs/API-documentation/TableMetadata

@@ -9,6 +9,7 @@ TableMetadata = {
   name             : "", // Table Name
   columns          : {}, // ordered array of ColumnMetadata objects
   indexes          : {}, // array of IndexMetadata objects 
+  foreignKeys      : {}, // array of ForeignKeyMetadata objects
   partitionKey     : {}, // ordered array of column numbers in the partition key
 };
 
@@ -40,7 +41,6 @@ ColumnMetadata = {
   /* Group B: Non-numeric */
   length           : 0    ,  //  CHAR or VARCHAR length in characters
   isBinary         : false,  //  true for BLOB/BINARY/VARBINARY
-  charsetNumber    : 0    ,  //  internal number of charset
   charsetName      : ""   ,  //  name of charset
 };
 
@@ -61,6 +61,20 @@ IndexMetadata = {
 };
 
 
+/* ForeignKeyMetadata represents a foreign key constraint.  
+
+   The "foreignKeys" array of TableMetadata will hold the foreign key constraints.
+    
+*/
+ForeignKeyMetadata = {
+  name             : ""    ,  // Constraint name 
+  columnNames      : null  ,  // an ordered array of column numbers
+  targetTable      : ""    ,  // referenced table name
+  targetDatabase   : ""    ,  // referenced database
+  targetColumnNames: null  ,  // an ordered array of target column names
+};
+
+
 ColumnTypes =  [
   "TINYINT",
   "SMALLINT",

storage/ndb/nodejs/Adapter/api/Batch.js

@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2013, Oracle and/or its affiliates. All rights
+ Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights
  reserved.
  
  This program is free software; you can redistribute it and/or
@@ -46,7 +46,7 @@ exports.Batch.prototype.clear = function() {
   // clear all operations from the batch
   // if any pending operations, synchronously call each callback with an error
   // the transaction state is unchanged
-  udebug.log_detail('Batch.clear with operationContexts.length ' + this.operationContexts.length);
+  if(udebug.is_detail()) if(udebug.is_debug()) udebug.log('Batch.clear with operationContexts.length ' + this.operationContexts.length);
   // for each context, extract the operation and clear it
   this.operationContexts.forEach(function(context) {
     // first, mark the context as cleared so if getTableHandler returns during a user callback,
@@ -168,3 +168,7 @@ exports.Batch.prototype.isBatch = function() {
   return true;
 };
 
+exports.Batch.prototype.getOperationCount = function() {
+  return this.operationContexts.length;
+};
+