|
CFMongoDB | ||||
FRAMES |
WEB-INF.cftags.componentcfmongodb.core.DBCollection
public class DBCollection
Constructor Summary | |
---|---|
init([any collectionName], [any mongo])
Not intended to be invoked directly |
Method Summary | |
---|---|
any |
GETMONGOUTIL()
|
void |
SETMONGOUTIL(any mongoUtil)
|
any |
count([struct criteria='[runtime expression]'])
|
any |
distinct([string key], [struct query])
Runs mongodb's distinct() command |
any |
drop()
drops this collection |
array |
dropIndexes()
Drops all indexes from the collection |
array |
ensureGeoIndex([any field], [any min=''], [any max=''])
Ensures a "2d" index on a single field |
array |
ensureIndex([array fields], [any unique='false'])
The array of fields can either be a) an array of field names |
any |
find([struct criteria='[runtime expression]'], [string keys=''], [numeric skip='0'], [numeric limit='0'], [any sort='[runtime expression]'])
Find documents matching the given criteria |
any |
findAndModify([struct query], [struct fields], [struct sort], [boolean remove='false'], [struct update], [boolean returnNew='true'], [boolean upsert='false'])
findAndModify is critical for queue-like operations |
any |
findById([any id])
Returns a single document matching the passed in id (i |
struct |
findOne([struct criteria='[runtime expression]'])
Find a single document matching the given criteria |
array |
getIndexes()
Returns an array with information about all of the indexes for the collection |
private any |
getMongoDB()
Get the underlying Java driver's DB object |
any |
getMongoDBCollection()
Get the underlying Java driver's DBCollection object for the given collection |
any |
group([any keys], [any initial], [any reduce], [any query], [any keyf=''], [any finalize=''])
Executes Mongo's group() command |
any |
insert([struct doc])
Inserts a struct into the collection |
any |
mapReduce([any map], [any reduce], [any outputTarget], [any outputType='REPLACE'], [any query], [any options])
Executes Mongo's mapReduce command |
any |
query()
Build a query object, and then execute that query using find() Query returns a SearchBuilder object, which you'll call functions on |
any |
remove([any doc])
Remove one or more documents from the collection |
any |
removeById([any id])
Convenience for removing a document from the collection by the String representation of its ObjectId collection |
any |
save([struct doc])
Saves a struct into the collection; Returns the newly-saved Document's _id; populates the struct with that _id person = {name="bill", badmofo=true}; collection |
any |
saveAll([array docs])
Saves an array of structs into the collection |
private any |
toCF([any dbObject])
|
private any |
toMongo([any doc])
|
private any |
toMongoOperation([any doc])
|
any |
update([any doc], [any query], [any upsert='false'], [any multi='false'])
Updates a document in the collection |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init([any collectionName], [any mongo])
collectionName
mongo
Method Detail |
---|
public any GETMONGOUTIL()
public void SETMONGOUTIL(any mongoUtil)
mongoUtil
public any count([struct criteria='[runtime expression]'])
criteria
public any distinct([string key], [struct query])
key
query
public any drop()
public array dropIndexes()
public array ensureGeoIndex([any field], [any min=''], [any max=''])
field
min
max
public array ensureIndex([array fields], [any unique='false'])
fields
unique
public any find([struct criteria='[runtime expression]'], [string keys=''], [numeric skip='0'], [numeric limit='0'], [any sort='[runtime expression]'])
criteria
keys
skip
limit
sort
public any findAndModify([struct query], [struct fields], [struct sort], [boolean remove='false'], [struct update], [boolean returnNew='true'], [boolean upsert='false'])
query
fields
sort
remove
update
returnNew
upsert
public any findById([any id])
id
public struct findOne([struct criteria='[runtime expression]'])
criteria
public array getIndexes()
private any getMongoDB()
public any getMongoDBCollection()
public any group([any keys], [any initial], [any reduce], [any query], [any keyf=''], [any finalize=''])
keys
initial
reduce
query
keyf
finalize
public any insert([struct doc])
doc
public any mapReduce([any map], [any reduce], [any outputTarget], [any outputType='REPLACE'], [any query], [any options])
map
reduce
outputTarget
outputType
query
options
public any query()
public any remove([any doc])
doc
public any removeById([any id])
id
public any save([struct doc])
doc
public any saveAll([array docs])
docs
private any toCF([any dbObject])
dbObject
private any toMongo([any doc])
doc
private any toMongoOperation([any doc])
doc
public any update([any doc], [any query], [any upsert='false'], [any multi='false'])
doc
query
upsert
multi
|
CFMongoDB | ||||
FRAMES |