mythix-orm 1.13.2 → 1.13.3

package/README.md

@@ -99,7 +99,7 @@ class User extends Model {
 
 ## Notes
 
-1. The [WIKI](https://github.com/th317erd/mythix-orm/wiki) is still being worked on. Most of the documentation is complete, but there is still a lot more to write. Documentation is the main focus right now. If you have any questions, feel free to drop a line, or open an issue! We will be happy to answer any questions. We aren't "done" until our documentation is pristine.
+1. The [WIKI](https://github.com/th317erd/mythix-orm/wiki) is still being worked on. Most of the documentation is complete, but there is still a lot more to write. Documentation is the main focus right now. If you have any questions, feel free to drop a line, or open an issue! We will be happy to answer any questions. We aren't "done" until our documentation is pristine. Feel free to drop us a line in our [Discord](https://discord.gg/DZsAYvym9N) server if you need assistance.
 2. Right now there are only database drivers for [SQLite](https://www.npmjs.com/package/mythix-orm-sqlite) and [PostgreSQL](https://www.npmjs.com/package/mythix-orm-postgresql). More are planned, with a Mongo driver likely to land next, followed by MySQL. Help wanted!
 3. Check out the [Mythix](https://www.npmjs.com/package/mythix) web-app framework. It is also still in active development, and the documentation is poor (to say the least), but it is up and coming, and will soon have fantastic documentation, and even though still in active development is fully functional. To get started try `npx mythix-cli create 'Test App'`
 

package/lib/connection/query-generator-base.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const Nife = require('nife');
+
 /// The base query generator class.
 ///
 /// A "query generator" is an interface that will take
@@ -339,6 +341,69 @@ class QueryGeneratorBase {
   // eslint-disable-next-line no-unused-vars
   getFieldDefaultValue(field, fieldName, _options) {
   }
+
+  /// Take a <see>Field</see> instance, and generate
+  /// all index fields for this `field`.
+  ///
+  /// The `index` property on a <see>Field</see> is used
+  /// to generate indexes for the field. If a `true` value
+  /// is encountered in the `index`, it means "this field".
+  /// If another field name is encountered in the `index` property,
+  /// then that means "combine this field with the specified field"
+  /// (to create a combined index). Take the following example:
+  /// ```javascript
+  /// ...
+  /// firstName: {
+  ///   ...
+  ///   index: [
+  ///     true,
+  ///     'lastName',
+  ///     [ 'email', 'lastName' ],
+  ///   ]
+  /// }
+  /// ...
+  /// ```
+  /// This will create three indexes for this "firstName" column in the database:
+  /// 1) `true` = Index the `firstName` column by itself (`idx_users_firstName`)
+  /// 2) `lastName` = Combine `firstName` and `lastName` to create a combined index (`idx_users_firstName_lastName`)
+  /// 3) `[ 'email', 'lastName' ]` = Combine `firstName` with `email` and `lastName` to create a combined index involving three columns (`idx_users_firstName_email_lastName`)
+  /// Using the above example, this method would return the following:
+  /// ```javascript
+  /// [
+  ///   [ 'firstName' ],
+  ///   [ 'firstName', 'lastName' ],
+  ///   [ 'firstName', 'email', 'lastName' ],
+  /// ]
+  /// ```
+  /// Which is the list of indexes, and the fields to index for each index.
+  ///
+  /// Arguments:
+  ///   field: <see>Field</see>
+  ///     The field used to pull the `index` property from.
+  ///
+  /// Return: Array<Array<string>>
+  ///   Return an array of arrays, where the top-level array lists the
+  ///   indexes, and each sub-array lists the fields to combine into an
+  ///   index.
+  getIndexFieldsFromFieldIndex(field) {
+    let indexes = Nife.toArray(field.index).filter((index) => {
+      if (index === true)
+        return true;
+
+      return (Nife.instanceOf(index, 'string', 'array') && Nife.isNotEmpty(index));
+    });
+
+    if (indexes.length === 0)
+      return [];
+
+    return indexes.map((indexNames) => {
+      let fieldIndexNames = [ field.fieldName ];
+      if (indexNames !== true)
+        fieldIndexNames = fieldIndexNames.concat(indexNames);
+
+      return fieldIndexNames;
+    });
+  }
 }
 
 module.exports = QueryGeneratorBase;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mythix-orm",
-  "version": "1.13.2",
+  "version": "1.13.3",
   "description": "ORM for Mythix framework",
   "main": "lib/index",
   "type": "commonjs",