Query

Query 요청 매핑 문서를 사용하면 AWS AppSync DynamoDB 해석기에 DynamoDB 에 Query 요청할 것을 알리고 다음을 지정할 수 있습니다.

키 표현식
사용할 인덱스
모든 추가 필터
반환할 항목 수
일관된 읽기를 사용할지 여부
쿼리 방향(앞으로 또는 뒤로)
페이지 매김 토큰입니다

Query 매핑 문서의 구조는 다음과 같습니다.


{
    "version" : "2017-02-28",
    "operation" : "Query",
    "query" : {
        "expression" : "some expression",
        "expressionNames" : {
            "#foo" : "foo"
        },
        "expressionValues" : {
            ":bar" : ... typed value
        }
    },
    "index" : "fooIndex",
    "nextToken" : "a pagination token",
    "limit" : 10,
    "scanIndexForward" : true,
    "consistentRead" : false,
    "select" : "ALL_ATTRIBUTES" | "ALL_PROJECTED_ATTRIBUTES" | "SPECIFIC_ATTRIBUTES",
    "filter" : {
        ...
    },
    "projection" : {
        ...
    }
}

필드는 다음과 같이 정의됩니다.

쿼리 필드

version

템플릿 정의 버전. 2017-02-28 및 2018-05-29만 현재 지원됩니다. 이 값은 필수입니다.

operation

수행할 DynamoDB 작업입니다. Query DynamoDB 작업을 수행하려면 이 값을 Query으로 설정해야 합니다. 이 값은 필수입니다.

query

query 섹션에서는 DynamoDB에서 가져올 항목을 설명하는 키 조건 표현식을 지정할 수 있습니다. 키 조건 표현식을 작성하는 방법에 대한 자세한 내용은 DynamoDB KeyConditions 설명서 섹션을 참조하세요. 이 섹션은 지정되어 있어야 합니다.

expression: 쿼리 표현식. 이 필드는 지정되어 있어야 합니다.
expressionNames: 표현식 속성 name 자리 표시자의 대체 항목으로, 키-값 페어의 형식으로 표시됩니다. 키는 expression에 사용된 name 자리 표시자에 해당하고 값은 DynamoDB에 있는 항목의 속성 이름에 해당하는 문자열이어야 합니다. 이 필드는 선택 사항으로, expression에 사용된 표현식 속성인 name 자리 표시자의 대체 항목으로만 채워져야 합니다.
expressionValues: 표현식 속성 value 자리 표시자의 대체 항목으로, 키-값 페어의 형식으로 표시됩니다. 키는 expression에 사용되는 value 자리 표시자에 해당하고 값은 입력된 값이어야 합니다. '입력된 값'을 지정하는 방법에 대한 자세한 내용은 유형 시스템(요청 매핑)을 참조하세요. 이 값은 필수입니다. 이 필드는 선택 사항으로, expression에 사용된 표현식 속성인 value 자리 표시자의 대체 항목으로만 채워져야 합니다.

filter

반환되기 전 DynamoDB의 결과를 필터링하는 데 사용할 수 있는 추가 필터입니다. 필터에 대한 자세한 내용은 필터를 참조하십시오. 이 필드는 선택 사항입니다.

index

쿼리할 인덱스의 이름. DynamoDB 쿼리 작업을 사용하면 해시 키의 프라이머리 키 인덱스 이외에 로컬 보조 인덱스 및 글로벌 보조 인덱스를 검사할 수 있습니다. 지정하면 이 값은 DynamoDB에 지정한 인덱스를 쿼리하라고 지시합니다. 이 값을 생략하면 기본 키 인덱스가 쿼리됩니다.

nextToken

이전 쿼리를 지속하는 페이지 매김 토큰. 이 토큰은 이전 쿼리에서 얻습니다. 이 필드는 선택 사항입니다.

limit

평가할 최대 항목 수입니다(반드시 일치하는 항목 수는 아님). 이 필드는 선택 사항입니다.

scanIndexForward

