| //// |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You 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 |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| //// |
| == TinkerPop3 |
| image:https://img.shields.io/maven-central/v/org.apache.tinkerpop/gremlin-driver?color=brightgreen[link="https://mvnrepository.com/artifact/org.apache.tinkerpop/gremlin-driver"] |
| image:https://img.shields.io/nuget/v/Gremlin.Net?color=brightgreen[link="https://www.nuget.org/packages/Gremlin.Net"] |
| image:https://img.shields.io/pypi/v/gremlinpython?color=brightgreen[link="https://pypi.org/project/gremlinpython/"] |
| image:https://img.shields.io/npm/v/gremlin?color=brightgreen[link="https://www.npmjs.com/package/gremlin"] |
| image:https://badge.fury.io/go/github.com%2Fapache%2Ftinkerpop%2Fgremlin-go%2Fv3.svg[link="https://pkg.go.dev/github.com/apache/tinkerpop/gremlin-go/v3"] |
| |
| image:https://codecov.io/gh/apache/tinkerpop/branch/master/graph/badge.svg?token=TojD2nR5Qd[link="https://codecov.io/gh/apache/tinkerpop"] |
| |
| image:https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/images/tinkerpop3-splash.png[TinkerPop3, link="https://tinkerpop.apache.org"] |
| |
| === Documentation |
| |
| Apache TinkerPop™ provides graph computing capabilities for both graph databases (OLTP) and graph analytic systems (OLAP). |
| |
| * link:https://tinkerpop.apache.org/[homepage (downloads)] |
| * link:https://tinkerpop.apache.org/docs/current/reference/[reference documentation] |
| * link:https://tinkerpop.apache.org/javadocs/current/core/[core javadoc] |
| * link:https://tinkerpop.apache.org/javadocs/current/full/[full javadoc] |
| |
| === Building and Testing |
| |
| TinkerPop uses link:https://maven.apache.org/[Maven] and requires `Java 11` for proper building and proper operations. To build, execute unit tests and package Gremlin Console/Server run: |
| |
| [source,bash] |
| mvn clean install |
| |
| Please see the xref:docs/src/dev/developer/development-environment.asciidoc#building-on-windows[Building on Windows] section for Windows specific build instructions. |
| |
| The zip distributions can be found in the following directories: |
| |
| . `gremlin-server/target` |
| . `gremlin-console/target` |
| |
| Please see the link:https://tinkerpop.apache.org/docs/current/dev/developer/#_contributing[CONTRIBUTING.asciidoc] file for more detailed information and options for building, test running and developing TinkerPop. |
| |
| === Get Started |
| |
| Download link:https://tinkerpop.apache.org/download.html[Gremlin Console] (compatible with Java 8/11) and unzip to a directory, then: |
| |
| [source,bash] |
| ---- |
| $ bin/gremlin.sh |
| |
| \,,,/ |
| (o o) |
| -----oOOo-(3)-oOOo----- |
| plugin activated: tinkerpop.server |
| plugin activated: tinkerpop.utilities |
| plugin activated: tinkerpop.tinkergraph |
| gremlin> graph = TinkerFactory.createModern() |
| ==>tinkergraph[vertices:6 edges:6] |
| gremlin> g = traversal().withEmbedded(graph) |
| ==>graphtraversalsource[tinkergraph[vertices:6 edges:6], standard] |
| gremlin> g.V().has('name','vadas').valueMap() |
| ==>[name:[vadas], age:[27]] |
| ---- |
