Querying

• Finders
  • find
  • all
  • last
  • first
  • find_each
  • paginate
• Criteria
  • where
  • fields
  • count
  • sort, order
  • limit
  • skip, offset
• Operators
• Destroying documents
  • destroy
  • destroy_all
  • delete
  • delete_all

Finders

find

Find one or more documents by their _id.

# works with string representation of object id
Patient.find('4da32870c198a73ca3000001')

# or with actual object id
Patient.find(MarkMapper::ObjectId.from_string('4da32870c198a73ca3000001'))

# also works with array of ids or multiple arguments
Patient.find(['4da32870c198a73ca3000001', '4da32870c198a73ca3000002'])
Patient.find('4da32870c198a73ca3000001', '4da32870c198a73ca3000002')

all

Get all of the documents in a query as an array. Works with options or criteria.

Patient.all(:last_name => 'Johnson', :order => :last_name.asc)

find_each

Get all of the documents in a query one at a time and pass them to the given block. Works with options or criteria.

Patient.find_each(:last_name => "Johnson") do |document|
  # do something with document
end

first

Get the first document in a query. Naturally, this makes the most sense when you have also provided a means of sorting.

Patient.first(:order => :created_at.desc)
Patient.first(:email => 'john@doe.com')

last

Get the last document in a query. Naturally, this makes the most sense when you have also provided a means of sorting.

Patient.last(:order => :created_at.asc)

paginate

Paginate the query.

Patient.paginate({
  :order    => :created_at.asc,
  :per_page => 25,
  :page     => 3,
})

Criteria

MarkLogic has rich support for dynamic queries. MarkMapper constructs query proxy objects that only retrieve data from MarkLogic when needed. This allows a query to be composed of several conditions before being evaluated.

where

Use where to specify your query criteria.

patients = Patient.where(:first_name => "John", :last_name => "Johnson")

fields

Sometimes you know you are loading objects for a very specific purpose–maybe to show a few fields on the UI. You can limit the number of fields returned with data filled in as follows:

query = Patient.where(:last_name => "Johnson").
        fields(:last_name, :gender).all
#=> [#<Patient created_at: nil, updated_at: nil, _id: MarkMapper::ObjectId('4d140b878951a202ae000002'), gender: "M", last_name: "Johnson", first_name: nil>]

Note that all the other attributes in your model will be nil (or set to their default value). Therefore, if you call a method that makes use of all the attributes–like @to_json@–then keep in mind that the values will be nil, and you will need to emit only those fields:

query.to_json(:only => [:last_name, :gender])
#=> "[{\"last_name\":\"Johnson\",\"gender\":\"M\"}]"

count

Instead of returning an array of complete documents, you may want to merely check to see how many exist.

patients = Patient.where( :last_name.gte => 'A', :last_name.lt => 'B' ).count
#=> 1803

sort, order

You can choose to sort the documents by various keys, ascending (default) or descending.

Patient.sort(:last_name)

Patient.where(:updated_at.gte => 3.days.ago).sort(:updated_at.desc)

limit

You can limit the number of documents returned by the query.

patients = Patient.sort(:last_name).limit(10)

skip, offset

Skip is used to return a list of documents beyond the number that are requested to be skipped.

patients = Patient.sort(:last_name).limit(10).skip(10)

Operators

MarkLogic range indexes support a few conditional operators. You can use these directly in your MarkMapper queries.

User.where(:age => {:$gt => 21, :$lt => 30})

MarkMapper also provides shorthand for most of these operators.

User.where(:age.gt => 21)

Destroying documents

MarkMapper provides 2 methods for destroying/deleting documents and 2 methods for removing/destroying all documents.

destroy

Destroy a single or multiple document(s) by providing ID or tne instance of a document

# Destroy a single user with the given ID
User.destroy("50a210d2f7aa6006d2000001")

# Destroys two user with given ids
User.destroy("50a210d2f7aa6006d2000001", "50a21153f7aa6006d2000002")

# Delete an instance
u = User.create(:name => cow)
u.destroy

destroy_all

Destroy all or multiple documents from given matching criteria
Warning: You can loose all your data if you call this at the wrong time.

# Destroy every user in the collection
User.destroy_all

# Destroys user with a given name
User.destroy_all(:name => "George")

delete

Delete document(s) from given ID or the delete an instance of a document.
Callbacks are NOT triggered.

Usage is identical to destroy

delete_all

Delete multiple or all documents.
Callbacks are NOT triggered.

Usage is identical to destroy_all