-
Notifications
You must be signed in to change notification settings - Fork 590
feat: support query data by use cypher language #1866
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
93 changes: 93 additions & 0 deletions
93
hugegraph-api/src/main/java/com/baidu/hugegraph/api/gremlin/CypherAPI.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| package com.baidu.hugegraph.api.gremlin; | ||
|
|
||
| import org.opencypher.gremlin.translation.TranslationFacade; | ||
| import org.slf4j.Logger; | ||
|
|
||
| import com.baidu.hugegraph.api.filter.CompressInterceptor; | ||
| import com.baidu.hugegraph.util.E; | ||
| import com.baidu.hugegraph.util.Log; | ||
| import com.codahale.metrics.annotation.Timed; | ||
|
|
||
| import jakarta.inject.Singleton; | ||
| import jakarta.ws.rs.Consumes; | ||
| import jakarta.ws.rs.GET; | ||
| import jakarta.ws.rs.POST; | ||
| import jakarta.ws.rs.Path; | ||
| import jakarta.ws.rs.PathParam; | ||
| import jakarta.ws.rs.Produces; | ||
| import jakarta.ws.rs.QueryParam; | ||
| import jakarta.ws.rs.core.Context; | ||
| import jakarta.ws.rs.core.HttpHeaders; | ||
| import jakarta.ws.rs.core.Response; | ||
|
|
||
| @Path("graphs/{graph}/cypher") | ||
| @Singleton | ||
| public class CypherAPI extends GremlinQueryAPI { | ||
|
|
||
| private static final Logger LOG = Log.logger(CypherAPI.class); | ||
|
|
||
|
|
||
| @GET | ||
| @Timed | ||
| @CompressInterceptor.Compress(buffer = (1024 * 40)) | ||
| @Produces(APPLICATION_JSON_WITH_CHARSET) | ||
| public Response query(@PathParam("graph") String graph, | ||
| @Context HttpHeaders headers, | ||
| @QueryParam("cypher") String cypher) { | ||
| LOG.debug("Graph [{}] query by cypher: {}", graph, cypher); | ||
|
|
||
| return this.queryByCypher(graph, headers, cypher); | ||
| } | ||
|
|
||
| @POST | ||
| @Timed | ||
| @CompressInterceptor.Compress | ||
| @Consumes(APPLICATION_JSON) | ||
| @Produces(APPLICATION_JSON_WITH_CHARSET) | ||
| public Response post(@PathParam("graph") String graph, | ||
| @Context HttpHeaders headers, | ||
| String cypher) { | ||
| LOG.debug("Graph [{}] query by cypher: {}", graph, cypher); | ||
| return this.queryByCypher(graph, headers, cypher); | ||
| } | ||
|
|
||
| private Response queryByCypher(String graph, | ||
| HttpHeaders headers, | ||
| String cypher) { | ||
| E.checkArgument(cypher != null && !cypher.isEmpty(), | ||
| "The cypher parameter can't be null or empty"); | ||
|
|
||
| String gremlin = this.translateCpyher2Gremlin(graph, cypher); | ||
| LOG.debug("translated gremlin is {}", gremlin); | ||
|
|
||
| String auth = headers.getHeaderString(HttpHeaders.AUTHORIZATION); | ||
| String request = "{" | ||
| + "\"gremlin\":\"" + gremlin + "\"," | ||
| + "\"bindings\":{}," | ||
| + "\"language\":\"gremlin-groovy\"," | ||
| + "\"aliases\":{\"g\":\"__g_" + graph + "\"}}"; | ||
|
|
||
| Response response = this.client().doPostRequest(auth, request); | ||
| return transformResponseIfNeeded(response); | ||
| } | ||
|
|
||
| private String translateCpyher2Gremlin(String graph, String cypher) { | ||
| TranslationFacade translator = new TranslationFacade(); | ||
| String gremlin = translator.toGremlinGroovy(cypher); | ||
| gremlin = this.buildQueryableGremlin(graph, gremlin); | ||
| return gremlin; | ||
| } | ||
|
|
||
| private String buildQueryableGremlin(String graph, String gremlin) { | ||
| /* | ||
| * `CREATE (a:person { name : 'test', age: 20) return a` | ||
| * would be translated to: | ||
| * `g.addV('person').as('a').property(single, 'name', 'test') ...`, | ||
| * but hugegraph don't support `.property(single, k, v)`, | ||
| * so we replace it to `.property(k, v)` here | ||
| */ | ||
| gremlin = gremlin.replace(".property(single,", ".property("); | ||
|
|
||
| return gremlin; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
90 changes: 90 additions & 0 deletions
90
hugegraph-api/src/main/java/com/baidu/hugegraph/api/gremlin/GremlinQueryAPI.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| package com.baidu.hugegraph.api.gremlin; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Set; | ||
|
|
||
| import com.baidu.hugegraph.api.API; | ||
| import com.baidu.hugegraph.config.HugeConfig; | ||
| import com.baidu.hugegraph.config.ServerOptions; | ||
| import com.baidu.hugegraph.exception.HugeGremlinException; | ||
| import com.google.common.collect.ImmutableMap; | ||
| import com.google.common.collect.ImmutableSet; | ||
|
|
||
| import jakarta.inject.Provider; | ||
| import jakarta.ws.rs.core.Context; | ||
| import jakarta.ws.rs.core.HttpHeaders; | ||
| import jakarta.ws.rs.core.MediaType; | ||
| import jakarta.ws.rs.core.Response; | ||
|
|
||
| public class GremlinQueryAPI extends API { | ||
|
|
||
| private static final Set<String> FORBIDDEN_REQUEST_EXCEPTIONS = | ||
| ImmutableSet.of("java.lang.SecurityException", | ||
| "jakarta.ws.rs.ForbiddenException"); | ||
| private static final Set<String> BAD_REQUEST_EXCEPTIONS = ImmutableSet.of( | ||
| "java.lang.IllegalArgumentException", | ||
| "java.util.concurrent.TimeoutException", | ||
| "groovy.lang.", | ||
| "org.codehaus.", | ||
| "com.baidu.hugegraph." | ||
| ); | ||
|
|
||
| @Context | ||
| private Provider<HugeConfig> configProvider; | ||
|
|
||
| private GremlinClient client; | ||
|
|
||
| public GremlinClient client() { | ||
| if (this.client != null) { | ||
| return this.client; | ||
| } | ||
| HugeConfig config = this.configProvider.get(); | ||
| String url = config.get(ServerOptions.GREMLIN_SERVER_URL); | ||
| int timeout = config.get(ServerOptions.GREMLIN_SERVER_TIMEOUT) * 1000; | ||
| int maxRoutes = config.get(ServerOptions.GREMLIN_SERVER_MAX_ROUTE); | ||
| this.client = new GremlinClient(url, timeout, maxRoutes, maxRoutes); | ||
| return this.client; | ||
| } | ||
|
|
||
| protected static Response transformResponseIfNeeded(Response response) { | ||
| MediaType mediaType = response.getMediaType(); | ||
| if (mediaType != null) { | ||
| // Append charset | ||
| assert MediaType.APPLICATION_JSON_TYPE.equals(mediaType); | ||
| response.getHeaders().putSingle(HttpHeaders.CONTENT_TYPE, | ||
| mediaType.withCharset(CHARSET)); | ||
| } | ||
|
|
||
| Response.StatusType status = response.getStatusInfo(); | ||
| if (status.getStatusCode() < 400) { | ||
| // No need to transform if normal response without error | ||
| return response; | ||
| } | ||
|
|
||
| if (mediaType == null || !JSON.equals(mediaType.getSubtype())) { | ||
| String message = response.readEntity(String.class); | ||
| throw new HugeGremlinException(status.getStatusCode(), | ||
| ImmutableMap.of("message", message)); | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| Map<String, Object> map = response.readEntity(Map.class); | ||
| String exClassName = (String) map.get("Exception-Class"); | ||
| if (FORBIDDEN_REQUEST_EXCEPTIONS.contains(exClassName)) { | ||
| status = Response.Status.FORBIDDEN; | ||
| } else if (matchBadRequestException(exClassName)) { | ||
| status = Response.Status.BAD_REQUEST; | ||
| } | ||
| throw new HugeGremlinException(status.getStatusCode(), map); | ||
| } | ||
|
|
||
| private static boolean matchBadRequestException(String exClass) { | ||
| if (exClass == null) { | ||
| return false; | ||
| } | ||
| if (BAD_REQUEST_EXCEPTIONS.contains(exClass)) { | ||
| return true; | ||
| } | ||
| return BAD_REQUEST_EXCEPTIONS.stream().anyMatch(exClass::startsWith); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.