Class: CouchRest::Database
Instance Attribute Summary collapse
-
#bulk_save_cache_limit ⇒ Object
Returns the value of attribute bulk_save_cache_limit.
-
#host ⇒ Object
readonly
Returns the value of attribute host.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#root ⇒ Object
readonly
Returns the value of attribute root.
-
#server ⇒ Object
readonly
Returns the value of attribute server.
-
#uri ⇒ Object
readonly
Returns the value of attribute uri.
Instance Method Summary collapse
-
#bulk_save(docs = nil, use_uuids = true) ⇒ Object
(also: #bulk_delete)
POST an array of documents to CouchDB.
-
#compact! ⇒ Object
Compact the database, removing old document revisions and optimizing space use.
-
#copy(doc, dest) ⇒ Object
DEPRECATION NOTICE.
-
#copy_doc(doc, dest) ⇒ Object
COPY an existing document to a new id.
-
#create! ⇒ Object
Create the database.
-
#delete(doc, bulk = false) ⇒ Object
DEPRECATION NOTICE.
-
#delete! ⇒ Object
DELETE the database itself.
-
#delete_attachment(doc, name) ⇒ Object
DELETE an attachment directly from CouchDB.
-
#delete_doc(doc, bulk = false) ⇒ Object
DELETE the document from CouchDB that has the given
_id
and_rev
. -
#documents(params = {}) ⇒ Object
Query the
_all_docs
view. -
#fetch_attachment(doc, name) ⇒ Object
GET an attachment directly from CouchDB.
-
#get(id, params = {}) ⇒ Object
GET a document from CouchDB, by id.
-
#get_bulk(ids) ⇒ Object
load a set of documents by passing an array of ids.
-
#info ⇒ Object
GET the database info from CouchDB.
-
#initialize(server, name) ⇒ Database
constructor
Create a CouchRest::Database adapter for the supplied CouchRest::Server and database name.
-
#put_attachment(doc, name, file, options = {}) ⇒ Object
PUT an attachment directly to CouchDB.
-
#recreate! ⇒ Object
Delete and re create the database.
-
#replicate_from(other_db) ⇒ Object
Replicates via “pulling” from another database to this database.
-
#replicate_to(other_db) ⇒ Object
Replicates via “pushing” to another database.
-
#save(doc, bulk = false) ⇒ Object
DEPRECATION NOTICE.
-
#save_doc(doc, bulk = false) ⇒ Object
Save a document to CouchDB.
-
#slow_view(funcs, params = {}) ⇒ Object
(also: #temp_view)
POST a temporary view function to CouchDB for querying.
-
#to_s ⇒ Object
returns the database’s uri.
-
#view(name, params = {}, &block) ⇒ Object
Query a CouchDB view as defined by a
_design
document.
Constructor Details
#initialize(server, name) ⇒ Database
Create a CouchRest::Database adapter for the supplied CouchRest::Server and database name.
Parameters
- server<CouchRest::Server>
-
database host
- name<String>
-
database name
16 17 18 19 20 21 22 23 24 |
# File 'lib/couchrest/core/database.rb', line 16 def initialize(server, name) @name = name @server = server @host = server.uri @uri = @root = "#{host}/#{name.gsub('/','%2F')}" @streamer = Streamer.new(self) @bulk_save_cache = [] @bulk_save_cache_limit = 500 # must be smaller than the uuid count end |
Instance Attribute Details
#bulk_save_cache_limit ⇒ Object
Returns the value of attribute bulk_save_cache_limit.
7 8 9 |
# File 'lib/couchrest/core/database.rb', line 7 def bulk_save_cache_limit @bulk_save_cache_limit end |
#host ⇒ Object (readonly)
Returns the value of attribute host.
6 7 8 |
# File 'lib/couchrest/core/database.rb', line 6 def host @host end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
6 7 8 |
# File 'lib/couchrest/core/database.rb', line 6 def name @name end |
#root ⇒ Object (readonly)
Returns the value of attribute root.
6 7 8 |
# File 'lib/couchrest/core/database.rb', line 6 def root @root end |
#server ⇒ Object (readonly)
Returns the value of attribute server.
6 7 8 |
# File 'lib/couchrest/core/database.rb', line 6 def server @server end |
#uri ⇒ Object (readonly)
Returns the value of attribute uri.
6 7 8 |
# File 'lib/couchrest/core/database.rb', line 6 def uri @uri end |
Instance Method Details
#bulk_save(docs = nil, use_uuids = true) ⇒ Object Also known as: bulk_delete
POST an array of documents to CouchDB. If any of the documents are missing ids, supply one from the uuid cache.
If called with no arguments, bulk saves the cache of documents to be bulk saved.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/couchrest/core/database.rb', line 173 def bulk_save(docs = nil, use_uuids = true) if docs.nil? docs = @bulk_save_cache @bulk_save_cache = [] end if (use_uuids) ids, noids = docs.partition{|d|d['_id']} uuid_count = [noids.length, @server.uuid_batch_count].max noids.each do |doc| nextid = @server.next_uuid(uuid_count) rescue nil doc['_id'] = nextid if nextid end end CouchRest.post "#{@uri}/_bulk_docs", {:docs => docs} end |
#compact! ⇒ Object
Compact the database, removing old document revisions and optimizing space use.
233 234 235 |
# File 'lib/couchrest/core/database.rb', line 233 def compact! CouchRest.post "#{@uri}/_compact" end |
#copy(doc, dest) ⇒ Object
DEPRECATION NOTICE
227 228 229 230 |
# File 'lib/couchrest/core/database.rb', line 227 def copy(doc, dest) puts "CouchRest::Database's copy method is being deprecated, please use copy_doc instead" copy_doc(doc, dest) end |
#copy_doc(doc, dest) ⇒ Object
COPY an existing document to a new id. If the destination id currently exists, a rev must be provided. dest
can take one of two forms if overwriting: “id_to_overwrite?rev=revision” or the actual doc hash with a ‘_rev’ key
215 216 217 218 219 220 221 222 223 224 |
# File 'lib/couchrest/core/database.rb', line 215 def copy_doc(doc, dest) raise ArgumentError, "_id is required for copying" unless doc['_id'] slug = escape_docid(doc['_id']) destination = if dest.respond_to?(:has_key?) && dest['_id'] && dest['_rev'] "#{dest['_id']}?rev=#{dest['_rev']}" else dest end CouchRest.copy "#{@uri}/#{slug}", destination end |
#create! ⇒ Object
Create the database
238 239 240 241 |
# File 'lib/couchrest/core/database.rb', line 238 def create! bool = server.create_db(@name) rescue false bool && true end |
#delete(doc, bulk = false) ⇒ Object
DEPRECATION NOTICE
207 208 209 210 |
# File 'lib/couchrest/core/database.rb', line 207 def delete(doc, bulk=false) puts "CouchRest::Database's delete method is being deprecated, please use delete_doc instead" delete_doc(doc, bulk) end |
#delete! ⇒ Object
DELETE the database itself. This is not undoable and could be rather catastrophic. Use with care!
266 267 268 |
# File 'lib/couchrest/core/database.rb', line 266 def delete! CouchRest.delete @uri end |
#delete_attachment(doc, name) ⇒ Object
DELETE an attachment directly from CouchDB
117 118 119 120 121 |
# File 'lib/couchrest/core/database.rb', line 117 def doc, name uri = (doc, name) # this needs a rev JSON.parse(RestClient.delete(uri)) end |
#delete_doc(doc, bulk = false) ⇒ Object
DELETE the document from CouchDB that has the given _id
and _rev
.
If bulk
is true (false by default) the deletion is recorded for bulk-saving (bulk-deletion :) later. Bulk saving happens automatically when #bulk_save_cache limit is exceded, or on the next non bulk save.
195 196 197 198 199 200 201 202 203 204 |
# File 'lib/couchrest/core/database.rb', line 195 def delete_doc(doc, bulk = false) raise ArgumentError, "_id and _rev required for deleting" unless doc['_id'] && doc['_rev'] if bulk @bulk_save_cache << { '_id' => doc['_id'], '_rev' => doc['_rev'], '_deleted' => true } return bulk_save if @bulk_save_cache.length >= @bulk_save_cache_limit return { "ok" => true } # Mimic the non-deferred version end slug = escape_docid(doc['_id']) CouchRest.delete "#{@uri}/#{slug}?rev=#{doc['_rev']}" end |
#documents(params = {}) ⇒ Object
Query the _all_docs
view. Accepts all the same arguments as view.
37 38 39 40 41 42 43 44 45 |
# File 'lib/couchrest/core/database.rb', line 37 def documents(params = {}) keys = params.delete(:keys) url = CouchRest.paramify_url "#{@uri}/_all_docs", params if keys CouchRest.post(url, {:keys => keys}) else CouchRest.get url end end |
#fetch_attachment(doc, name) ⇒ Object
GET an attachment directly from CouchDB
100 101 102 103 104 105 106 |
# File 'lib/couchrest/core/database.rb', line 100 def (doc, name) # slug = escape_docid(docid) # name = CGI.escape(name) uri = (doc, name) RestClient.get uri # "#{@uri}/#{slug}/#{name}" end |
#get(id, params = {}) ⇒ Object
GET a document from CouchDB, by id. Returns a Ruby Hash.
85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/couchrest/core/database.rb', line 85 def get(id, params = {}) slug = escape_docid(id) url = CouchRest.paramify_url("#{@uri}/#{slug}", params) result = CouchRest.get(url) return result unless result.is_a?(Hash) doc = if /^_design/ =~ result["_id"] Design.new(result) else Document.new(result) end doc.database = self doc end |
#get_bulk(ids) ⇒ Object
load a set of documents by passing an array of ids
48 49 50 |
# File 'lib/couchrest/core/database.rb', line 48 def get_bulk(ids) documents(:keys => ids, :include_docs => true) end |
#info ⇒ Object
GET the database info from CouchDB
32 33 34 |
# File 'lib/couchrest/core/database.rb', line 32 def info CouchRest.get @uri end |
#put_attachment(doc, name, file, options = {}) ⇒ Object
PUT an attachment directly to CouchDB
109 110 111 112 113 114 |
# File 'lib/couchrest/core/database.rb', line 109 def (doc, name, file, = {}) docid = escape_docid(doc['_id']) name = CGI.escape(name) uri = (doc, name) JSON.parse(RestClient.put(uri, file, )) end |
#recreate! ⇒ Object
Delete and re create the database
244 245 246 247 248 249 250 |
# File 'lib/couchrest/core/database.rb', line 244 def recreate! delete! create! rescue RestClient::ResourceNotFound ensure create! end |
#replicate_from(other_db) ⇒ Object
Replicates via “pulling” from another database to this database. Makes no attempt to deal with conflicts.
253 254 255 256 |
# File 'lib/couchrest/core/database.rb', line 253 def replicate_from other_db raise ArgumentError, "must provide a CouchReset::Database" unless other_db.kind_of?(CouchRest::Database) CouchRest.post "#{@host}/_replicate", :source => other_db.root, :target => name end |
#replicate_to(other_db) ⇒ Object
Replicates via “pushing” to another database. Makes no attempt to deal with conflicts.
259 260 261 262 |
# File 'lib/couchrest/core/database.rb', line 259 def replicate_to other_db raise ArgumentError, "must provide a CouchReset::Database" unless other_db.kind_of?(CouchRest::Database) CouchRest.post "#{@host}/_replicate", :target => other_db.root, :source => name end |
#save(doc, bulk = false) ⇒ Object
DEPRECATION NOTICE
163 164 165 166 |
# File 'lib/couchrest/core/database.rb', line 163 def save(doc, bulk=false) puts "CouchRest::Database's save method is being deprecated, please use save_doc instead" save_doc(doc, bulk) end |
#save_doc(doc, bulk = false) ⇒ Object
Save a document to CouchDB. This will use the _id
field from the document as the id for PUT, or request a new UUID from CouchDB, if no _id
is present on the document. IDs are attached to documents on the client side because POST has the curious property of being automatically retried by proxies in the event of network segmentation and lost responses.
If bulk
is true (false by default) the document is cached for bulk-saving later. Bulk saving happens automatically when #bulk_save_cache limit is exceded, or on the next non bulk save.
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/couchrest/core/database.rb', line 132 def save_doc(doc, bulk = false) if doc['_attachments'] doc['_attachments'] = (doc['_attachments']) end if bulk @bulk_save_cache << doc return bulk_save if @bulk_save_cache.length >= @bulk_save_cache_limit return {"ok" => true} # Compatibility with Document#save elsif !bulk && @bulk_save_cache.length > 0 bulk_save end result = if doc['_id'] slug = escape_docid(doc['_id']) CouchRest.put "#{@uri}/#{slug}", doc else begin slug = doc['_id'] = @server.next_uuid CouchRest.put "#{@uri}/#{slug}", doc rescue #old version of couchdb CouchRest.post @uri, doc end end if result['ok'] doc['_id'] = result['id'] doc['_rev'] = result['rev'] doc.database = self if doc.respond_to?(:database=) end result end |
#slow_view(funcs, params = {}) ⇒ Object Also known as: temp_view
POST a temporary view function to CouchDB for querying. This is not recommended, as you don’t get any performance benefit from CouchDB’s materialized views. Can be quite slow on large databases.
55 56 57 58 59 60 |
# File 'lib/couchrest/core/database.rb', line 55 def slow_view(funcs, params = {}) keys = params.delete(:keys) funcs = funcs.merge({:keys => keys}) if keys url = CouchRest.paramify_url "#{@uri}/_temp_view", params JSON.parse(RestClient.post(url, funcs.to_json, {"Content-Type" => 'application/json'})) end |
#to_s ⇒ Object
returns the database’s uri
27 28 29 |
# File 'lib/couchrest/core/database.rb', line 27 def to_s @uri end |
#view(name, params = {}, &block) ⇒ Object
Query a CouchDB view as defined by a _design
document. Accepts paramaters as described in wiki.apache.org/couchdb/HttpViewApi
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/couchrest/core/database.rb', line 67 def view(name, params = {}, &block) keys = params.delete(:keys) name = name.split('/') # I think this will always be length == 2, but maybe not... dname = name.shift vname = name.join('/') url = CouchRest.paramify_url "#{@uri}/_design/#{dname}/_view/#{vname}", params if keys CouchRest.post(url, {:keys => keys}) else if block_given? @streamer.view("_design/#{dname}/_view/#{vname}", params, &block) else CouchRest.get url end end end |