说明： 我们正在反对Spring Data Gremlin。——提供通用的面向注释的编程表单基础... (We are in the process of deprecating Spring Data Gremlin. -- Provide generic annotation oriented programming form based on gremlin for graph database)
[ ](https://github.com/Microsoft/spring-data-gremlin/blob/master/LICENSE)
[](https://travis-ci.org/Microsoft/spring-data-gremlin)
[](https://codecov.io/gh/Microsoft/spring-data-gremlin)
:exclamation::exclamation::exclamation:
We have **deprecated** Spring Data Gremlin. We recommend that you use the TinkerPop driver to [query Cosmos DB with Gremlin API](https://docs.microsoft.com/en-us/azure/cosmos-db/create-graph-gremlin-console) or use [azure-spring-boot-starter-cosmos](https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/spring/azure-spring-boot-starter-cosmos) to query Cosmos DB with Spring Data SQL API. If you would like us to continue supporting Spring Data Gremlin, please tell us how you are using Spring Data Gremlin for Cosmos DB and how important it is to you, by voting on this [issue](https://github.com/Azure/azure-sdk-for-java/issues/24773) with the thumbs up emoji.
# Spring Data Gremlin
**Spring Data Gremlin** provides initial Spring Data support for those databases using Gremlin query language. With annotation oriented programming model, it simplified the mapping to the database entity. It also provides supports for basic and custom query.
This project works with *any Gremlin-compatible* data store, and also with [Azure Cosmos DB](https://docs.microsoft.com/en-us/azure/cosmos-db/introduction). Cosmos is a globally-distributed database service that allows developers to work with data using a variety of standard APIs, such as Graph, MongoDB, and SQL. Spring Data Gremlin provides a delightful experience to interact with Azure Cosmos DB Graph API.
## Spring Data Version Support
Version mapping between spring boot and spring-data-gremlin:
| Spring boot version | spring-data-gremlin version |
|:-----------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|  | [](https://search.maven.org/search?q=g:com.microsoft.spring.data.gremlin%20AND%20a:spring-data-gremlin%20AND%20v:2.3.*) |
|  | [](https://search.maven.org/search?q=g:com.microsoft.spring.data.gremlin%20AND%20a:spring-data-gremlin%20AND%20v:2.2.*) |
|  | [](https://search.maven.org/search?q=g:com.microsoft.spring.data.gremlin%20AND%20a:spring-data-gremlin%20AND%20v:2.1.*) |
|  | [](https://search.maven.org/search?q=g:com.microsoft.spring.data.gremlin%20AND%20a:spring-data-gremlin%20AND%20v:2.0.*) |
## TOC
* [Welcome to Contribute](#welcome-to-contribute)
* [Sample Code](#sample-code)
* [Spring data version support](#spring-data-version-support)
* [Feature List](#feature-list)
* [Quick Start](#quick-start)
* [Filing Issues](#filing-issues)
* [Code of Conduct](#code-of-conduct)
## Welcome To Contribute
Contribution is welcome. Please follow [this instruction](./CONTRIBUTING.md) to contribute code.
## Sample Code
Please refer to [sample project here](./examples/example/).
## Spring data version support
This repository only supports Spring Data 2.x.
## Feature List
- Spring Data CRUDRepository basic CRUD functionality
- save
- findAll
- findById
- deleteAll
- deleteById
- Spring Data [@Id](https://github.com/spring-projects/spring-data-commons/blob/db62390de90c93a78743c97cc2cc9ccd9***994a5/src/main/java/org/springframework/data/annotation/Id.java) annotation.
There're 2 ways to map a field in domain class to `id` field of a database entity.
- annotate a field in domain class with `@Id`
- set name of this field to `id`
- Default annotaion
- ```@Vertex``` maps an ```Object``` to a ```Vertex```
- ```@VertexSet``` maps a set of ```Vertex```
- ```@Edge``` maps an ```Object``` to an ```Edge```
- ```@EdgeSet``` maps to a set of ```Edge```
- ```@EdgeFrom``` maps to the head ```Vertex``` of an ```Edge```
- ```@EdgeTo``` maps to the tail ```Vertex``` of an ```Edge```
- ```@Graph``` maps to an ```Object``` to a ```Graph```
- Supports advanced operations
- ``` T findVertexById(Object id, Class domainClass);```
- ``` T findEdgeById(Object id, Class domainClass);```
- ``` boolean isEmptyGraph(T object)```
- ```long vertexCount()```
- ```long edgeCount()```
- Supports [Spring Data custom query](https://docs.spring.io/spring-data/commons/docs/current/reference/html/#repositories.query-methods.details) find operation, e.g., `findByAFieldAndBField`
- Supports any class type in domain class including collection and nested type.
## Quick Start
### Add the dependency
`spring-data-gremlin` is published on Maven Central Repository.
If you are using Maven, add the following dependency.
```xml
com.microsoft.spring.data.gremlinspring-data-gremlin2.1.7
```
### Setup Configuration
Setup ```application.yml``` file.(Use Azure Cosmos DB Graph as an example.)
```
gremlin:
endpoint: url-of-endpoint
port: 443
username: /dbs/your-db-name/colls/your-collection-name
password: your-password
telemetryAllowed: true # set false to disable telemetry
```
### Define an entity
Define a simple Vertex entity with ```@Vertex```.
```
@Vertex
public class Person {
@Id
private String id;
private String name;
private String age;
...
}
```
Define a simple Edge entity with ```@Edge```.
```
@Edge
public class Relation {
@Id
private String id;
private String name;
@EdgeFrom
private Person personFrom;
@EdgeTo
private Person personTo;
...
}
```
Define a simple Graph entity with ```@Graph```.
```
@Graph
public class Network {
@Id
private String id;
public Network() {
this.edges = new ArrayList