| key | \ntype | \nrequired? | \ndescription | \nexample |
|---|---|---|---|---|
| storage | \nstring | \nno | \ntype of external storages. oneof \"mock\", file\" \"local\" \"session\" \nWhen running in Node.js or in Titanium, \"file\" is set by default. \nuniqId is the path name to save the data to.\nWhen running in browsers, \"local\" is set by default. \nlocal means \"localStorage\", session means \"sessionStorage\".\nWhen running in Web Worker, \"mock\" is set and no other options can be selected. \n\"mock\" saves nothing. This is limitation of Web Worker which cannot access to Web Storages.\nIn this case, exporting the data to the main thread, we can manually handle and store the data. \n | \n\"file\" | \n
| schema | \nobject | \nrequired | \nDB schema | \n(see SCHEMA JSON) |
| reset | \nboolean | \nno (default false) | \nif true, reset db with the given schema. | \ntrue |
| name | \nstring | \nno (default : the same as uniqId) | \nthe name of the db | \nappname_test |
| autosave | \nboolean | \nno (default false) | \nwhether to auto-saving or not | \ntrue |
| key | \ntype | \ndescription | \nexample |
| (columnName) | \ncolumnDescription | \ncolumn to set. \nname limitation \nCannot set [id, ins_at, upd_at] as they are already used by default. \nCannot set [$indexes, $uniques, $classes] as they make conflict in schema description. \nCannot set [str, num, bool, on, off] as they make conflict in column description. \nCannot set [join, order, limit, offset, as, where, select, explain] as they make conflict in search options. \nCannot include \",\" or \".\" as it is used in indexing or searching. \nCannot set (RelatedTableName)_id as it is automatically set. \n | \nage: \"num\" | \n
|---|---|---|---|
| $indexes | \nArray | \nlist of indexes. child arrays are lists of columns to make an index. \nIf string given, converted as array with the value \n | \n[[\"name\"], [\"firstName\", \"lastName\"]] |
| $uniques | \nArray | \n(the same as $indexes, but this means unique index) | \n[[\"name\", \"pass\"]] |
| $classes | \nArray | \n(the same as $indexes, but this means classified index) | \n\"type_num\" |
| example | \ndescription | \n\n
| {type: \"str\"} | \ntype is string.\ntype must be one of [\"str\", \"num\", \"bool\", (columnName)]\n |
|---|---|
| {type: \"str\", required: false} | \ntype is string, and if not given, null is set.\nrequired option is false by default\n |
| {type: \"bool\", _default: true} | \ntype is boolean, and if not given, true is set. |
| {type: \"num\", required: true} | \ntype is number, and if not given, an exception is thrown. |
| \"str\" | \ntype is string, and not required. |
| \"num\" | \ntype is number, and not required. |
| \"bool\" | \ntype is boolean, and not required. |
| true | \ntype is string, and required. |
| false | \ntype is string, and not required. |
| 1 | \ntype is number, and required. |
| 0 | \ntype is number, and not required. |
| \"on\" | \ntype is boolean, and default value is true. |
| \"off\" | \ntype is boolean, and default value is false. |
| {type: tableName} | \ntype is the instance of a record in tableName. \nthe column columnName_id is automatically created. \nWe can set columnName_id instead of columnName in insertion and updating. \nThis column is required unless you set required: false.\n |
| {type: tableName, required: false} | \ntype is the instance of a record in tableName and not required. \n |
| tableName | \ntype is the instance of a record in tableName and required. \n |
| key | \ntype | \nrequired? | \ndescription | \nexample |
|---|---|---|---|---|
| force | \nboolean | \nno (default : false) | \nif true, overrides already-existing database of the same uniqId.\notherwise throws an error. | \ntrue |
| name | \nstring | \nno | \nthe name of the db. If undefined, the imported name is used. | \nappname_2 |
| autosave | \nboolean | \nno | \nwhether to auto-saving or not. If undefineed, the imported autosave preference is used. | \ntrue |
| storage | \nstring | \nno | \ntype of external storages. see options of JSRel.use().\nIf undefined, the imported storage preference is used.\n | \n\"file\" | \n
| event name | \nemitted when | \narguments to be passed | \n
|---|---|---|
| ins | \ndata are inserted | \n\n
| \n
| ins:{tablename} | \ndata are inserted into {tablename} | \n\n
| \n
| upd | \ndata are updated | \n\n
| \n
| upd:{tablename} | \ndata are updated in {tablename} | \n\n
| \n
| del | \ndata are deleted | \n\n
| \n
| del:{tablename} | \ndata are deleted in {tablename} | \n\n
| \n
| save:start | \nat the start of jsrel.save() | \n\n
| \n
| save:end | \nat the end of jsrel.save() | \n\n
| \n
| option name | \ntype | \ndescription | \ndefault | \n
|---|---|---|---|
| unshift | \nboolean | \nregisters a function to the top of the list | \nfalse | \n
| option name | \ntype | \ndescription | \ndefault | \nexample |
|---|---|---|---|---|
| noschema | \nboolean | \nif true, schema SQLs (create statements) are not generated. | \nnull | \ntrue | \n
| db | \nboolean or string | \nif true, create database whose name is id of the db, if string given, the value is set as database's name.\nif not set, database creation (CREATE DATABASE xxxx) does not occur.\n | null | \ntrue | \n
| nodrop | \nboolean | \nif true, drop statements are not generated. | \nnull | \ntrue | \n
| nodata | \nboolean | \nif true, data SQLs (insert statements) are not generated. | \nnull | \ntrue | \n
| type | \nstring | \ntype of RDBs. Currently, \"mysql\" is only tested. | \n\"mysql\" | \n\"mysql\" | \n
| engine | \nstring | \nMySQL engine (only enabled when options.type is \"mysql\") | \n\"InnoDB\" | \n\"MyISAM\" | \n
| rails (unstable) | \nboolean | \nif true, rails-like date format (created_at, inserted_at) is output. | \nnull | \ntrue | \n
| example | \ndescription | \n\n
| {name: \"shinout\"} | \nname must be equal to \"shinout\" |
|---|---|
| {name: [\"shinout\", \"nishiko\"]} | \nname must be equal to \"shinout\" or \"nishiko\" |
| {name: {like$: \"shin\"}} | \nname must be like \"shin%\" |
| {name: {$like: \"inout\"}} | \nname must be like \"%inout\" |
| {name: [{$like: \"inout\"}, {equal: \"nishiko\"}] } | \nname must be like \"%inout\" OR equals \"nishiko\" |
| {name: {$like: \"inout\", equal: \"nishiko\"} } | \nname must be like \"%inout\" AND equals \"nishiko\" |
| {age: {gt: 24} } | \nage must be greater than 24 |
| {age: {gt: 24, le: 40} } | \nage must be greater than 24 and less equal 40 |
| {age: [{ge: 24}, {lt: 40}] } | \nage must be greater equal 24 or less than 40 |
| {country: {$in: [\"Japan\", \"Korea\"] } | \ncountry must be one of \"Japan\", \"Korea\" (as \"in\" is a reserved word in JavaScript, used \"$in\" instead.) |
| {name: \"shinout\", age : {ge: 70 } | \nmust returns empty until shinout becomes 70 |
| key | \ntype | \ndescription | \nexample |
|---|---|---|---|
| order | \nmixed | \nsee order description | \n{ name: \"asc\" } | \n
| limit | \nint | \nthe end position of the data | \n20 |
| offset | \nint | \noffset of the results | \n10 |
| join | \nmixed | \nsee join description | \n{records.scene: {title : {like$: \"ABC\"} } |
| select | \nstring (one of column names) | \nget list of selected columns instead of objects | \n\"title\" |
| select | \narray (list of column names) | \nget list of object which contains the given columns instead of all columns | \n[\"name\", \"age\"] |
| explain | \nobject | \nput searching information to the given object | \n{} |
| example | \ndescription | \n\n
| \"age\" | \norder by age asc |
|---|---|
| {age: \"desc\"} | \norder by age desc |
| {age: \"desc\", name: \"asc\"} | \norder by age desc, name asc |
group
\n| id | name |
| 1 | mindia |
| 2 | ZZZ |
user
\n| id | name | age | group |
| 1 | shinout | 25 | 1 |
| 2 | nishiko | 28 | 1 |
| 3 | xxx | 39 | 2 |
card
\n| id | title | body |
| 1 | rabbit | it jumps! |
| 2 | pot | a tiny yellow magic pot |
| 3 | PC | calculating... |
user_card
\n| id | user | card |
| 1 | 1 | 1 |
| 2 | 2 | 1 |
| 3 | 1 | 2 |
| 4 | 2 | 3 |
| 5 | 3 | 3 |
| No. | \nJOIN_VALUE | \ndescription | \nresult |
| 1 | \n\"group\" | \nget \"group\" column as object | \n[{id: 1, name: \"shinout\", age: 25, group_id: 1, group: {id: 1, name: \"mindia\"}}] | \n
|---|---|---|---|
| 2 | \n{group : true} | \nget \"group\" column as object (the same as sample1) | \n[{id: 1, name: \"shinout\", age: 25, group_id: 1, group: {id: 1, name: \"mindia\"}}] | \n
| 3 | \ntrue | \nget all the related columns as object | \n[{id: 1, name: \"shinout\", age: 25, group_id: 1, group: {id: 1, name: \"mindia\"}}] | \n
| 4 | \n{group : {name: {like$: \"mind\"}}} | \nget \"group\" column as object whose name starts at \"mind\" | \n[{id: 1, name: \"shinout\", age: 25, group_id: 1, group: {id: 1, name: \"mindia\"}}] | \n
| 5 | \n{group : {name: \"ZZZ\"}} | \nget \"group\" column as object whose name is equal to \"ZZZ\" | \n[] // empty | \n
| No. | \nJOIN_VALUE | \ndescription | \nresult |
| 6 | \n\"user.group\" | \nget \"user\" table objects (setting the related column in \"user\" table) | \n[{id: 1, name: \"mindia\", \"user.group\": [{id: 1, name: \"shinout\", age: 25}, {id: 2, name: \"nishiko\", age: 28}]}] | \n
|---|---|---|---|
| 7 | \n\"user\" | \nget \"user\" table objects (if related column is obvious) | \n[{id: 1, name: \"mindia\", \"user\": [{id: 1, name: \"shinout\", age: 25}, {id: 2, name: \"nishiko\", age: 28}]}] | \n
| 8 | \n{\"user.group\" : true } | \nget \"user\" table objects (the same as sample6) | \n[{id: 1, name: \"mindia\", \"user.group\": [{id: 1, name: \"shinout\", age: 25}, {id: 2, name: \"nishiko\", age: 28}]}] | \n
| 9 | \n{\"user.group\" : {age : {gt: 27}} } | \nget \"user\" table objects with age greater than 27 | \n[{id: 1, name: \"mindia\", \"user.group\": [{id: 2, name: \"nishiko\", age: 28}]}] | \n
| 10 | \n{\"user.group\" : {age : {gt: 27}, as: \"users\"} } | \nget \"user\" table objects with age greater than 27, with alias name \"users\" | \n[{id: 1, name: \"mindia\", \"users\": [{id: 2, name: \"nishiko\", age: 28}]}] | \n
| 11 | \n{\"user.group\" : {where : {age : {gt: 27}}, as: \"users\"} } | \nget \"user\" table objects with age greater than 27, with alias name \"users\" (the canonical expression of sample9) | \n[{id: 1, name: \"mindia\", \"users\": [{id: 2, name: \"nishiko\", age: 28}]}] | \n
| 12 | \n{user : {age : {gt: 27}, as: \"users\"} } | \nget \"user\" table objects with age greater than 27, with alias name \"users\" | \n[{id: 1, name: \"mindia\", \"users\": [{id: 2, name: \"nishiko\", age: 28}]}] | \n
| 13 | \n{user : {age : {gt: 47}, outer: true} } | \nouter joining. Records containing Empty 1:N subqueries can be remained with the column filled with null. | \n[{id: 1, name: \"mindia\", \"user\": null}] | \n
| 13 | \n{user : {age : {gt: 47}, outer: \"array\"} } | \nouter joining. Records containing Empty 1:N subqueries can be remained with the column filled with empty array. | \n[{id: 1, name: \"mindia\", \"user\": [] }] | \n
| 15 | \n{\"card\": {via: \"user_card\"} } | \nget \"card\" related through \"user_card\" | \n[{id: 1, name: \"shinout\", \"card\": [ {id:1, ...}, {id: 3, ...}] }] | \n
|---|