Skip to content

Commit e5f2e3c

Browse files
knonomuraknonomura
committed
first release
1 parent 510d749 commit e5f2e3c

File tree

14 files changed

+1224
-1
lines changed

14 files changed

+1224
-1
lines changed

‎APACHE-2.0.txt

Lines changed: 202 additions & 0 deletions
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.

‎CLA_rev1.1.pdf

177 KB
Binary file not shown.

‎Configuration.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Configuration
2+
3+
Here is a list of the properties for GridDB.
4+
5+
|Property|Description|Required|Default Value|
6+
|---|---|---|---|
7+
|gs.user|User name to access GridDB cluster|Required if GridDB is the selected datastore.||
8+
|gs.password|User password to access GridDB cluster|Required if GridDB is the selected datastore.||
9+
|gs.cluster.name|Name of GridDB cluster|Required if GridDB is the selected datastore.||
10+
|gs.notification.address|An IP address (IPV4 only) for receiving a notification used for autodetection of a GridDB master node|Required if using MULTICAST method to connect to GridDB cluster (cannot be specified with neither notification_member nor notification_provider properties at the same time)|239.0.0.1||
11+
|gs.notification.port|An IP port for receiving a notification used for autodetection of a GridDB master node|Required if notification_address is specified|31999||
12+
|gs.notification.member|"List of GridDB cluster nodes. In the form of: (Address1):(Port1),(Address2):(Port2),... "|Required if using FIXED LIST method to connect to GridDB cluster (cannot be specified with neither notification_address nor notification_provider properties at the same time)||
13+
|gs.notification.provider|URL of address provider used to connect to cluster which is configured with PROVIDER mode|Required if using PROVIDER method to connect to GridDB cluster (cannot be specified with neither notification_address nor notification_member properties at the same time)||
14+
|gs.consistency|Can be one of two consistency levels: IMMEDIATE or EVENTUAL|Optional|IMMEDIATE||
15+
|gs.container.cache.size|Size of cache to store GridDB ContainerInfos which are used to get Container without requesting to GridDB |Optional|0|||gs.data.affinity.pattern|GridDB affinity pattern for each container|Optional||
16+
|gs.failover.timeout|The minimum value of waiting time in seconds until a new destination is found in a failover|Optional|60||
17+
|gs.transaction.timeout|The minimum value of transaction timeout time in seconds|Optional|300||

‎README.md

