Anonymous avatar Anonymous committed 32440fd

updating api docs

Comments (0)

Files changed (1)

 
 #### Types
 
-PoolName = atom()
-
-Host = string()
-
-Port = integer()
-
-Database = string()
-
-PoolSize = integer()
-
-CollectionName = string()
-
-Selector = Document
-
-Document = [{Key, Val}]
-
-Key = string() | atom() | binary() | integer()
-
-Val = float() | string() | binary() | Document | {array, [term()]} | {binary, BinSubType, binary()} | {oid, binary()} | {oid, string()} | bool() | now() | datetime() | undefined | {regexp, string(), string()} | integer()
-
-BinSubType = integer() <http://www.mongodb.org/display/DOCS/BSON#BSON-noteondatabinary>
+PoolName = atom()  
+Host = string()  
+Port = integer()  
+Database = string()  
+PoolSize = integer()  
+CollectionName = string()  
+Selector = Document  
+Document = [{Key, Val}]  
+Key = string() | atom() | binary() | integer()  
+Val = float() | string() | binary() | Document | {array, [term()]} | {binary, BinSubType, binary()} | {oid, binary()} | {oid, string()} | bool() | now() | datetime() | undefined | {regexp, string(), string()} | integer()  
+BinSubType = integer() <http://www.mongodb.org/display/DOCS/BSON#BSON-noteondatabinary>  
 
 #### Add Pool
 
 
 #### Find
 	
-Options = {timeout, Timeout} | {limit, Limit} | {offset, Offset} | 
-		  {orderby, Orderby} | {fields, Fields} | response_options
-Timeout = integer (timeout in milliseconds)
-Limit = integer
-Offset = integer
-Orderby = [{Key, Direction}]
-Direction = 1 (Asc) | -1 (Desc)
-Fields = [Key] = specifies a list of fields to return in the result set
-response_options = return #response{header, response_flag, cursor_id, offset, limit, documents}
-Result = [Document] | response()
+Options = {timeout, Timeout} | {limit, Limit} | {offset, Offset} | {orderby, Orderby} | {fields, Fields} | response_options  
+Timeout = integer (timeout in milliseconds)  
+Limit = integer  
+Offset = integer  
+Orderby = [{Key, Direction}]  
+Direction = 1 (Asc) | -1 (Desc)  
+Fields = [Key] = specifies a list of fields to return in the result set  
+response_options = return #response{header, response_flag, cursor_id, offset, limit, documents}  
+Result = [Document] | response()  
 	
 	emongo:find(PoolName, CollectionName) -> Result
 	emongo:find(PoolName, CollectionName, Selector) -> Result
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.