Neptune 쿼리 API - Amazon Neptune
ExecuteGremlinQueryExecuteGremlinExplainQueryExecuteGremlinProfileQueryListGremlinQueriesGetGremlinQueryStatusCancelGremlinQuery________________________ExecuteOpenCypherQueryExecuteOpenCypherExplainQueryListOpenCypherQueriesGetOpenCypherQueryStatusCancelOpenCypherQuery________________________QueryEvalStatsGremlinQueryStatusGremlinQueryStatusAttributes

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

Neptune 쿼리 API

Gremlin 쿼리 작업:

openCypher 쿼리 작업:

쿼리 구조:

ExecuteGremlinQuery(동작)

        이 API의 AWS CLI 이름은 execute-gremlin-query입니다.

이 명령은 Gremlin 쿼리를 실행합니다. Amazon Neptune은 Apache TinkerPop3 및 Gremlin과 호환되므로 Apache TinkerPop3 설명서의 그래프에 설명된 대로 Gremlin 순회 언어를 사용하여 그래프를 쿼리할 수 있습니다. Gremlin을 사용하여 Neptune 그래프에 액세스하기에서도 자세한 내용을 확인할 수 있습니다.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할은 쿼리에 따라 해당 클러스터에서 다음 IAM 작업 중 하나를 활성화하는 정책을 연결해야 합니다.

참고로 정책 문서에서는 Neptune-DB:querylanguage:Gremlin IAM 조건 키를 사용하여 Gremlin 쿼리의 사용을 제한할 수 있습니다(Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조).

요청

  • gremlinQuery(CLI의 경우: --gremlin-query) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 API를 사용하면 HTTP 엔드포인트를 사용할 때와 마찬가지로 문자열 형식으로 Gremlin 쿼리를 실행할 수 있습니다. 인터페이스는 DB 클러스터가 사용하는 모든 Gremlin 버전과 호환됩니다(엔진 버전에서 지원하는 Gremlin 릴리스를 확인하려면 Tinkerpop 클라이언트 섹션 참조).

  • serializer(CLI의 경우: --serializer) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    null이 아니면 쿼리 결과가 직렬화된 응답 메시지에서 이 파라미터가 지정한 형식으로 반환됩니다. 현재 지원되는 형식 목록은 TinkerPop 문서의 GraphSon 섹션을 참조하세요.

