mongodb-js
diff --git a/‎README.md
Lines changed: 111 additions & 5 deletions b/‎README.md
Lines changed: 111 additions & 5 deletions
diff --git a/‎bin/mongodb-schema.js
Lines changed: 7 additions & 7 deletions b/‎bin/mongodb-schema.js
Lines changed: 7 additions & 7 deletions
diff --git a/‎docs/schema-stats.md
Lines changed: 0 additions & 93 deletions b/‎docs/schema-stats.md
Lines changed: 0 additions & 93 deletions
@@ -118,6 +118,109 @@ Make sure you have a `mongod` running on localhost on port 27017 (or change the
 `mongodb-schema` supports all [BSON types][bson-types].
 Checkout [the tests][tests] for more usage examples.
 
+
+## Schema Statistics
+
+To compare schemas quantitatively we introduce the following measurable metrics on a schema:
+
+### Schema Depth
+The schema depth is defined as the maximum number of nested levels of keys in the schema. It does not matter if the subdocuments are nested directly or as elements of an array. An empty document has a depth of 0, whereas a document with some top-level keys but no nested subdocuments has a depth of 1.
+
+### Schema Width
+The schema width is defined as the number of individual keys, added up over all nesting levels of the schema. Array values do not count towards the schema width.
+
+### Examples
+
+```js
+{}
+```
+
+Statistic    | Value
+:----------- | :---:
+Schema Depth | 0
+Schema Width | 0
+
+
+```js
+{
+  one: 1
+}
+```
+
+Statistic    | Value
+:----------- | :---:
+Schema Depth | 1
+Schema Width | 1
+
+
+```js
+{
+  one: [
+    "foo",
+    "bar",
+    {
+      two: {
+        three: 3
+      }
+    },
+    "baz"
+  ],
+  foo: "bar"
+}
+```
+
+Statistic    | Value
+:----------- | :---:
+Schema Depth | 3
+Schema Width | 4
+
+```js
+{
+  a: 1,
+  b: false,
+  one: {
+    c: null,
+    two: {
+      three: {
+        four: 4,
+        e: "deepest nesting level"
+      }
+    }
+  },
+  f: {
+    g: "not the deepest level"
+  }
+}
+```
+
+Statistic    | Value
+:----------- | :---:
+Schema Depth | 4
+Schema Width | 10
+
+
+```js
+// first document
+{
+  foo: [
+    {
+      bar: [1, 2, 3]
+    }
+  ]
+},
+// second document
+{
+  foo: 0
+}
+```
+
+Statistic    | Value
+:----------- | :---:
+Schema Depth | 2
+Schema Width | 2
+
+
+
 ## Installation
 
 ```
@@ -130,15 +233,18 @@ npm install --save mongodb-schema
 npm test
 ```
 
-## License
-
-Apache 2.0
-
-## Contributing
+## Dependencies
 
 Under the hood, `mongodb-schema` uses [ampersand-state][ampersand-state] and
 [ampersand-collection][ampersand-collection] for modeling [Schema][schema], [Field][field]'s, and [Type][type]'s.
 
+**Note:** Currently we are pinning [ampersand-state][ampersand-state] to version 4.8.2 due
+to a backwards-breaking change introduced in version 4.9.x. For more details, see [ampersand-state issue #226](https://github.com/AmpersandJS/ampersand-state/issues/226).
+
+
+## License
+
+Apache 2.0
 
 
 
 
@@ -47,19 +47,18 @@ var argv = require('yargs')
     type: 'boolean',
     descibe: 'print schema statistics to stderr'
   })
-  .implies('repeat', 'stats')
-  .describe('fast', 'use fast analysis algorithm.')
-  .boolean('fast')
+  .describe('native', 'use native analysis algorithm.')
+  .boolean('native')
   .describe('debug', 'Enable debug messages.')
   .describe('version', 'Show version.')
   .alias('h', 'help')
   .describe('h', 'Show this screen.')
   .help('h')
   .wrap(100)
-  .example('$0 localhost:27017 mongodb.fanclub --sample 1000 --repeat 5 --stats --no-output --fast',
-    'analyze 1000 docs from the mongodb.fanclub collection with the fast parser, repeat 5 times '
+  .example('$0 localhost:27017 mongodb.fanclub --sample 1000 --repeat 5 --stats --no-output --native',
+    'analyze 1000 docs from the mongodb.fanclub collection with the native parser, repeat 5 times '
     + 'and only show statistics.')
-  .example('$0 localhost:27017 test.foo --format table --fast',
+  .example('$0 localhost:27017 test.foo --format table',
     'analyze 100 docs from the test.foo collection and print '
     + 'the schema in table form.')
   .argv;
@@ -139,7 +138,7 @@ mongodb.connect(uri, function(err, conn) {
       .once('data', function() {
         ts = new Date();
       })
-      .pipe(schema.stream(argv.fast))
+      .pipe(schema.stream(argv.native))
       .on('progress', function() {
         bar.tick();
       })
@@ -164,6 +163,7 @@ mongodb.connect(uri, function(err, conn) {
       console.log(output);
     }
     if (argv.stats) {
+      console.error('execution count: ' + argv.repeat);
       console.error('mean time: ' + numeral(stats.mean(res))
           .format('0.00') + 'ms (individual results: %s)', res.toString());
       console.error('stdev time: ' + numeral(stats.stdev(res)).format('0.00') + 'ms');