Lines changed: 141 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,142 @@
1-
# griddb_spark
21
GridDB connector for Apache Spark
2+
3+
## Overview
4+
5+
GridDB connector for [Apache Spark](https://spark.apache.org/) is a module supporting connection between GridDB and Apache Spark.
6+
This uses GridDB server, GridDB Java client, and GridDB connector for [Apache Hadoop](http://hadoop.apache.org/) MapReduce.
7+
We can create DataFrame from an existing GridDB container and operate with it.
8+
9+
## Operating environment
10+
11+
Library building and program execution are checked in the environment below.
12+
13+
OS: CentOS6.7(x64)
14+
Java: JDK 1.8.0_101
15+
Apache Hadoop: Version 2.6.5
16+
Apache Spark: Version 2.1.0
17+
Scala: Version 2.11.8
18+
19+
GridDB server and Java client: 3.0 CE
20+
GridDB connector for Apache Hadoop MapReduce: 1.0
21+
22+
## QuickStart
23+
### Preparations
24+
1. Install Hadoop and Spark
25+
26+
$ cd [INSTALL_FOLDER]
27+
$ wget http://archive.apache.org/dist/hadoop/core/hadoop-2.6.5/hadoop-2.6.5.tar.gz
28+
$ tar xvfz hadoop-2.6.5.tar.gz
29+
$ wget http://archive.apache.org/dist/spark/spark-2.1.0/spark-2.1.0-bin-hadoop2.6.tgz
30+
$ tar xvfz spark-2.1.0-bin-hadoop2.6.tgz
31+
32+
Note: [INSTALL_FOLDER] means the folder installed for Spark, Hadoop and GridDB connector for Spark.
33+
34+
2. Please add the following environment variables to .bashrc
35+
36+
$ vi ~/.bashrc
37+
export JAVA_HOME=/usr/lib/jvm/[JDK folder]
38+
export HADOOP_HOME=[INSTALL_FOLDER]/hadoop-2.6.5
39+
export SPARK_HOME=[INSTALL_FOLDER]/spark-2.1.0-bin-hadoop2.6
40+
export GRIDDB_SPARK=[INSTALL_FOLDER]/griddb_spark
41+
export GRIDDB_SPARK_PROPERTIES=$GRIDDB_SPARK/gd-config.xml
42+
43+
export PATH=$HADOOP_HOME/sbin:$HADOOP_HOME/bin:$SPARK_HOME/bin:$PATH
44+
45+
export HADOOP_COMMON_LIB_NATIVE_DIR=$HADOOP_HOME/lib/native
46+
export HADOOP_OPTS="$HADOOP_OPTS -Djava.library.path=$HADOOP_HOME/lib/native"
47+
48+
$ source ~/.bashrc
49+
50+
3. Please modify file "gd-config.xml"
51+
52+
$ cd [INSTALL_FOLDER]/griddb_spark
53+
$ vi gd-config.xml
54+
55+
<!-- GridDB properties -->
56+
<property>
57+
<name>gs.user</name>
58+
<value>[GridDB user]</value>
59+
</property>
60+
<property>
61+
<name>gs.password</name>
62+
<value>[GridDB password]</value>
63+
</property>
64+
<property>
65+
<name>gs.cluster.name</name>
66+
<value>[GridDB cluster name]</value>
67+
</property>
68+
<!-- Define address and port for multicast method, leave it blank if using other method -->
69+
<property>
70+
<name>gs.notification.address</name>
71+
<value>[GridDB notification address(default is 239.0.0.1)]</value>
72+
</property>
73+
<property>
74+
<name>gs.notification.port</name>
75+
<value>[GridDB notification port(default is 31999)]</value>
76+
</property>
77+
78+
Please refer to [Configuration](Configuration.md) for GridDB properties.
79+
80+
4. Build a GridDB Java client and a GridDB connector for Hadoop MapReduce,
81+
place the following files under the griddb_spark/gs-spark-datasource/lib directory.
82+
83+
gridstore.jar
84+
gs-hadoop-mapreduce-client-1.0.0.jar
85+
86+
5. Add SPARK_CLASSPATH to "spark-env.sh"
87+
88+
$ cd [INSTALL_FOLDER]/spark-2.1.0-bin-hadoop2.6
89+
$ vi conf/spark-env.sh
90+
SPARK_CLASSPATH=.:$GRIDDB_SAPRK/gs-spark-datasource/target/gs-spark-datasource.jar:
91+
$GRIDDB_SAPRK/gs-spark-datasource/lib/gridstore.jar:
92+
$GRIDDB_SAPRK/gs-spark-datasource/lib/gs-hadoop-mapreduce-client-1.0.0.jar
93+
94+
### Build the connector and an example
95+
96+
Run the mvn command like the following:
97+
98+
$ cd [INSTALL_FOLDER]/griddb_spark
99+
$ mvn package
100+
101+
and create the following jar files.
102+
103+
gs-spark-datasource/target/gs-spark-datasource.jar
104+
gs-spark-datasource-example/target/example.jar
105+
106+
### Run the example program
107+
108+
GridDB cluster needs to be started in advance.
109+
110+
1. Put data to server with GridDB Java client
111+
112+
$ cd [INSTALL_FOLDER]/griddb_spark
113+
$ java -cp ./gs-spark-datasource-example/target/example.jar:gs-spark-datasource/lib/gridstore.jar
114+
Init <GridDB notification address> <GridDB notification port>
115+
<GridDB cluster name> <GridDB user> <GridDB password>
116+
117+
2. Run some queries with GridDB connector for Spark
118+
119+
$ spark-submit --class Query ./gs-spark-datasource-example/target/example.jar
120+
121+
## API
122+
123+
With a SparkSession, applications can create DataFrames from an existing GridDB container in the form as bellow.
124+
125+
var df = session.read.format("com.toshiba.mwcloud.gs.spark.datasource").load(containerName)
126+
127+
## Community
128+
129+
* Issues
130+
Use the GitHub issue function if you have any requests, questions, or bug reports.
131+
* PullRequest
132+
Use the GitHub pull request function if you want to contribute code.
133+
You'll need to agree GridDB Contributor License Agreement(CLA_rev1.1.pdf).
134+
By using the GitHub pull request function, you shall be deemed to have agreed to GridDB Contributor License Agreement.
135+
136+
## License
137+
138+
The GridDB connector source is licensed under the Apache License, version 2.0.
139+
140+
## Trademarks
141+
142+
Apache Spark, Apache Hadoop, Spark, and Hadoop are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.

0 commit comments

Comments
 (0)