60 |

61 |

# Store

62 |

You can test store into localstorage with this example, you can define the table / source and define the object structure for every data you want to save.

63 |

64 |

65 |

66 |

Table / Source

67 | 68 |

69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 82 | 85 | 88 | 89 | 90 | 93 | 96 | 99 | 100 | 101 | 104 | 107 | 110 | 111 | 112 | 115 | 118 | 121 | 122 | 123 | 124 | 125 | 126 | 129 | 130 | 131 | 132 | 135 | 136 | 137 |

Key	Value
80 \| 81 \|	83 \| 84 \|	86 \| 87 \|
91 \| 92 \|	94 \| 95 \|	97 \| 98 \|
102 \| 103 \|	105 \| 106 \|	108 \| 109 \|
113 \| 114 \|	116 \| 117 \|	119 \| 120 \|
When you added new colum, you can update the structure object of data using "`fixStructure`"		127 \| 128 \|
	133 \| 134 \|

138 |

139 |

140 |

141 |

Object Result

142 |

143 | 144 |

LDB Logs

145 |

146 | 147 |

148 | 149 |

197 |

198 |

# Manage

199 |

you can Edit, Delete & Query of data you have, and has support to filter by date data type

200 |

201 |

202 |

203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 |

211 |

212 |

213 | 214 |

217 | 218 |

219 |

# Documentation

220 |

221 | first of all, make sure the script has been called in your html 222 |

223 |

 224 |         <script src="ldbx.js"></script>
 225 |

226 |

227 | 228 | 229 |

230 |

231 |

Usages

232 |

233 |

234 | 235 |

Initialize Table

236 |

There are 3 params in constructor :

237 |

238 |
using params default
239 |
240 |
Table Name [String] (Required)
241 |
Query Log in console [Boolean] (Optional)
242 |
Soft Delete [Boolean] (Optional)
243 |
244 |
using config params 245 | you can using object configuration params with structure like this :
246 |
{
 247 |   table: String,
 248 |   showLog: Boolean,
 249 |   softDelete: Boolean,
 250 | }
 251 | 

252 |

Example instance

253 |


 254 | // Using default params
 255 | const DataModel = new LDBX('users', true, false) 
 256 | 
 257 | 
 258 | // Using Config params
 259 | const config = {
 260 |   table: 'users',
 261 |   log: true,
 262 |   softDelete: false,
 263 | }
 264 | const DataModel = new LDBX(config)
 265 |

266 |

Get All Data

267 |

const UserModel = new LDBX('users')
 268 | var list = UserModel.get()
 269 |

270 |

Get first / single data

271 |

const UserModel = new LDBX('users')
 272 | var data = UserModel.where('id', id).first() // *first its mean, first of result query
 273 |

274 |

Single selection where

275 |

const UserModel = new LDBX('users')
 276 | var data = UserModel.where('name', 'ikhbalfuady').get()
 277 |

278 |

Multiple selection where

279 |

// using custom operator
 280 | const UserModel = new LDBX('users')
 281 | var data = UserModel.where('age', '>=' 18)
 282 |             .where('age', '<=', 25)
 283 |             .get()
 284 |

285 |

Find by id

286 |

const UserModel = new LDBX('users')
 287 | var data = UserModel.find(id)
 288 |

289 |

Store Data

290 |

const UserModel = new LDBX('users')
 291 | let data = {
 292 |   name: "John",
 293 |   age: 21
 294 | }
 295 | 
 296 | UserModel.save(data)
 297 |

298 |

Update Data

299 |

const UserModel = new LDBX('users')
 300 | let data = UserModel.find(id)
 301 | if (!data) throw error(`user with id"${id}" not found `)
 302 | 
 303 | // set value into object
 304 | data.name = "Ikhbalfuady"
 305 | UserModel.update(data)
 306 |

307 |

Delete Data

308 |

const UserModel = new LDBX('users')
 309 | UserModel.delete(id) // default soft delete
 310 | 
 311 | // permanent delete
 312 | const UserModel = new LDBX('users')
 313 | UserModel.delete(id, true)
 314 |

Avail "Where" Operator

