Browse files

first commit

  • Loading branch information...
0 parents commit b446d3a26b0b358f440870aa828d63949b13df8d @SergejJurecko committed Aug 26, 2009
Showing with 1,335 additions and 0 deletions.
  1. +203 −0 LICENSE.txt
  2. +31 −0 README.rdoc
  3. +8 −0
  4. +46 −0 erlmongo.hrl
  5. +11 −0 erlmongo_app.erl
  6. +242 −0 mongoapi.erl
  7. +775 −0 mongodb.erl
  8. +19 −0 mongodb_supervisor.erl
@@ -0,0 +1,203 @@
+ Apache License
+ Version 2.0, January 2004
+ 1. Definitions.
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ implied, including, without limitation, any warranties or conditions
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+ APPENDIX: How to apply the Apache License to your work.
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+ Copyright [yyyy] [name of copyright owner]
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ See the License for the specific language governing permissions and
+ limitations under the License.
@@ -0,0 +1,31 @@
+= Info
+Erlmongo is a pretty complete Erlang driver for mongodb. Gridfs stuff is not supported yet, but it will be done eventually.
+It supports records and proplists as datatypes. Strings can be lists or binaries, but strings received from mongodb (as a result of find) will be binaries.
+The only built in limitation is in regards to record field names. They need to start with [a-z] (because of records) and be in latin1 (performance reason). Record values can of course be anything. It's a stupid idea to use non ascii characters as field names anyway.
+I haven't used erlmongo in production yet, so all the bugs might not be ironed out and there are a few inconsistencies with the api (I'll fix them in the near future).
+= Examples
+ rr("erlmongo.hrl").
+ % Set mongodb server info. singleServer() is the same as singleServer("localhost:27017")
+ mongodb:singleServer().
+ mongodb:connect().
+ % Create an interface for test database (it has to be a binary)
+ Mong = mongoapi:new(<<"test">>).
+ % Save a new document
+ Mong:save(#mydoc{name = "MyDocument", i = 10}).
+ % Return the document, but only the "i" field (+ _id which always gets returned)
+ Mong:findOne(#mydoc{i = 10}, [#mydoc.i]).
+ % Set Index. First parameter is so that the driver knows what collection
+ % we mean. If you have an already constructed record laying around use that.
+ % No need to construct a new record just so the driver can read the name.
+ % Second parameter the index we wish to create. 1 = ascending, -1 = descending.
+ Mong:ensureIndex(#mydoc{}, [{#mydoc.i, 1}, {, -1}])
@@ -0,0 +1,8 @@
+{application, erlmongo, [{description, "Erlang driver for mongodb"},
+ {vsn, "0.1"},
+ {modules, [erlmongo_app, mongodb, mongoapi, mongodb_supervisor]},
+ {registered, [mongodb, mongodb_supervisor]},
+ {applications, [kernel, stdlib]},
+ {mod, {erlmongo_app, []}},
+ {start_phases, []}
+ ]}.
@@ -0,0 +1,46 @@
+% recindex is index of record in RECTABLE define, it has to be the first record field
+% docid is _id in mongodb, it has to be named docid and it has to be the second field in the record
+-record(mydoc, {recindex = 1, docid, name, i}).
+% A table of records used with mongodb.
+-define(RECTABLE, {record_info(fields, mydoc)}).
+-export([rec2prop/2, prop2rec/4]).
+% Convert record to prop list
+rec2prop(Rec, RecordFields) ->
+ loop_rec(RecordFields, 1, Rec, []).
+loop_rec([H|T], N, Rec, L) ->
+ loop_rec(T, N+1, Rec, [{H, element(N+1, Rec)}|L]);
+loop_rec([], _, _, L) ->
+ L.
+% convert prop list to record
+prop2rec(Prop, RecName, DefRec, RecordFields) ->
+ loop_fields(erlang:make_tuple(tuple_size(DefRec), RecName), RecordFields, DefRec, Prop, 2).
+loop_fields(Tuple, [Field|T], DefRec, Props, N) ->
+ case lists:keysearch(Field, 1, Props) of
+ {value, {_, Val}} ->
+ loop_fields(setelement(N, Tuple, Val), T, DefRec, Props, N+1);
+ false ->
+ loop_fields(setelement(N, Tuple, element(N, DefRec)), T, DefRec, Props, N+1)
+ end;
+loop_fields(Tuple, [], _, _, _) ->
+ Tuple.
+% mongo
+-define(QUER_OPT_NONE, 0).
+-define(QUER_OPT_CURSOR, 2).
+-define(QUER_OPT_SLAVEOK, 4).
+-define(QUER_OPT_NOTIMEOUT, 16).
+-record(cursor, {id, pid, limit = 0}).
+-record(update, {upsert = 1, selector = <<>>, document = <<>>}).
+-record(insert, {documents = []}).
+-record(quer, {ndocs = 1, nskip = 0, quer = <<>>, field_selector = <<>>, opts = ?QUER_OPT_NONE}).
+-record(delete, {selector = <<>>}).
+-record(killc, {cur_ids = <<>>}).
@@ -0,0 +1,11 @@
+-export([start/2, stop/1]).
+start(_Type, _Args) ->
+ mongodb_supervisor:start_link().
+stop(_State) ->
+ ok.
Oops, something went wrong.

0 comments on commit b446d3a

Please sign in to comment.