응답

  • meta – Document, 유형은 document(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.

    Gremlin 쿼리에 대한 메타데이터입니다.

  • requestId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Gremlin 쿼리의 고유 식별자입니다.

  • result – Document, 유형은 document(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.

    서버에서 출력되는 Gremlin 쿼리입니다.

  • status – GremlinQueryStatusAttributes 객체입니다.

    Gremlin 쿼리의 상태입니다.

오류

ExecuteGremlinExplainQuery(동작)

        이 API의 AWS CLI 이름은 execute-gremlin-explain-query입니다.

Gremlin Explain 쿼리를 실행합니다.

Amazon Neptune은 Neptune 엔진이 쿼리에 사용하는 실행 방식을 이해하기 위한 셀프 서비스 도구를 제공하는 explain이라는 Gremlin 기능을 추가했습니다. Gremlin 쿼리를 제출하는 HTTP 호출에 explain 파라미터를 추가하여 이 도구를 호출합니다.

Explain 기능은 쿼리 실행 계획의 논리 구조에 대한 정보를 제공합니다. Gremlin 쿼리 조정에 설명된 대로 이 정보를 사용하여 잠재적 평가 및 실행 병목 현상을 식별하고 쿼리를 조정할 수 있습니다. 그런 다음 쿼리 힌트를 사용하여 쿼리 실행 계획을 개선할 수 있습니다.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할은 쿼리에 따라 해당 클러스터에서 다음 IAM 작업 중 하나를 허용하는 정책을 연결해야 합니다.

참고로 정책 문서에서는 neptune-db:QueryLanguage:Gremlin IAM 조건 키를 사용하여 Gremlin 쿼리의 사용을 제한할 수 있습니다(Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조).

요청

  • gremlinQuery(CLI의 경우: --gremlin-query) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Gremlin Explain 쿼리 문자열입니다.

응답

  • output - ReportAsText, 형식은 blob(해석되지 않은 바이너리 데이터 블록)입니다.

    Gremlin 쿼리 조정에 설명된 대로 Gremlin Explain 결과를 포함하는 텍스트 블롭입니다.

오류

ExecuteGremlinProfileQuery(동작)

        이 API의 AWS CLI 이름은 execute-gremlin-profile-query입니다.

Executes a Gremlin Profile 쿼리는 지정된 Gremlin 순회를 실행하고 해당 실행에 대한 다양한 지표를 수집하여 출력 지표로서 프로파일 보고서를 만듭니다. 자세한 내용은 Neptune의 Gremlin 프로필 API를 참조하세요.

IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 neptune-db:ReadDataViaQuery IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

참고로 정책 문서에서는 neptune-db:QueryLanguage:Gremlin IAM 조건 키를 사용하여 Gremlin 쿼리의 사용을 제한할 수 있습니다(Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조).

요청

  • chop(CLI의 경우: --chop) - Integer, 유형은 integer(32비트 부호 있는 정수)입니다.

    0으로 설정되어 있지 않으면 결과 문자열이 해당되는 문자 수에서 잘립니다. 0으로 설정되어 있으면 문자열에 모든 결과가 포함됩니다.

  • gremlinQuery(CLI의 경우: --gremlin-query) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    프로파일링할 Gremlin 쿼리 문자열입니다.

  • indexOps(CLI의 경우: --index-ops) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    플래그가 TRUE이면 쿼리 실행 및 직렬화 동안 수행된 모든 인덱스 작업에 대한 세부 보고서가 표시됩니다.

  • results(CLI의 경우: --results) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    플래그가 TRUE이면 프로파일 보고서의 일부로 수집 및 표시됩니다. FALSE인 경우에는 결과 수만 표시됩니다.

  • serializer(CLI의 경우: --serializer) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    null이 아니면 수집된 결과가 직렬화된 응답 메시지에서 이 파라미터가 지정한 형식으로 반환됩니다. 자세한 내용은 Neptune의 Gremlin 프로필 API를 참조하세요.

응답

  • output - ReportAsText, 형식은 blob(해석되지 않은 바이너리 데이터 블록)입니다.

    Gremlin 프로필 결과를 포함하는 텍스트 블롭입니다. 자세한 내용은 Neptune의 Gremlin 프로필 API를 참조하세요.

오류

ListGremlinQueries(동작)

        이 API의 AWS CLI 이름은 list-gremlin-queries입니다.

활성 Gremlin 쿼리를 나열합니다. 출력에 대한 자세한 내용은 Gremlin 쿼리 상태 API를 참조하세요.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 Neptune-db:GetQueryStatus IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

참고로 정책 문서에서는 neptune-db:QueryLanguage:Gremlin IAM 조건 키를 사용하여 Gremlin 쿼리의 사용을 제한할 수 있습니다(Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조).

요청

  • includeWaiting(CLI의 경우: --include-waiting) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    TRUE로 설정하면 반환되는 목록에 대기 중인 쿼리가 포함됩니다. 기본값은 FALSE입니다.

응답

  • acceptedQueryCount - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    대기열에 있는 쿼리를 포함하여 수락되었지만 아직 완료되지 않은 쿼리 수입니다.

  • queries – GremlinQueryStatus 객체의 배열입니다.

    현재 쿼리의 목록입니다.

  • runningQueryCount - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    현재 실행 중인 Gremlin 쿼리의 수입니다.

오류

GetGremlinQueryStatus(동작)

        이 API의 AWS CLI 이름은 get-gremlin-query-status입니다.

지정된 Gremlin 쿼리의 상태를 가져옵니다.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 Neptune-db:GetQueryStatus IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

참고로 정책 문서에서는 neptune-db:QueryLanguage:Gremlin IAM 조건 키를 사용하여 Gremlin 쿼리의 사용을 제한할 수 있습니다(Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조).

요청

  • queryId(CLI의 경우: --query-id) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Gremlin 쿼리를 식별하는 고유 식별자입니다.

응답

  • queryEvalStats – QueryEvalStats 객체입니다.

    그렘린 쿼리의 평가 상태입니다.

  • queryId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    상태가 반환되는 쿼리의 ID입니다.

  • queryString - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Gremlin 쿼리 문자열입니다.

오류

CancelGremlinQuery(동작)

        이 API의 AWS CLI 이름은 cancel-gremlin-query입니다.

Gremlin 쿼리를 취소합니다. 자세한 내용은 Gremlin 쿼리 취소를 참조하세요.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 Neptune-DB:cancelQuery IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

요청

  • queryId(CLI의 경우: --query-id) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    취소할 쿼리를 식별하는 고유 식별자입니다.

응답

  • status - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    취소의 상태

오류

openCypher 쿼리 작업:

ExecuteOpenCypherQuery(동작)

        이 API의 AWS CLI 이름은 execute-open-cypher-query입니다.

openCypher 쿼리를 실행합니다. 자세한 내용은 openCypher를 사용하여 Neptune 그래프에 액세스하기를 참조하세요.

Neptune은 현재 그래프 데이터베이스를 사용하는 개발자들 사이에서 가장 많이 사용되는 쿼리 언어 중 하나인 openCypher를 사용한 그래프 애플리케이션 구축을 지원합니다. 개발자, 비즈니스 분석가, 데이터 과학자는 openCypher의 SQL에서 영감을 받은 선언적 구문을 좋아합니다. 속성 그래프를 쿼리하는 데 익숙한 구조를 제공하기 때문입니다.

openCypher 언어는 원래 Neo4j가 개발한 후 2015년에 오픈 소스로 제공되었으며 Apache 2 오픈 소스 라이선스에 따라 openCypher 프로젝트에 기여했습니다.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할은 쿼리에 따라 해당 클러스터에서 다음 IAM 작업 중 하나를 허용하는 정책을 연결해야 합니다.

또한 정책 문서에서 Neptune-DB:QueryLanguage:OpenCypher IAM 조건 키를 사용하여 OpenCypher 쿼리 사용을 제한할 수 있습니다(Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조).

요청

  • openCypherQuery(CLI의 경우: --open-cypher-query) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    실행할 openCypher 쿼리 문자열입니다.

  • parameters(CLI의 경우: --parameters) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    쿼리 실행을 위한 OpenCypher 쿼리 파라미터입니다. 자세한 내용은 OpenCypher 파라미터화된 쿼리의 예를 참조하세요.

응답

  • results - 필수: Document, 유형은 document(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.

    openCypherquery 결과입니다.

오류

ExecuteOpenCypherExplainQuery(동작)

        이 API의 AWS CLI 이름은 execute-open-cypher-explain-query입니다.

openCypher explain 요청을 실행합니다. 자세한 내용은 OpenCypher 설명 기능을 참조하세요.

IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 neptune-db:ReadDataViaQuery IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

참고로 정책 문서에서는 neptune-db:QueryLanguage:OpenCypher IAM 조건 키를 사용하여 OpenCypher 쿼리 사용을 제한할 수 있습니다(Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조).

요청

  • explainMode(CLI의 경우: --explain-mode) - 필수: OpenCypherExplainMode, 유형은 string(UTF-8 인코딩 문자열)입니다.

    openCypher explain 모드입니다. static, dynamic 또는 details 중 하나일 수 있습니다.

  • openCypherQuery(CLI의 경우: --open-cypher-query) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    OpenCypher 쿼리 문자열입니다.

  • parameters(CLI의 경우: --parameters) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    OpenCypher 쿼리 파라미터입니다.

응답

  • results - 필수: Blob, 유형은 blob(해석되지 않은 바이너리 데이터 블록)입니다.

    OpenCypher explain 결과를 포함하는 텍스트 블롭입니다.

오류

ListOpenCypherQueries(동작)

        이 API의 AWS CLI 이름은 list-open-cypher-queries입니다.

활성 OpenCypher 쿼리를 나열합니다. 자세한 내용은 Neptune OpenCypher 상태 엔드포인트를 참조하세요.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 Neptune-db:GetQueryStatus IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

참고로 정책 문서에서는 neptune-db:QueryLanguage:OpenCypher IAM 조건 키를 사용하여 OpenCypher 쿼리 사용을 제한할 수 있습니다(Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조).

요청

  • includeWaiting(CLI의 경우: --include-waiting) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    TRUE로 설정되고 다른 파라미터가 없으면 대기 중인 쿼리와 실행 중인 쿼리에 대한 상태 정보가 반환됩니다.

응답

  • acceptedQueryCount - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    대기열에 있는 쿼리를 포함하여 수락되었지만 아직 완료되지 않은 쿼리 수입니다.

  • queries – GremlinQueryStatus 객체의 배열입니다.

    현재 OpenCypher 쿼리 목록입니다.

  • runningQueryCount - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    현재 실행 중인 openCypher 쿼리의 수입니다.

오류

GetOpenCypherQueryStatus(동작)

        이 API의 AWS CLI 이름은 get-open-cypher-query-status입니다.

지정된 OpenCypher 쿼리의 상태를 가져옵니다.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 Neptune-db:GetQueryStatus IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

참고로 정책 문서에서는 neptune-db:QueryLanguage:OpenCypher IAM 조건 키를 사용하여 OpenCypher 쿼리 사용을 제한할 수 있습니다(Neptune IAM 데이터 액세스 정책 설명에서 사용할 수 있는 조건 키 참조).

요청

  • queryId(CLI의 경우: --query-id) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    쿼리 상태를 검색하는 데 사용할 OpenCypher 쿼리의 고유 ID입니다.

응답

  • queryEvalStats – QueryEvalStats 객체입니다.

    openCypher 쿼리 평가 상태입니다.

  • queryId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    상태가 반환되는 쿼리의 고유 ID입니다.

  • queryString - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    OpenCypher 쿼리 문자열입니다.

오류

CancelOpenCypherQuery(동작)

        이 API의 AWS CLI 이름은 cancel-open-cypher-query입니다.

지정된 OpenCypher 쿼리를 취소합니다. 자세한 내용은 Neptune OpenCypher 상태 엔드포인트를 참조하세요.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 Neptune-DB:cancelQuery IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

요청

  • queryId(CLI의 경우: --query-id) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    취소할 OpenCypher 쿼리의 고유 ID입니다.

  • silent(CLI의 경우: --silent) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    TRUE로 설정하면 OpenCypher 쿼리가 자동으로 취소됩니다.

응답

  • payload - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    OpenCypher 쿼리를 위한 취소 페이로드입니다.

  • status - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    취소할 OpenCypher 쿼리의 고유 ID입니다.

오류

쿼리 구조:

QueryEvalStats(구조)

실행, 승인 또는 대기 중인 쿼리 수, 세부 정보 등 쿼리 통계를 캡처하는 구조입니다.

필드

  • cancelled - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    쿼리가 취소된 경우 TRUE로 설정하고, 취소되지 않은 경우 FALSE로 설정합니다.

  • elapsed - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    지금까지 쿼리가 실행된 시간(단위: 밀리초)입니다.

  • subqueries – Document, 유형은 document(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.

    이 쿼리에 있는 하위 쿼리의 수입니다.

  • waited - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    쿼리가 대기한 시간을 밀리초 단위로 나타냅니다.

GremlinQueryStatus(구조)

Gremlin 쿼리의 상태를 캡처합니다 (Gremlin 쿼리 상태 API 페이지 참조).

필드

  • queryEvalStats - QueryEvalStats 객체입니다.

    Gremlin 쿼리의 통계입니다.

  • queryId - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Gremlin 쿼리의 ID입니다.

  • queryString - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Gremlin 쿼리의 통계입니다.

GremlinQueryStatusAttributes(구조)

Gremlin 쿼리의 상태 구성 요소를 포함합니다.

필드

  • attributes – Document, 유형은 document(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠)입니다.

    Gremlin 쿼리 상태의 속성입니다.

  • code - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    Gremlin 쿼리 요청에서 반환된 HTTP 응답 코드입니다.

  • message - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    상태 메시지입니다.