315 | 316 | 317 | 318 | 319 | 320 | 321 | 322 | 323 | 324 | 325 | 326 | 327 | 328 | 329 | 330 | 331 | 332 | 333 | 334 | 335 | 336 | 337 | 338 | 339 | 340 | 341 | 342 | 343 | 344 | 345 | 346 | 347 | 348 | 349 | 350 | 351 | 352 | 353 | 354 | 355 | 356 | 357 | 358 | 359 | 360 | 361 | 362 | 363 | 364 | 365 | 366 | 367 | 368 | 369 | 370 | 371 | 372 | 373 | 374 | 375 | 376 | 377 | 378 | 379 | 380 | 381 | 382 | 383 | 384 | 385 | 386 |

Name	value	Syntax	Status
Equal	=	.where('key', '=', value) OR .where('key', value)	READY
Like / Contains	like	.where('key', 'like', value)	READY
Less Than	<	.where('key', '<', value)	READY
Less Than Equal	<=	.where('key', '<=', value)	READY
Greater Than	>	.where('key', '>', value)	READY
Greater Than Equal	>=	.where('key', '>=', value)	READY
Is NULL	N/n	.where('key', 'N', value) OR .where('key', 'n', value)	READY
Is NOT NULL	NN / nn	.where('key', 'NN', value) OR .where('key', 'nn', value)	READY
IN	IN	.where('key', 'IN', arrayValue) // arrayValue = [1,2,3]	READY
NOT IN	NIN	.where('key', 'NIN', arrayValue) // arrayValue = [1,2,3]	READY

387 |

388 |

Other Features

389 |

trashed()

390 |

this is method chaining to getting only trashed data

391 |

var UserModel = new LDBX('users')
 392 | .trashed()
 393 | .get()
 394 |

withTrashed()

395 |

this is method chaining to getting all with trashed data if you using softDelete

396 |

var UserModel = new LDBX('users')
 397 | .withTrashed()
 398 | .get()
 399 |

truncate()

400 |

this is method chaining to clean up data

401 |

var UserModel = new LDBX('users')
 402 | .truncate()
 403 |

hasData()

404 |

this is method chaining to checking table has already have data or not

405 |

var UserModel = new LDBX('users')
 406 | .hasData()
 407 |

getFillableColumn()

408 |

this is method chaining to getting fillable columns of object you set

409 |

// getting fillable of existing data
 410 | var UserModel = new LDBX('users')
 411 | var user = UserModel.find(1)
 412 | var fillableColumns = UserModel.getFillableColumn(user)
 413 |

fixStructure()

414 |

this is method chaining to fixing structure like ALTER TABLE in SQL\ 415 | when you chaning structure of object model you have, you just call this method for fix that 416 | example :

417 |

// current model
 418 | let UsersSpec = {
 419 |   dbConfig: {
 420 |     table: 'users',
 421 |     showLog: true,
 422 |     softDelete: true,
 423 |   },
 424 |   dataModel: {
 425 |     id: null,
 426 |     name: null,
 427 |     email: null
 428 |   }
 429 | }
 430 | const UserModel = new LDBX(UsersSpec.dbConfig)
 431 | const fillableColumns = UserModel.getFillableColumn(UsersSpec.dataModel)
 432 | /* return 
 433 | ['id', 'name', 'email']
 434 | */
 435 | 
 436 | // and you want to change the users to model to like this
 437 | let UsersSpec = {
 438 |   dbConfig: {
 439 |     table: 'users',
 440 |     showLog: true,
 441 |     softDelete: true,
 442 |   },
 443 |   dataModel: {
 444 |     id: null,
 445 |     name: null,
 446 |     email: null,
 447 |     phone: null, // new
 448 |     born_date: null, // new
 449 |   }
 450 | }
 451 | 
 452 | // just do like this
 453 | const UserModel = new LDBX(UsersSpec.dbConfig)
 454 | const newFillableColumns = UserModel.getFillableColumn(UsersSpec.dataModel)
 455 | UserModel.fixStructure(newFillableColumns) // all of data will be updated with new fillable structure
 456 |

orderBy(key, type?, dateFormat?)

457 |

this is method chaining to implementing "order data" of result query \

458 |

key : String // object key
type : Enum(asc,desc) (default : asc)
dateFormat : Boolean (default : false) // for sorting date type data

463 |

