Skip to content

Commit cfc9fb5

Browse files
author
Ozgun Erdogan
committed
Initial commit for MongoDB foreign data wrapper
0 parents  commit cfc9fb5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+15667
-0
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Generated subdirectories
2+
/log/
3+
/results/
4+
/tmp_check/

‎Makefile

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# mongo_fdw/Makefile
2+
3+
MODULE_big = mongo_fdw
4+
5+
#
6+
# We assume we are running on a POSIX compliant system (Linux, OSX). If you are
7+
# on another platform, change env_posix.os in MONGO_OBJS with the appropriate
8+
# environment object file.
9+
#
10+
11+
MONGO_DRIVER = mongo-c-driver-v0.6
12+
MONGO_PATH = $(MONGO_DRIVER)/src
13+
MONGO_OBJS = $(MONGO_PATH)/bson.os $(MONGO_PATH)/encoding.os $(MONGO_PATH)/md5.os \
14+
$(MONGO_PATH)/mongo.os $(MONGO_PATH)/numbers.os $(MONGO_PATH)/env_posix.os
15+
16+
PG_CPPFLAGS = --std=c99 -I$(MONGO_PATH)
17+
OBJS = mongo_fdw.o mongo_query.o $(MONGO_OBJS)
18+
19+
EXTENSION = mongo_fdw
20+
DATA = mongo_fdw--1.0.sql
21+
22+
#
23+
# We first build our dependency, the Mongo C driver library here. For this, we
24+
# explicitly invoke the subdirectory's make system.
25+
#
26+
27+
all: all-mongo-driver
28+
all-mongo-driver:
29+
$(MAKE) -C $(MONGO_DRIVER) all
30+
31+
clean: clean-mongo-driver
32+
clean-mongo-driver:
33+
$(MAKE) -C $(MONGO_DRIVER) clean
34+
35+
#
36+
# Users need to specify their Postgres installation path through pg_config. For
37+
# example: /usr/local/pgsql/bin/pg_config or /usr/lib/postgresql/9.1/bin/pg_config
38+
#
39+
40+
PG_CONFIG = pg_config
41+
PGXS := $(shell $(PG_CONFIG) --pgxs)
42+
include $(PGXS)

‎README

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
MongoDB FDW for PostgreSQL 9.1
2+
==============================
3+
4+
This PostgreSQL extension implements a Foreign Data Wrapper (FDW) for MongoDB.
5+
For an example setup that demonstrates this wrapper's use, please see: XXXX
6+
[link to blog]. Also note that this version of mongo_fdw only works with
7+
PostgreSQL 9.1.
8+
9+
10+
Building
11+
--------
12+
13+
The MongoDB FDW already includes the official MongoDB C Driver version 0.6. When
14+
you type make, the C driver's source code also gets automatically compiled and
15+
linked.
16+
17+
To build on POSIX compliant systems (Linux and OS X), you simply need to include
18+
the pg_config directory path in your make command. This path is typically the
19+
same as your PostgreSQL installation's bin/ directory path. For example:
20+
21+
$ PATH=/usr/local/pgsql/bin/:$PATH make
22+
$ sudo PATH=/usr/local/pgsql/bin/:$PATH make install
23+
24+
Note that we have tested the mongo_fdw extension only on Fedora and Ubuntu
25+
systems. Please let us know if you run into any issues on other systems.
26+
27+
28+
Usage
29+
-----
30+
31+
The following parameters can be set on a MongoDB foreign server object.
32+
33+
* address: The address or hostname of the MongoDB server. Defaults to "127.0.0.1".
34+
* port: The port number of the MongoDB server. Defaults to 27017.
35+
36+
The following parameters can be set on a MongoDB foreign table object.
37+
38+
* database: The name of the MongoDB database to query. Defaults to "test".
39+
* collection: The name of the MongoDB collection to query. Defaults to foreign
40+
table name specified in the create command.
41+
42+
As an example, the following commands demonstrate loading the mongo_fdw wrapper,
43+
creating a server, and then creating a foreign table associated with a MongoDB
44+
collection. The commands also show specifying option values in the OPTIONS
45+
clause. If an option value isn't provided, the wrapper uses the default value
46+
mentioned above.
47+
48+
49+
-- load extension first time after install
50+
CREATE EXTENSION mongo_fdw;
51+
52+
-- create server object
53+
CREATE SERVER mongo_server FOREIGN DATA WRAPPER mongo_fdw
54+
OPTIONS (address '127.0.0.1', port '27017');
55+
56+
-- create foreign table
57+
CREATE FOREIGN TABLE customer_reviews
58+
(
59+
customer_id TEXT,
60+
review_date TIMESTAMP,
61+
review_rating INTEGER,
62+
product_id CHAR(10),
63+
product_title TEXT,
64+
product_group TEXT,
65+
product_category TEXT,
66+
similar_product_ids CHAR(10)[]
67+
)
68+
SERVER mongo_server
69+
OPTIONS (database 'test', collection 'customer_reviews');
70+
71+
72+
Limitations
73+
-----------
74+
75+
* mongo_fdw currently can't reach into nested BSON documents. We can overcome
76+
this limitation by interpreting the period character in column names as a
77+
separator, and recursing into the BSON document for each separated key name.
78+
79+
* mongo_fdw currently can't access BSON document keys that have upper-case
80+
letters in them. This is because column names in SQL are case insensitive. We
81+
can overcome this limitation by having an option for each column name, where
82+
the option value is case sensitive.
83+
84+
* mongo_fdw only incorporates the document count and average document size when
85+
estimating costs for the query execution plan. A better estimate also includes
86+
data distribution statistics; and PostgreSQL 9.2 allows for this. In the mean
87+
time, you run EXPLAIN on your queries to see the selected execution plans.
88+
89+
90+
Copyright
91+
---------
92+
93+
Copyright (c) 2012 Citus Data, Inc.
94+
95+
This module is free software; you can redistribute it and/or modify it under the
96+
GNU GPL v3.0 License.
97+
98+
For all types of questions and comments about the wrapper, please contact us at
99+
engage @ citusdata.com.

‎mongo-c-driver-v0.6/.astylerc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
--style=java
2+
--pad-paren-in
3+
--pad-paren-in
4+
--align-pointer=name

‎mongo-c-driver-v0.6/.gitignore

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
*~
3+
*.o
4+
*.os
5+
*.obj
6+
*.a
7+
*.lib
8+
*.so
9+
*.dylib
10+
.scon*
11+
*.pyc
12+
*.swp
13+
14+
.DS_Store
15+
16+
test_*
17+
benchmark
18+
benchmark.exe
19+
20+
tags
21+
22+
config.log
23+
24+
docs/html
25+
docs/source/sphinx/build
26+
docs/source/doxygen

‎mongo-c-driver-v0.6/APACHE-2.0.txt

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)