Skip to content
This repository has been archived by the owner on Apr 5, 2019. It is now read-only.

Commit

Permalink
Updated README styling for readability
Browse files Browse the repository at this point in the history
  • Loading branch information
@caseywebdev
caseywebdev committed Jun 14, 2012
1 parent 571e3db commit f471dd6
Showing 1 changed file with 117 additions and 113 deletions.
230 changes: 117 additions & 113 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,122 +9,126 @@ See this article for some more details about hstore, and also the PostgreSQL doc

The library uses all of the standard Backbone methods for syncing objects and works with both models and collections. Here's an example, it assumes you've created a database and set it up with the hstore extension and then set up a database with the following schema:

CREATE TABLE badgers (
id SERIAL,
name VARCHAR(128),
attributes hstore
);
```sql
CREATE TABLE badgers (
id SERIAL,
name VARCHAR(128),
attributes hstore
);
```

This won't really run as one script because otherwise it would all have to be nested to make sure things had executed before moving on to the next example, but this way is a lot easier to read.

// Require the library as Backbone so that it can extend its prototype
Backbone = require('backbone-postgresql');

// Tell the Postgres connector how to connect to the database
Backbone.pg_connector.config = {db: ''pg://username:password@localhost/backbone-pg-demo'};

// Define our models and collections. We're using the urlRoot parameter to define the table name
var Badger = Backbone.Model.extend({
urlRoot: '/badgers'
});

var BadgerCollection = Backbone.Collection.extend({
urlRoot: '/badgers',
model: Badger
});

// Let's create a new badger
var badger = new Badger({name: 'Bodger', age: 2});
// and save it - with this schema the age attribute will be stored in hstore, whilst the name attribute will go in a proper column
badger.save();
// Here we use the event emitter approach
badger.on('sync', function(model){
console.log('Badger saved: ' + model.name);
});
badger.on('error', function(model, err){
console.log('Error saving badger');
});

//then we could change some attributes - obviously we should really put this in the success callback, but for keeping the examples simple I haven't
model.set('age', 3);
// then let's save it again but this time we can use callbacks as an argument
// the first argument is null because you can pass in new attributes to save. Always catches me out.
model.save(null, {
success: function(model){
console.log('Badger updated: ' + model.name);
},
error: function(model, err){
console.log('Error updating badger');
}
});

// Let's say that the id of a badger is 345 - here is how we retrieve it from the database:
var another_badger = new Badger({id: 345});
another_badger.fetch({
success: function(model){
console.log("Successfully retrieved badger: " + model.attributes.name + " (Age: " + model.attributes.age + ")");
},
error: function(model, err){
console.log(err instanceof Error);
console.log(err.message); // "Not found"
console.log('Error retrieving badger');
}
});

// If it can't be found, the error callback will be fired and the "err" parameter will return a "Not found" error

// If you want to put some constraints on what you're fetching (e.g. if you want to fetch a resource, but wanted to make sure it was owned by the correct person)
// you can add a filter parameter like so:

another_badger.fetch({
filter: {owner_id: 123},
success: ...
error: ...
});

// The filter parameter can be an object, in which case each of the key:value pairs are turned into where constraints ANDed together, e.g.
// {owner_id: 123, name: 'bob'}
// will get turned into a snippet of SQL like:
// WHERE owner_id = 123 AND name = 'bob'

// If you want to apply more complex conditions, you can create a series of conditions which will be ANDed together as well, e.g.
// ['owner_id = 123', "name = 'bob'"]
// is equivalent to the same thing:
// WHERE owner_id = 123 AND name = 'bob'

// And if we wanted to delete it we could just do:
another_badger.destroy({
success: function(model){
console.log("You just destroyed an endangered animal");
},
error: function(model, err){
console.log("No badger was harmed");
}
});

// Collections

// Let's make a collection of badgers
var badgers = new BadgerCollection();

badgers.fetch({
success: function(collection){
console.log("Successfully fetched badgers");
},
error: function(collection, err){
console.log("Error fetching badgers");
}
});

// You can also apply a filter to this fetch as in the fetch example for Models, e.g.

badgers.fetch({
filter: {name: 'bob'},
success: ...
error: ...
});

// will return all badgers named bob
```javascript
// Require the library as Backbone so that it can extend its prototype
Backbone = require('backbone-postgresql');

// Tell the Postgres connector how to connect to the database
Backbone.pg_connector.config = {db: 'pg://username:password@localhost/backbone-pg-demo'};

// Define our models and collections. We're using the urlRoot parameter to define the table name
var Badger = Backbone.Model.extend({
urlRoot: '/badgers'
});

var BadgerCollection = Backbone.Collection.extend({
urlRoot: '/badgers',
model: Badger
});

// Let's create a new badger
var badger = new Badger({name: 'Bodger', age: 2});
// and save it - with this schema the age attribute will be stored in hstore, whilst the name attribute will go in a proper column
badger.save();
// Here we use the event emitter approach
badger.on('sync', function(model){
console.log('Badger saved: ' + model.name);
});
badger.on('error', function(model, err){
console.log('Error saving badger');
});

//then we could change some attributes - obviously we should really put this in the success callback, but for keeping the examples simple I haven't
model.set('age', 3);
// then let's save it again but this time we can use callbacks as an argument
// the first argument is null because you can pass in new attributes to save. Always catches me out.
model.save(null, {
success: function(model){
console.log('Badger updated: ' + model.name);
},
error: function(model, err){
console.log('Error updating badger');
}
});

// Let's say that the id of a badger is 345 - here is how we retrieve it from the database:
var another_badger = new Badger({id: 345});
another_badger.fetch({
success: function(model){
console.log("Successfully retrieved badger: " + model.attributes.name + " (Age: " + model.attributes.age + ")");
},
error: function(model, err){
console.log(err instanceof Error);
console.log(err.message); // "Not found"
console.log('Error retrieving badger');
}
});

// If it can't be found, the error callback will be fired and the "err" parameter will return a "Not found" error

// If you want to put some constraints on what you're fetching (e.g. if you want to fetch a resource, but wanted to make sure it was owned by the correct person)
// you can add a filter parameter like so:

another_badger.fetch({
filter: {owner_id: 123},
success: ...
error: ...
});

// The filter parameter can be an object, in which case each of the key:value pairs are turned into where constraints ANDed together, e.g.
// {owner_id: 123, name: 'bob'}
// will get turned into a snippet of SQL like:
// WHERE owner_id = 123 AND name = 'bob'

// If you want to apply more complex conditions, you can create a series of conditions which will be ANDed together as well, e.g.
// ['owner_id = 123', "name = 'bob'"]
// is equivalent to the same thing:
// WHERE owner_id = 123 AND name = 'bob'

// And if we wanted to delete it we could just do:
another_badger.destroy({
success: function(model){
console.log("You just destroyed an endangered animal");
},
error: function(model, err){
console.log("No badger was harmed");
}
});

// Collections

// Let's make a collection of badgers
var badgers = new BadgerCollection();

badgers.fetch({
success: function(collection){
console.log("Successfully fetched badgers");
},
error: function(collection, err){
console.log("Error fetching badgers");
}
});

// You can also apply a filter to this fetch as in the fetch example for Models, e.g.

badgers.fetch({
filter: {name: 'bob'},
success: ...
error: ...
});

// will return all badgers named bob
```

# Contributions

Expand Down

0 comments on commit f471dd6

Please sign in to comment.