Model.js

ResultIterator.js

Sql.js

Transaction.js

Index

GearsORM. Model.js

Contains GearsORM.Model a metaclass used to define models

License

MIT-style license.

Summary

GearsORM. Model.js	Contains GearsORM.Model a metaclass used to define models
GearsORM. Model	a metaclass to define models that represent database tables.
GearsORM. Model. model	represent a model instance
Functions
remove	remove the instance from the database
save
_updateInsert	do the actual insert/update,used by save method.
refresh	refresh the model data from database.
_populateFromResult	populate the instance from a ResultSet.
count	do a COUNT on the model
select	do a SELECT on the model
remove	do a DELETE on the model
createTable	create the table for this model,creating triggers for forigenkeys and creating many-to-many tables if needed.
dropTable	drop the table and all associate triggers.
createTriggers	create triggers to inforce forigenkeys.
dropTriggers	drop triggers related to the table.
load	load objects from a array to the database.

GearsORM. Model

a metaclass to define models that represent database tables. a metaclass is a class in which the instances are also classes.

Constructor

Parameters

options

a object used to describe the model look like this: { name : “Name of the model table”, fields: { name_of_the_field:a_instance_of_GearsORM.Fields.* } }

GearsORM. Model. model

represent a model instance

Constructor

Parameters

valuesOrRowID

(optional)a object used to initialize the model instance with values or it can be the id of the row,in that case it will do a select to retrive the model data.

Summary

Functions
remove	remove the instance from the database
save
_updateInsert	do the actual insert/update,used by save method.
refresh	refresh the model data from database.
_populateFromResult	populate the instance from a ResultSet.
count	do a COUNT on the model
select	do a SELECT on the model
remove	do a DELETE on the model
createTable	create the table for this model,creating triggers for forigenkeys and creating many-to-many tables if needed.
dropTable	drop the table and all associate triggers.
createTriggers	create triggers to inforce forigenkeys.
dropTriggers	drop triggers related to the table.
load	load objects from a array to the database.

Functions

remove

remove:function()

remove the instance from the database

save

save:function()

save the instance to the database,if the instance is not in the database

it will be created. if it is already in the database it will be updated.

_updateInsert

_updateInsert:function( update )

do the actual insert/update,used by save method.

refresh

refresh:function()

refresh the model data from database.

_populateFromResult

_populateFromResult:function( result )

populate the instance from a ResultSet.

Parameters

result

a ResultSet that used to populate the instance.

count

count:function( whereExpression,
params )

do a COUNT on the model

Parameters

whereExpression	a SQL expression to be used as the WHERE clause.
params	bind parameters used in the SQL expression.

Returns

how much objects(rows) match the where expression

select

select:function( whereExpression,
params )

do a SELECT on the model

Parameters

whereExpression	a SQL expression to be used as the WHERE clause.
params	bind parameters used in the SQL expression.

Returns

a new ResultIterator to iterate the ResultSet

remove

remove:function( whereExpression,
params )

do a DELETE on the model

Parameters

whereExpression	a SQL expression to be used as the WHERE clause.
params	bind parameters used in the SQL expression.

createTable

createTable:function()

create the table for this model,creating triggers for forigenkeys and creating many-to-many tables if needed.

dropTable

dropTable:function()

drop the table and all associate triggers.

createTriggers

createTriggers:function()

create triggers to inforce forigenkeys.

dropTriggers

dropTriggers:function()

drop triggers related to the table.

load

load:function( objects,
save )

load objects from a array to the database.

Parameters

objects	a array of objects or one object to be saved in the database.
save	if set to true all the objects will be saved to the database.

Returns

return all the objects mapped using the model class.

remove:function()

remove the instance from the database

save:function()

_updateInsert:function( update )

do the actual insert/update,used by save method.

refresh:function()

refresh the model data from database.

_populateFromResult:function( result )

populate the instance from a ResultSet.

count:function( whereExpression,
params )

do a COUNT on the model

select:function( whereExpression,
params )

do a SELECT on the model

createTable:function()

create the table for this model,creating triggers for forigenkeys and creating many-to-many tables if needed.

dropTable:function()

drop the table and all associate triggers.

createTriggers:function()

create triggers to inforce forigenkeys.

dropTriggers:function()

drop triggers related to the table.

load:function( objects,
save )

load objects from a array to the database.