Skip to content

[ASHIKH PAI],[28/10/2015] #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vnq837 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[ASHIKH PAI],[28/10/2015] #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 18 additions & 41 deletions docs/en/edge/guide/rhom_js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,19 @@ The first step in order to use Rhom is to create a model class with the required
// Models MUST be defined when your HTML pages load

// You can either set a global reference
var userModel = Rho.ORM.addModel(function(model) {
model.modelName('User');
model.property('name','string');
model.property('email','string');
var userModel = Rho.ORM.addModel('User', function(model) {
model.setModelProperty('name','string','');
model.setModelProperty('email','string','');
// optionally enable sync for rhoconnect applications
// model.enable('sync');
// optionally, define the model as fixed schema default is propertyBag
// model.enable('fixedSchema');
// model.fixed_schema = true;
});

// Or just define the model without a global reference
Rho.ORM.addModel(function(model) {
model.modelName('Product');
model.property('name','string');
model.property('qty','string');
Rho.ORM.addModel('Product', function(model) {
model.setModelProperty('name','string','');
model.setModelProperty('qty','string','');
});


Expand Down Expand Up @@ -97,28 +95,7 @@ You can retrieve objects sorted by one or more attributes using the `order` and
}
);

You can also sort with an user defined function.

:::javascript
// order by one attribute
var users = userModel.find(
'all',
{
orderFunction: function(a, b) { return a <= b }
}
);

// order by multiple attributes
var users = userModel.find(
'all',
{
orderFunction: function(a, b) {
return a.name <= b.name && a.email <= b.email
}
}
);

**NOTE: Whenever possible, use `order` instead of `orderFunction`. The database will sort objects faster than JavaScript code.**

### Retrieving specific attributes

Expand Down Expand Up @@ -161,14 +138,14 @@ JavaScript syntax:

## Updating

You can update an object’s attributes and save it to the database using the `updateAttributes` method
You can update an object’s attributes and save it to the database using the `update_attributes` method

NOTE: This is the fastest way to add or update item attributes.

JavaScript syntax:
:::javascript
var user = userModel.find('first', {conditions: {name: 'Alice'});
user.updateAttributes({
user.update_attributes({
name: 'Bob',
email: 'bob@example.com'});

Expand All @@ -185,15 +162,15 @@ JavaScript syntax:

### Delete multiple objects

To delete all objects for a model, or only those matching given conditions, use the `deleteAll` method.
To delete all objects for a model, or only those matching given conditions, use the `delete_all` method.

JavaScript syntax:
:::javascript
// delete all objects
userModel.deleteAll();
userModel.delete_all();

// delete only objects matching :conditions
userModel.deleteAll({conditions: {name: 'Alice'}})
userModel.delete_all({conditions: {name: 'Alice'}})

## Transactions

Expand Down Expand Up @@ -231,11 +208,10 @@ You can execute SQL statements directly on the database by using `Database.execu
JavaScript syntax:
:::javascript
try {


var db = new Rho.Database(Rho.Application.databaseFilePath('app'),'app');
var result = db.executeSql('SELECT * FROM User'); // result is an array of hashes, where each hash is a record
} finally {
var db = new Rho.Database(Rho.Application.databaseFilePath('app'),'app');
var result = db.executeSql('SELECT * FROM User'); // result is an array of hashes, where each hash is a record
}
finally {
db.close();
}

Expand All @@ -253,7 +229,8 @@ You can use the following method for recovering the database from a bad or corru

JavaScript syntax:
:::javascript
Rho.ORM.databaseFullResetEx({'models': ['User'], 'reset_client_info': true, 'reset_local_models': true});
var ary = ['Product','Customer'];
Rho.ORM.databaseFullResetEx(ary, false, true);


## Related reading
Expand Down
180 changes: 27 additions & 153 deletions docs/en/edge/guide/rhom_ruby.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,16 +363,6 @@ You can retrieve all objects matching given conditions using the `conditions` pa
:conditions => {:name => 'Alice'}
)

### Numeric field comparisons in property bag models
Because, internally, property bag models store all their values in the same column, this column is defined as `varchar`, which means that number comparisons do not work as you would expected. If you need to perform order comparisons on a numeric field in a property bag model, use CAST to convert the value to a number of the desired type:

:::ruby
@accts = Account.find(:all,
:conditions => { {:func=> 'CAST', :name=>'rating as INTEGER', :op=>'<'} => 3 } )
#or using sql query:
size = 3
@accts = Account.find(:all,
:conditions => ["CAST(rating as INTEGER)< ?", "#{size}"], :select => ['rating'] )

### Ordering the objects
You can retrieve objects sorted by one or more attributes using the `order` and `orderdir` parameters.
Expand Down Expand Up @@ -402,20 +392,10 @@ If, for a particular action, you do not need every attribute in an object, you c
)

### Paginating results
NOTE: this section applies to Ruby only

You can pass `offset` and `per_page` parameters to `find` method to retrieve objects in chunks.

:::ruby
# get first 10 records
users = User.find(:all, :per_page => 10)

# get records 21-40
users = User.find(:all, :offset => 20, :per_page => 20)

For convenience, there is a `paginate` method which emulates Rails' classic pagination syntax. The default page size is 10.
For retrieving objects in chunks, there is a `paginate` method which emulates Rails' classic pagination syntax. The default page size is 10.

You can use `:conditions`, `:order` and `select` parameters, similarly to the `find` method.
You can use `:conditions`, `:order` and `:select` parameters, similarly to the `find` method.

:::ruby
# get first 10 records
Expand All @@ -434,10 +414,10 @@ You can get only the first object matching given conditions using `first` instea
)

### Using SQL queries directly
You can directly retrieve model object(s) using SQL queries with the `findBySql` method. This method works only for fixed schema models.
You can directly retrieve model object(s) using SQL queries with the `find_by_sql` method. This method works only for fixed schema models.

:::ruby
users = User.findBySql('SELECT * FROM User')
users = User.find_by_sql('SELECT * FROM User')

## Counting objects
You can get the number of objects matching given conditions using the `count` parameter with `find` method.
Expand All @@ -449,7 +429,7 @@ You can get the number of objects matching given conditions using the `count` pa
)

## Updating
You can update an object’s attributes and save it to the database using the `updateAttributes` method
You can update an object’s attributes and save it to the database using the `update_attributes` method

NOTE: This is the fastest way to add or update item attributes.

Expand Down Expand Up @@ -515,7 +495,8 @@ You can use the following method for recovering the database from a bad or corru
### Delete all objects for given models.

:::ruby
Rho::ORM.databaseFullResetEx(:models => ['User'], :reset_client_info => true, :reset_local_models => true)
ary = ['Product','Customer']
Rho::ORM.databaseFullResetEx(ary, false, true)

## Adding more fields to an existing model

Expand Down Expand Up @@ -621,161 +602,54 @@ For such models if you try to set a property that has not been explicitly define
## Resetting the Database
Rhodes provides the following functions for recovering the database from a bad or corrupt state, or if the RhoConnect server returns errors.

### `Rhom::Rhom.database_full_reset(reset_client_info=false, reset_local_models=true)`
### `Rho::ORM.databaseFullReset(resetClientInfo=false, resetLocalModels=true)`
Deletes all records from the property bag and model tables.

:::ruby
# reset_client_info If set to true, client_info
# resetClientInfo If set to true, client_info
# table will be cleaned.
#
# reset_local_models If set to true, local(non-synced models)
# resetLocalModels If set to true, local(non-synced models)
# will be cleaned.
Rhom::Rhom.database_full_reset(false,true)
Rho::ORM.databaseFullReset(false,true)

### `Rhom::Rhom.database_full_reset_and_logout`
### `Rho::ORM.databaseFullResetAndLogout`
Perform a full reset and then logout the RhoConnect client.

:::ruby
Rhom::Rhom.database_full_reset_and_logout
Rho::ORM.databaseFullResetAndLogout

### `Rhom::Rhom.database_fullclient_reset_and_logout`
Equivalent to `Rhom::Rhom.database_full_reset(true)` followed by `SyncEngine.logout`.
### `Rho::ORM.databaseFullclientResetAndLogout`
Equivalent to `Rho::ORM.databaseFullReset(true)` followed by `SyncEngine.logout`.

:::ruby
Rhom::Rhom.database_fullclient_reset_and_logout
Rho::ORM.databaseFullclientResetAndLogout

**NOTE: If you receive a sync error "Unknown client" message in your sync callback, this means that the RhoConnect server no longer knows about the client and a `Rhom::Rhom.database_fullclient_reset_and_logout` is recommended. This error requires proper intervention in your app so you can handle the state before resetting the client. For example, your sync notification could contain the following:**
**NOTE: If you receive a sync error "Unknown client" message in your sync callback, this means that the RhoConnect server no longer knows about the client and a `Rho::ORM.databaseFullclientResetAndLogout` is recommended. This error requires proper intervention in your app so you can handle the state before resetting the client. For example, your sync notification could contain the following:**

:::ruby
if @params['error_message'].downcase == 'unknown client'
puts "Received unknown client, resetting!"
Rhom::Rhom.database_fullclient_reset_and_logout
Rho::ORM.databaseFullclientResetAndLogout
end

### `Rhom::Rhom.database_local_reset`
### `Rho::ORM.databaseLocalReset`
Reset only local(non-sync-enabled) models.

:::ruby
Rhom::Rhom.database_local_reset
Rho::ORM.databaseLocalReset

### `Rhom::Rhom.database_full_reset_ex( :models => [model_name1, model_name2], :reset_client_info=>false, :reset_local_models => true)`
### `Rho::ORM.databaseFullResetEx([model_name1, model_name2], false, true)`
Deletes all records from the property bag and model tables, if models are set then reset only selected models

:::ruby
# models Array of models names to reset
# reset_client_info If set to true, client_info
# table will be cleaned.
# models Array of models names to reset
# resetClientInfo If set to true, client_info
# table will be cleaned.
#
# reset_local_models If set to true, local(non-synced models)
# will be cleaned.
Rhom::Rhom.database_full_reset_ex(:models => ['Product', 'Customer'])

## Advanced Queries
### `find(*args)` (advanced conditions)
Rhom also supports advanced find `:conditions`. Using advanced `:conditions`, rhom can optimize the query for the property bag table.

Let's say we have the following SQL fragment condition:

:::ruby
Product.find(
:all,
:conditions => [
"LOWER(description) like ? or LOWER(title) like ?",
query,
query
],
:select => ['title','description']
)

Using advanced `:conditions`, this becomes:

:::ruby
Product.find(
:all,
:conditions => {
{
:func => 'LOWER',
:name => 'description',
:op => 'LIKE'
} => query,
{
:func => 'LOWER',
:name => 'title',
:op => 'LIKE'
} => query
},
:op => 'OR',
:select => ['title','description']
)

You can also use the 'IN' operator:

:::ruby
Product.find(
:all,
:conditions => {
{
:name => "image_uri",
:op => "IN"
} => "'15704','15386'"
}
)

# or use array notation
Product.find(
:all,
:conditions => {
{
:name => "image_uri",
:op => "IN"
} => ["15704","15386"]
}
)

You can also group `:conditions`:

:::ruby
cond1 = {
:conditions => {
{
:func => 'UPPER',
:name => 'name',
:op => 'LIKE'
} => query,
{
:func => 'UPPER',
:name => 'industry',
:op => 'LIKE'
} => query
},
:op => 'OR'
}

cond2 = {
:conditions => {
{
:name => 'description',
:op => 'LIKE'
} => 'Hello%'
}
}

@accts = Account.find(
:all,
:conditions => [cond1, cond2],
:op => 'AND',
:select => ['name','industry','description']
)

## Find by numeric field
To use number comparison conditions in find use CAST :
:::ruby
@accts = Account.find(:all,
:conditions => { {:func=> 'CAST', :name=>'rating as INTEGER', :op=>'<'} => 3 } )
#or using sql query:
size = 3
@accts = Account.find(:all,
:conditions => ["CAST(rating as INTEGER)< ?", "#{size}"], :select => ['rating'] )
# resetLocalModels If set to true, local(non-synced models)
# will be cleaned.
Rho::ORM.databaseFullResetEx(['Product', 'Customer'], false, true)

## Database Encryption

Expand Down