앞으로 또는 뒤로 쿼리할지 여부를 나타내는 부울. 이 필드는 선택 사항으로, 기본값은 true입니다.

consistentRead

DynamoDB 쿼리 시 일관된 읽기를 사용할지 여부를 나타내는 부울. 이 필드는 선택 사항으로, 기본값은 false입니다.

select

기본적으로 AWS AppSync DynamoDB 해석기는 인덱스로 투영되는 속성만 반환합니다. 추가 속성이 필요한 경우 이 필드를 설정할 수 있습니다. 이 필드는 선택 사항입니다. 지원되는 값은 다음과 같습니다.

ALL_ATTRIBUTES: 지정한 테이블 또는 인덱스에서 항목 속성을 모두 반환합니다. 로컬 보조 인덱스를 쿼리하는 경우 DynamoDB는 인덱스의 일치하는 각 항목에 대해 상위 테이블의 전체 항목을 가져옵니다. 인덱스가 모든 항목 속성을 프로젝션하도록 구성된 경우, 모든 데이터를 로컬의 보조 인덱스에서 얻을 수 있기 때문에 가져올 필요가 없습니다.
ALL_PROJECTED_ATTRIBUTES: 인덱스를 쿼리하는 경우에만 허용됩니다. 인덱스로 프로젝션된 모든 속성을 가져옵니다. 모든 속성을 프로젝션하도록 인덱스가 구성된 경우 이 반환 값은 ALL_ATTRIBUTES를 지정하는 것과 동일합니다.
SPECIFIC_ATTRIBUTES: projection의 expression에 나열된 속성만 반환합니다. 이 반환 값은 Select에 대한 값을 지정하지 않고 projection의 expression을 지정하는 것과 같습니다.

projection

DynamoDB 작업에서 반환할 속성을 지정하는 데 사용되는 프로젝션입니다. 프로젝션에 대한 자세한 내용은 프로젝션을 참조하세요. 이 필드는 선택 사항입니다.

DynamoDB의 결과는 자동으로 GraphQL 및 JSON 기본 유형으로 변환되며 매핑 컨텍스트()에서 사용할 수 있습니다$context.result.

DynamoDB 형식 변환에 대한 자세한 내용은 형식 시스템(응답 매핑)을 참조하세요.

응답 매핑 템플릿에 대한 자세한 내용은 해석기 매핑 템플릿 개요를 참조하세요.

결과의 구조는 다음과 같습니다.


{
    items = [ ... ],
    nextToken = "a pagination token",
    scannedCount = 10
}

필드는 다음과 같이 정의됩니다.

items: DynamoDB 쿼리에서 반환하는 항목이 포함된 목록.
nextToken: 더 많은 결과가 있을 수 있는 경우 nextToken에는 다른 요청에 사용할 수 있는 페이지 매김 토큰이 포함됩니다. 는 DynamoDB 에서 반환된 페이지 매김 토큰을 AWS AppSync 암호화하고 난독화합니다. 따라서 테이블 데이터가 호출자에게 실수로 유출되는 일이 없습니다. 페이지 매김 토큰은 여러 해석기 간에 사용할 수 없습니다.
scannedCount: 필터 표현식(있는 경우)을 적용하기 전에 쿼리 조건 표현식과 일치했던 항목 수

예

다음 예제는 GraphQL 쿼리 getPosts(owner: ID!)의 매핑 템플릿입니다.

이 예에서는 테이블의 글로벌 보조 인덱스를 쿼리해 지정한 ID가 소유한 게시물을 모두 반환합니다.


{
    "version" : "2017-02-28",
    "operation" : "Query",
    "query" : {
        "expression" : "ownerId = :ownerId",
        "expressionValues" : {
            ":ownerId" : $util.dynamodb.toDynamoDBJson($context.arguments.owner)
        }
    },
    "index" : "owner-index"
}

DynamoDB 에 대한 자세한 내용은 DynamoDB API 설명서 섹션을 Query API참조하세요.

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

DeleteItem

스캔