const UserModel = new LDBX('jorunal')
 464 | .orderBy('key') // order ASC
 465 | .get()
 466 | 
 467 | const UserModel = new LDBX('jorunal')
 468 | .orderBy('key', 'desc') // order DESC
 469 | .get()
 470 | 
 471 | // ordering date data
 472 | const UserModel = new LDBX('transaction')
 473 | .orderBy('date', 'desc', true) // fot better result activate date format with set 3 in third parameter
 474 | .get()
 475 |

Atenttion : order can only be executed once per query, even if you add multiple 'orderBy', the last 'orderBy' is recognized

478 |

479 |

belongsTo(tableName, foreignKey, newObjectName?, targetKey?)

480 |

this is method chaining to implementing relation of some data \ 481 | this method will be created new single object for every object result data \

482 |

tableName : name of table
foreignKey : foreign key object, ex : role_id
newObjectName : object name for the relation , ex : role
targetKey : target key object of source data, default is "id"

488 |

const UserModel = new LDBX('users')
 489 | .belongsTo('roles', 'role_id', 'role') // simply version
 490 | .first()
 491 | 
 492 | /* return 
 493 | {
 494 |   id: 1
 495 |   name: 'John',
 496 |   role_id: 1,
 497 |   roles: {
 498 |     id: 1,
 499 |     name: 'Admin',
 500 |   },
 501 | }
 502 | */
 503 | 
 504 | const UserModel = new LDBX('jorunal')
 505 | .belongsTo('coa', 'coa_revenue_code', 'coa_revenue', 'code') // full version
 506 | .get()
 507 | 
 508 | /* return 
 509 | [
 510 |   {
 511 |     id: 1
 512 |     name: 'TRX Forex',
 513 |     coa_revenue_code: '101020230'
 514 |     coa_revenue: {
 515 |       code: '101020230',
 516 |       name: 'Fix Revenue',
 517 |     }
 518 |   },
 519 |   {
 520 |     id: 2
 521 |     name: 'TRX others',
 522 |     coa_revenue_code: '4305353353'
 523 |     coa_revenue: {
 524 |       code: '4305353353',
 525 |       name: 'Other Revenue',
 526 |     }
 527 |   }
 528 | ]
 529 | */
 530 |

531 |

hasMany(tableName, foreignKey, newObjectName?, targetKey?)

532 |

this is method chaining to implementing relation of some data\ 533 | this method will be created new single object with array result for every object in result data\

534 |

tableName : name of table
foreignKey : foreign key object, ex : role_id
newObjectName : object name for the relation , ex : role
targetKey : target key object of source data, default is "id"

540 |

const UserModel = new LDBX('users')
 541 | .hasMany('roles', 'role_id', 'roles') // simply version
 542 | .first()
 543 | /* return 
 544 | {
 545 |   id: 1
 546 |   name: 'John',
 547 |   roles: [
 548 |     {
 549 |       id: 1,
 550 |       name: 'Admin',
 551 |     },
 552 |     {
 553 |       id: 2,
 554 |       name: 'Staff',
 555 |     }
 556 |   ],
 557 | }
 558 | */
 559 | 
 560 | const UserModel = new LDBX('jorunal')
 561 | .hasMany('coa', 'coa_revenue_code', 'coa_revenues', 'code') // full version
 562 | .get()
 563 | 
 564 | /* return 
 565 | [
 566 |   {
 567 |     id: 1
 568 |     name: 'transaction',
 569 |     coa_revenues: [
 570 |       {
 571 |         code: '101020230',
 572 |         name: 'Fix Reveneu',
 573 |       },
 574 |       {
 575 |           code: '105020230',
 576 |         name: 'Other Revenue
 577 |     ],
 578 |   }
 579 | ]
 580 | */
 581 |

582 | 583 |

584 | 585 |

586 |

Key	Value
80 \| 81 \|	83 \| 84 \|	86 \| 87 \|
91 \| 92 \|	94 \| 95 \|	97 \| 98 \|
102 \| 103 \|	105 \| 106 \|	108 \| 109 \|
113 \| 114 \|	116 \| 117 \|	119 \| 120 \|
When you added new colum, you can update the structure object of data using "`fixStructure`"		127 \| 128 \|
	133 \| 134 \|