Skip to content

Commit 8b09136

Browse files
author
Achim Brandt
committed
Conflicts: README.md pom.xml
2 parents acac295 + f48f4ac commit 8b09136

14 files changed

+476
-15
lines changed

LICENSE

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

README.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,33 @@
11

22
This library is a Java driver for ArangoDB.
33

4-
Supported version: ArangoDB-2.4.x
4+
Supported version: ArangoDB-2.4.x or ArangoDB 2.5.x
55

66
# Required
77

8-
* [ArangoDB](https://github.com/triAGENS/ArangoDB) version 2.4.x
8+
* [ArangoDB](https://github.com/arangodb/arangodb) version 2.4.x or 2.5.x
99
* Java 1.6 later
1010

1111

1212
# Basics
1313

1414
## Maven
1515

16-
To add the driver to your project with maven, add the following code to your pom.xml:
16+
To add the driver to your project with maven, add the following code to your pom.xml
17+
(please use a driver with a version number compatible to your ArangoDB server's version):
1718

1819
```XML
1920
<dependencies>
2021
<dependency>
2122
<groupId>com.arangodb</groupId>
2223
<artifactId>arangodb-java-driver</artifactId>
23-
<version>[2.4.2-SNAPSHOT,2.4.2]</version>
24+
<version>[2.5.3-SNAPSHOT,2.5.3]</version>
2425
</dependency>
2526
....
2627
</dependencies>
2728
```
2829

29-
If you want to test with a snapshot version (e.g. 2.4.2-SNAPSHOT), add the staging repository of oss.sonatype.org to your pom.xml:
30+
If you want to test with a snapshot version (e.g. 2.5.3-SNAPSHOT), add the staging repository of oss.sonatype.org to your pom.xml:
3031

3132
```XML
3233
<repositories>
@@ -287,7 +288,7 @@ A graph consists of vertices and edges (stored in collections). Which collection
287288
// and add one or more collections
288289
from.add("myCollection1");
289290
from.add("myCollection2");
290-
edgeDefinition.setFrom(from)
291+
edgeDefinition.setFrom(from);
291292

292293
// repeat this for the collections where an edge is going into
293294
List<String> to = new ArrayList<String>();
@@ -349,13 +350,13 @@ Now an edge can be created to set a relation between vertices
349350
null);
350351
```
351352

352-
# What's new in 2.4
353+
# What's new in 2.4 / 2.5
353354

354355
## since 2.4.1
355-
* httpclient version 4.3.6
356+
httpclient version 4.3.6
356357

357358
## since 2.4.2
358-
* Fixed issue#2
359+
Fixed issue#2
359360

360361
## since 2.4.3
361362
* Fixed a graph bug: when retrieving a graph via the driver, "from" and "to" were emtpy. This is fixed now.
@@ -373,4 +374,8 @@ Now an edge can be created to set a relation between vertices
373374
* fixed issue #6
374375
* fixed issue #7
375376

377+
## since 2.5.0
378+
Added support for sparse indexes
376379

380+
## since 2.5.1
381+
see 2.4.4

pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<groupId>com.arangodb</groupId>
66
<artifactId>arangodb-java-driver</artifactId>
7-
<version>2.4.4</version>
7+
<version>2.5.3-SNAPSHOT</version>
88
<inceptionYear>2012</inceptionYear>
99
<packaging>jar</packaging>
1010

src/main/java/com/arangodb/ArangoDriver.java

+61
Original file line numberDiff line numberDiff line change
@@ -1992,6 +1992,22 @@ public IndexEntity createIndex(long collectionId, IndexType type, boolean unique
19921992
throws ArangoException {
19931993
return createIndex(String.valueOf(collectionId), type, unique, fields);
19941994
}
1995+
1996+
/**
1997+
* This method creates an index for a collection.
1998+
*
1999+
* @param collectionId The collection id.
2000+
* @param type the index type.
2001+
* @param unique if set to true the index will be a unique index
2002+
* @param sparse if set to true the index will be sparse
2003+
* @param fields the fields (document attributes) the index is created on
2004+
* @return IndexEntity
2005+
* @throws ArangoException
2006+
*/
2007+
public IndexEntity createIndex(long collectionId, IndexType type, boolean unique, boolean sparse, String... fields)
2008+
throws ArangoException {
2009+
return createIndex(String.valueOf(collectionId), type, unique, sparse, fields);
2010+
}
19952011

19962012
/**
19972013
* This method creates an index for a collection.
@@ -2007,6 +2023,22 @@ public IndexEntity createIndex(String collectionName, IndexType type, boolean un
20072023
throws ArangoException {
20082024
return indexDriver.createIndex(getDefaultDatabase(), collectionName, type, unique, fields);
20092025
}
2026+
2027+
/**
2028+
* This method creates an index for a collection.
2029+
*
2030+
* @param collectionName The collection name.
2031+
* @param type the index type.
2032+
* @param unique if set to true the index will be a unique index
2033+
* @param sparse if set to true the index will be sparse
2034+
* @param fields the fields (document attributes) the index is created on
2035+
* @return IndexEntity
2036+
* @throws ArangoException
2037+
*/
2038+
public IndexEntity createIndex(String collectionName, IndexType type, boolean unique, boolean sparse, String... fields)
2039+
throws ArangoException {
2040+
return indexDriver.createIndex(getDefaultDatabase(), collectionName, type, unique, sparse, fields);
2041+
}
20102042

20112043
/**
20122044
* This method creates a hash index for a collection.
@@ -2020,6 +2052,20 @@ public IndexEntity createIndex(String collectionName, IndexType type, boolean un
20202052
public IndexEntity createHashIndex(String collectionName, boolean unique, String... fields) throws ArangoException {
20212053
return indexDriver.createIndex(getDefaultDatabase(), collectionName, IndexType.HASH, unique, fields);
20222054
}
2055+
2056+
/**
2057+
* This method creates a hash index for a collection.
2058+
*
2059+
* @param collectionName The collection name.
2060+
* @param unique if set to true the index will be a unique index
2061+
* @param sparse if set to true the index will be sparse
2062+
* @param fields the fields (document attributes) the index is created on
2063+
* @return IndexEntity
2064+
* @throws ArangoException
2065+
*/
2066+
public IndexEntity createHashIndex(String collectionName, boolean unique, boolean sparse, String... fields) throws ArangoException {
2067+
return indexDriver.createIndex(getDefaultDatabase(), collectionName, IndexType.HASH, unique, sparse, fields);
2068+
}
20232069

20242070
/**
20252071
* This method creates a geo index for a collection.
@@ -2047,6 +2093,21 @@ public IndexEntity createSkipListIndex(String collectionName, boolean unique, St
20472093
throws ArangoException {
20482094
return indexDriver.createIndex(getDefaultDatabase(), collectionName, IndexType.SKIPLIST, unique, fields);
20492095
}
2096+
2097+
/**
2098+
* This method creates a skip list index for a collection.
2099+
*
2100+
* @param collectionName The collection name.
2101+
* @param unique if set to true the index will be a unique index
2102+
* @param sparse if set to true the index will be sparse
2103+
* @param fields the fields (document attributes) the index is created on
2104+
* @return IndexEntity
2105+
* @throws ArangoException
2106+
*/
2107+
public IndexEntity createSkipListIndex(String collectionName, boolean unique, boolean sparse, String... fields)
2108+
throws ArangoException {
2109+
return indexDriver.createIndex(getDefaultDatabase(), collectionName, IndexType.SKIPLIST, unique, sparse, fields);
2110+
}
20502111

20512112
/**
20522113
* This method creates a capped index for a collection.

src/main/java/com/arangodb/InternalIndexDriver.java

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
* Created by fbartels on 10/27/14.
1010
*/
1111
public interface InternalIndexDriver extends BaseDriverInterface {
12+
IndexEntity createIndex(String database, String collectionName, IndexType type, boolean unique, boolean sparse, String... fields) throws ArangoException;
13+
1214
IndexEntity createIndex(String database, String collectionName, IndexType type, boolean unique, String... fields) throws ArangoException;
1315

1416
IndexEntity createCappedIndex(String database, String collectionName, int size) throws ArangoException;

0 commit comments

Comments
 (0)