Skip to content

Commit

Permalink
rename driver to Graph Structure Implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
mpollmeier committed Nov 19, 2015
1 parent e74374c commit 9380715
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

[![Build Status](https://travis-ci.org/mpollmeier/orientdb-gremlin.svg)](https://travis-ci.org/mpollmeier/orientdb-gremlin) [![Coverage Status](https://coveralls.io/repos/mpollmeier/orientdb-gremlin/badge.svg?branch=master)](https://coveralls.io/r/mpollmeier/orientdb-gremlin?branch=master) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.michaelpollmeier/orientdb-gremlin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.michaelpollmeier/orientdb-gremlin/)

TP3 driver for orientdb. This started off as just a proof of concept, but thanks to a lot of help it's now in a really good shape.
TP3 Graph Structure Implementation for OrientDb. This started off as just a proof of concept, but thanks to a lot of help it's now in a really good shape.

The main area that need some more work is index lookups - currently it does find the right index for a simple case, e.g. `g.V.hasLabel("myLabel").has("someKey", "someValue")`. However if there are multiple indexes on the same property, or if there the traversal should better use a composite index, that's not handled well yet. If you feel inclined you can add these cases to the OrientGraphIndexTest.java.

## Tests
* It runs the standard tinkerpop test suite for database drivers.
* there are some additional tests that you can run with `mvn test`
* you can run the standard tinkerpop test suite with `mvn install -P release`
* there are some additional tests that you can run independently with `mvn test`
* additionally there is a separate suite of tests in the `tests-scala` directory which you can run using `sbt test`

## Usage
Have a look at the tests-scala which demonstrates the usage. There's also an orientdb example project in [gremlin-scala-examples](https://github.com/mpollmeier/gremlin-scala-examples).

## Labels and classes
Vertices and Edges are stored as classes based on their label. In order to allow vertices and edges to use the same label, the driver prepends `V_` or `E_` in the class name:
Vertices and Edges are stored as classes based on their label. In order to allow vertices and edges to use the same label, the implementation prepends `V_` or `E_` in the class name:
* vertex with label `user` -> classname `V_user`
* edge with label `user` -> classname `E_user`

Expand Down
2 changes: 1 addition & 1 deletion driver/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<artifactId>orientdb-gremlin</artifactId>
<version>3.0.2.incubating.1-SNAPSHOT</version>
<name>Apache TinkerPop :: OrientDB Gremlin</name>
<description>TinkerPop3 driver for OrientDB</description>
<description>TinkerPop3 Graph Structure Implementation for OrientDB</description>
<url>https://github.com/mpollmeier/orientdb-gremlin/</url>

<properties>
Expand Down

0 comments on commit 9380715

Please sign in to comment.