Wrapper for NanoStore, a lightweight schema-less key-value document database based on sqlite, in RubyMotion.
Status: Work in progress. API subject to change.
Find a sample application using NanoStore here
How to use Blog here
Install the CocoaPods dependency manager if you haven't it already:
gem install motion-cocoapods
pod setup
Install nano-store gem
gem install nano-store
Require nano-store to your project 'Rakefile'
$:.unshift("/Library/RubyMotion/lib")
require 'motion/project'
require 'rubygems'
require 'motion-cocoapods'
require 'nano-store'
Motion::Project::App.setup do |app|
app.name = 'myapp'
# Add the pod NanoStore to your project
app.pods do
pod 'NanoStore', '~> 2.6.0'
end
endNow, you can use NanoStore in your app.
If you are upgrading from an older version of nano-store gem, make sure you run rake clean and remove vendor/Pods/build* folders before building your project. Otherwise you may still using the old binaries!
# memory only db
NanoStore.shared_store = NanoStore.store(:memory)
# file based db
documents_path = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, true)[0]
NanoStore.shared_store = NanoStore.store(:file, documents_path + "/nano.db")class User < NanoStore::Model
attribute :name
attribute :age
attribute :created_at
endA key (UUID) that identifies the object will be added automatically.
Attributes must be serializable, which means that only the following data types are allowed:
- NSArray
- NSDictionary
- NSString
- NSData (*)
- NSDate
- NSNumber
- NSNull
- NSURL
(*) The data type NSData is allowed, but it will be excluded from the indexing process.
# Initialize a new object and save it
user = User.new(:name => "Bob", :age => 16, :created_at => Time.now)
user.save
user.key # => "550e8400-e29b-41d4-a716-446655440000" (automatically generated UUID)
# Create a new object directly
user = User.create(:name => "Bob", :age => 16, :created_at => Time.now)# find all models
User.all # => [<User#1>, <User#2>]
# find model by criteria
users = User.find(:name, NSFEqualTo, "Bob")
# or use Hash
users = User.find(:name => "Bob")
users = User.find(:name => { NSFEqualTo => "Ronald" })
users = User.find(:name => { NSFEqualTo => "Ronald" }, :age => { NSFGreaterThan => 50 })
# or use Array for matching multiple values
users = User.find(:name => ["Bob", "Ronald", "Ken"])
# Optionally sort the result with additional hash parameters
users = User.find({:age => { NSFGreaterThan => 10 }}, {:sort => {:age => :desc}})user = User.find(:name, NSFEqualTo, "Bob").first
user.name = "Dom"
user.saveuser = User.find(:name, NSFEqualTo, "Bob").first
user.delete
# Bulk delete
User.delete(:age => {NSFGreaterThan => 20})Use transaction is easy, just wrap your database code in a transaction block.
store = NanoStore.shared_store = NanoStore.store
begin
store.transaction do |the_store|
Animal.count # => 0
obj1 = Animal.new
obj1.name = "Cat"
obj1.save
obj2 = Animal.new
obj2.name = "Dog"
obj2.save
Animal.count # => 2
raise "error" # => an error happened!
end
rescue
# error handling
end
Animal.count # => 0A bag is a loose collection of objects stored in a document store.
store = NanoStore.store
bag = Bag.bag
store << bag
# add subclass of NanoStore::Model object to bag
page = Page.new
page.text = "Hello"
page.index = 1
bag << page
# save the bag
bag.save
# obtain the bags from document store
bags = store.bagsUse bag to declare a Bag that associated with a Model.
class User < NanoStore::Model
attribute :name
attribute :age
attribute :created_at
bag :cars
end
class Car < NanoStore::Model
attribute :name
attribute :age
end
user = User.new(:name => "Peter", :age => 20, :created_at => Time.now)
user.cars << Car.new(:name => "Mini", :age => 0)
user.save
user.cars # => #<NanoStore::Bag:0x7411410> If you are using NanoStoreInMotion with KVO, aware that NanoStore::Model actually store data in a field info and create methods dynamically. Instead of listening on the field name field_name, you should listen on key path info.field_name.
For example, instead of following code:
class Radio < NanoStore::Model
attribute :name
end
radio = Radio.new
radio.addObserver(observer, forKeyPath:"name", options: NSKeyValueObservingOptionNew, context: nil)
You should do:
radio = Radio.new
radio.addObserver(observer, forKeyPath:"info.name", options: NSKeyValueObservingOptionNew, context: nil)
NanoStore by defaults saves every object to disk one by one. To speed up inserts and edited objects, increase NSFNanoStore's saveInterval property.
# Create a store
store = NanoStore.shared_store = NanoStore.store
# Increase the save interval
store.save_interval = 1000
# Do a bunch of inserts and/or edits
obj1 = Animal.new
obj1.name = "Cat"
store << obj1
obj2 = Animal.new
obj2.name = "Dog"
store << obj2
# Don't forget that some objects could be lingering in memory. Force a save.
store.saveNote: If you set the saveInterval value to anything other one, keep in mind that some objects may still be left unsaved after being added or modified. To make sure they're saved properly, call:
store.saveChoosing a good saveInterval value is more art than science. While testing NanoStore using a medium-sized dictionary (iTunes MP3 dictionary) setting saveInterval to 1000 resulted in the best performance. You may want to test with different numbers and fine-tune it for your data set.
- Based on NanoStore from Tito Ciuro, Webbo, L.L.C.
BSD License
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent