| key | 287 |type | 288 |required? | 289 |description | 290 |example |
|---|---|---|---|---|
| storage | 293 |string | 294 |no | 295 |type of external storages. oneof "mock", file" "local" "session" 296 | When running in Node.js or in Titanium, "file" is set by default. 297 | uniqId is the path name to save the data to. 298 | When running in browsers, "local" is set by default. 299 | local means "localStorage", session means "sessionStorage". 300 | When running in Web Worker, "mock" is set and no other options can be selected. 301 | "mock" saves nothing. This is limitation of Web Worker which cannot access to Web Storages. 302 | In this case, exporting the data to the main thread, we can manually handle and store the data. 303 | |
304 | "file" | 305 |
| schema | 308 |object | 309 |required | 310 |DB schema | 311 |(see SCHEMA JSON) |
| reset | 314 |boolean | 315 |no (default false) | 316 |if true, reset db with the given schema. | 317 |true |
| name | 320 |string | 321 |no (default : the same as uniqId) | 322 |the name of the db | 323 |appname_test |
| autosave | 326 |boolean | 327 |no (default false) | 328 |whether to auto-saving or not | 329 |true |
| key | 348 |type | 349 |description | 350 |example |
| (columnName) | 353 |columnDescription | 354 |column to set. 355 | name limitation 356 | Cannot set [id, ins_at, upd_at] as they are already used by default. 357 | Cannot set [$indexes, $uniques, $classes] as they make conflict in schema description. 358 | Cannot set [str, num, bool, on, off] as they make conflict in column description. 359 | Cannot set [join, order, limit, offset, as, where, select, explain] as they make conflict in search options. 360 | Cannot include "," or "." as it is used in indexing or searching. 361 | Cannot set (RelatedTableName)_id as it is automatically set. 362 | |
363 | age: "num" | 364 |
|---|---|---|---|
| $indexes | 367 |Array |
368 | list of indexes. child arrays are lists of columns to make an index. 369 | If string given, converted as array with the value 370 | |
371 | [["name"], ["firstName", "lastName"]] |
| $uniques | 374 |Array |
375 | (the same as $indexes, but this means unique index) | 376 |[["name", "pass"]] |
| $classes | 379 |Array |
380 | (the same as $indexes, but this means classified index) | 381 |"type_num" |
| example | 388 |description | 389 | 390 |
| {type: "str"} | 391 |type is string. 392 | type must be one of ["str", "num", "bool", (columnName)] 393 | |
|---|---|
| {type: "str", required: false} | 396 |type is string, and if not given, null is set. 397 | required option is false by default 398 | |
| {type: "bool", _default: true} | 401 |type is boolean, and if not given, true is set. |
| {type: "num", required: true} | 404 |type is number, and if not given, an exception is thrown. |
| "str" | 407 |type is string, and not required. |
| "num" | 410 |type is number, and not required. |
| "bool" | 413 |type is boolean, and not required. |
| true | 416 |type is string, and required. |
| false | 419 |type is string, and not required. |
| 1 | 422 |type is number, and required. |
| 0 | 425 |type is number, and not required. |
| "on" | 428 |type is boolean, and default value is true. |
| "off" | 431 |type is boolean, and default value is false. |
| {type: tableName} | 434 |type is the instance of a record in tableName. 435 | the column columnName_id is automatically created. 436 | We can set columnName_id instead of columnName in insertion and updating. 437 | This column is required unless you set required: false. 438 | |
| {type: tableName, required: false} | 441 |type is the instance of a record in tableName and not required. 442 | |
| tableName | 445 |type is the instance of a record in tableName and required. 446 | |
| key | 468 |type | 469 |required? | 470 |description | 471 |example |
|---|---|---|---|---|
| force | 474 |boolean | 475 |no (default : false) | 476 |if true, overrides already-existing database of the same uniqId. 477 | otherwise throws an error. | 478 |true |
| name | 481 |string | 482 |no | 483 |the name of the db. If undefined, the imported name is used. | 484 |appname_2 |
| autosave | 487 |boolean | 488 |no | 489 |whether to auto-saving or not. If undefineed, the imported autosave preference is used. | 490 |true |
| storage | 493 |string | 494 |no | 495 |type of external storages. see options of JSRel.use(). 496 | If undefined, the imported storage preference is used. 497 | | 498 |"file" | 499 |
| event name | 551 |emitted when | 552 |arguments to be passed | 553 |
|---|---|---|
| ins | 555 |data are inserted | 556 |
557 |
|
562 |
| ins:{tablename} | 565 |data are inserted into {tablename} | 566 |
567 |
|
571 |
| upd | 574 |data are updated | 575 |
576 |
|
583 |
| upd:{tablename} | 586 |data are updated in {tablename} | 587 |
588 |
|
594 |
| del | 597 |data are deleted | 598 |
599 |
|
604 |
| del:{tablename} | 607 |data are deleted in {tablename} | 608 |
609 |
|
613 |
| save:start | 616 |at the start of jsrel.save() | 617 |
618 |
|
622 |
| save:end | 625 |at the end of jsrel.save() | 626 |
627 |
|
631 |
| option name | 639 |type | 640 |description | 641 |default | 642 |
|---|---|---|---|
| unshift | 644 |boolean | 645 |registers a function to the top of the list | 646 |false | 647 |
| option name | 666 |type | 667 |description | 668 |default | 669 |example |
|---|---|---|---|---|
| noschema | 672 |boolean | 673 |if true, schema SQLs (create statements) are not generated. | 674 |null | 675 |true | 676 |
| db | 679 |boolean or string | 680 |if true, create database whose name is id of the db, if string given, the value is set as database's name. 681 | if not set, database creation (CREATE DATABASE xxxx) does not occur. 682 | | null | 683 |true | 684 |
| nodrop | 687 |boolean | 688 |if true, drop statements are not generated. | 689 |null | 690 |true | 691 |
| nodata | 694 |boolean | 695 |if true, data SQLs (insert statements) are not generated. | 696 |null | 697 |true | 698 |
| type | 701 |string | 702 |type of RDBs. Currently, "mysql" is only tested. | 703 |"mysql" | 704 |"mysql" | 705 |
| engine | 708 |string | 709 |MySQL engine (only enabled when options.type is "mysql") | 710 |"InnoDB" | 711 |"MyISAM" | 712 |
| rails (unstable) | 715 |boolean | 716 |if true, rails-like date format (created_at, inserted_at) is output. | 717 |null | 718 |true | 719 |
| example | 982 |description | 983 | 984 |
| {name: "shinout"} | 985 |name must be equal to "shinout" |
|---|---|
| {name: ["shinout", "nishiko"]} | 988 |name must be equal to "shinout" or "nishiko" |
| {name: {like$: "shin"}} | 991 |name must be like "shin%" |
| {name: {$like: "inout"}} | 994 |name must be like "%inout" |
| {name: [{$like: "inout"}, {equal: "nishiko"}] } | 997 |name must be like "%inout" OR equals "nishiko" |
| {name: {$like: "inout", equal: "nishiko"} } | 1000 |name must be like "%inout" AND equals "nishiko" |
| {age: {gt: 24} } | 1003 |age must be greater than 24 |
| {age: {gt: 24, le: 40} } | 1006 |age must be greater than 24 and less equal 40 |
| {age: [{ge: 24}, {lt: 40}] } | 1009 |age must be greater equal 24 or less than 40 |
| {country: {$in: ["Japan", "Korea"] } | 1012 |country must be one of "Japan", "Korea" (as "in" is a reserved word in JavaScript, used "$in" instead.) |
| {name: "shinout", age : {ge: 70 } | 1015 |must returns empty until shinout becomes 70 |
| key | 1024 |type | 1025 |description | 1026 |example |
|---|---|---|---|
| order | 1029 |mixed | 1030 |see order description | 1031 |{ name: "asc" } | 1032 |
| limit | 1035 |int | 1036 |the end position of the data | 1037 |20 |
| offset | 1040 |int | 1041 |offset of the results | 1042 |10 |
| join | 1045 |mixed | 1046 |see join description | 1047 |{records.scene: {title : {like$: "ABC"} } |
| select | 1050 |string (one of column names) | 1051 |get list of selected columns instead of objects | 1052 |"title" |
| select | 1055 |array (list of column names) | 1056 |get list of object which contains the given columns instead of all columns | 1057 |["name", "age"] |
| explain | 1060 |object | 1061 |put searching information to the given object | 1062 |{} |
| example | 1069 |description | 1070 | 1071 |
| "age" | 1072 |order by age asc |
|---|---|
| {age: "desc"} | 1075 |order by age desc |
| {age: "desc", name: "asc"} | 1078 |order by age desc, name asc |
group
1093 || id | name |
| 1 | mindia |
| 2 | ZZZ |
user
1100 || id | name | age | group |
| 1 | shinout | 25 | 1 |
| 2 | nishiko | 28 | 1 |
| 3 | xxx | 39 | 2 |
card
1108 || id | title | body |
| 1 | rabbit | it jumps! |
| 2 | pot | a tiny yellow magic pot |
| 3 | PC | calculating... |
user_card
1116 || id | user | card |
| 1 | 1 | 1 |
| 2 | 2 | 1 |
| 3 | 1 | 2 |
| 4 | 2 | 3 |
| 5 | 3 | 3 |
| No. | 1134 |JOIN_VALUE | 1135 |description | 1136 |result |
| 1 | 1140 |"group" | 1141 |get "group" column as object | 1142 |[{id: 1, name: "shinout", age: 25, group_id: 1, group: {id: 1, name: "mindia"}}] | 1143 |
|---|---|---|---|
| 2 | 1147 |{group : true} | 1148 |get "group" column as object (the same as sample1) | 1149 |[{id: 1, name: "shinout", age: 25, group_id: 1, group: {id: 1, name: "mindia"}}] | 1150 |
| 3 | 1154 |true | 1155 |get all the related columns as object | 1156 |[{id: 1, name: "shinout", age: 25, group_id: 1, group: {id: 1, name: "mindia"}}] | 1157 |
| 4 | 1161 |{group : {name: {like$: "mind"}}} | 1162 |get "group" column as object whose name starts at "mind" | 1163 |[{id: 1, name: "shinout", age: 25, group_id: 1, group: {id: 1, name: "mindia"}}] | 1164 |
| 5 | 1168 |{group : {name: "ZZZ"}} | 1169 |get "group" column as object whose name is equal to "ZZZ" | 1170 |[] // empty | 1171 |
| No. | 1182 |JOIN_VALUE | 1183 |description | 1184 |result |
| 6 | 1188 |"user.group" | 1189 |get "user" table objects (setting the related column in "user" table) | 1190 |[{id: 1, name: "mindia", "user.group": [{id: 1, name: "shinout", age: 25}, {id: 2, name: "nishiko", age: 28}]}] | 1191 |
|---|---|---|---|
| 7 | 1195 |"user" | 1196 |get "user" table objects (if related column is obvious) | 1197 |[{id: 1, name: "mindia", "user": [{id: 1, name: "shinout", age: 25}, {id: 2, name: "nishiko", age: 28}]}] | 1198 |
| 8 | 1202 |{"user.group" : true } | 1203 |get "user" table objects (the same as sample6) | 1204 |[{id: 1, name: "mindia", "user.group": [{id: 1, name: "shinout", age: 25}, {id: 2, name: "nishiko", age: 28}]}] | 1205 |
| 9 | 1209 |{"user.group" : {age : {gt: 27}} } | 1210 |get "user" table objects with age greater than 27 | 1211 |[{id: 1, name: "mindia", "user.group": [{id: 2, name: "nishiko", age: 28}]}] | 1212 |
| 10 | 1216 |{"user.group" : {age : {gt: 27}, as: "users"} } | 1217 |get "user" table objects with age greater than 27, with alias name "users" | 1218 |[{id: 1, name: "mindia", "users": [{id: 2, name: "nishiko", age: 28}]}] | 1219 |
| 11 | 1223 |{"user.group" : {where : {age : {gt: 27}}, as: "users"} } | 1224 |get "user" table objects with age greater than 27, with alias name "users" (the canonical expression of sample9) | 1225 |[{id: 1, name: "mindia", "users": [{id: 2, name: "nishiko", age: 28}]}] | 1226 |
| 12 | 1230 |{user : {age : {gt: 27}, as: "users"} } | 1231 |get "user" table objects with age greater than 27, with alias name "users" | 1232 |[{id: 1, name: "mindia", "users": [{id: 2, name: "nishiko", age: 28}]}] | 1233 |
| 13 | 1237 |{user : {age : {gt: 47}, outer: true} } | 1238 |outer joining. Records containing Empty 1:N subqueries can be remained with the column filled with null. | 1239 |[{id: 1, name: "mindia", "user": null}] | 1240 |
| 13 | 1244 |{user : {age : {gt: 47}, outer: "array"} } | 1245 |outer joining. Records containing Empty 1:N subqueries can be remained with the column filled with empty array. | 1246 |[{id: 1, name: "mindia", "user": [] }] | 1247 |
| 15 | 1259 |{"card": {via: "user_card"} } | 1260 |get "card" related through "user_card" | 1261 |[{id: 1, name: "shinout", "card": [ {id:1, ...}, {id: 3, ...}] }] | 1262 |
|---|