UpdateItem
UpdateItem
요청을 사용하면 AWS AppSync DynamoDB 함수에 DynamoDB에 UpdateItem
요청을 하도록 지시하고 다음을 지정할 수 있습니다.
-
DynamoDB의 항목 키
-
DynamoDB에서 항목 업데이트 방법을 설명하는 업데이트 표현식
-
성공할 작업의 조건
UpdateItem
요청의 구조는 다음과 같습니다.
type DynamoDBUpdateItemRequest = { operation: 'UpdateItem'; key: { [key: string]: any }; update: { expression: string; expressionNames?: { [key: string]: string }; expressionValues?: { [key: string]: any }; }; condition?: ConditionCheckExpression; customPartitionKey?: string; populateIndexFields?: boolean; _version?: number; };
필드는 다음과 같이 정의됩니다.
UpdateItem 필드
-
operation
-
수행할 DynamoDB 작업입니다.
UpdateItem
DynamoDB 작업을 수행하려면 이 값을UpdateItem
으로 설정해야 합니다. 이 값은 필수입니다. -
key
-
DynamoDB의 항목 키입니다. DynamoDB 항목은 테이블 구조에 따라 단일 해시 키 또는 해시 키와 정렬 키를 가질 수 있습니다. '입력된 값' 지정에 대한 자세한 내용은 유형 시스템(요청 매핑)을 참조하세요. 이 값은 필수입니다.
-
update
-
update
섹션에서는 DynamoDB의 항목 업데이트 방법을 설명하는 업데이트 표현식을 지정합니다. 업데이트 표현식을 작성하는 방법에 대한 자세한 내용은 DynamoDB UpdateExpressions 문서를 참조하십시오. 이 섹션은 필수입니다.update
섹션에는 다음 세 가지 구성 요소가 있습니다.-
expression
-
업데이트 표현식. 이 값은 필수입니다.
-
expressionNames
-
표현식 속성 name 자리 표시자의 대체 항목으로, 키-값 페어의 형식으로 표시됩니다. 키는
expression
에 사용된 name 자리 표시자에 해당하고 값은 DynamoDB에 있는 항목의 속성 이름에 해당하는 문자열이어야 합니다. 이 필드는 선택 사항으로,expression
에 사용된 표현식 속성인 name 자리 표시자의 대체 항목으로만 채워져야 합니다. -
expressionValues
-
표현식 속성 value 자리 표시자의 대체 항목으로, 키-값 페어의 형식으로 표시됩니다. 키는
expression
에 사용되는 value 자리 표시자에 해당하고 값은 입력된 값이어야 합니다. '입력된 값'을 지정하는 방법에 대한 자세한 내용은 유형 시스템(요청 매핑)을 참조하세요. 입력된 값은 지정되어 있어야 합니다. 이 필드는 선택 사항으로,expression
에 사용된 표현식 속성인 value 자리 표시자의 대체 항목으로만 채워져야 합니다.
-
-
condition
-
DynamoDB에 이미 있는 객체의 상태를 기반으로 요청의 성공 여부를 결정하는 조건. 조건을 지정하지 않으면
UpdateItem
요청이 현재 상태와 상관 없이 기존 항목을 업데이트합니다. 조건에 대한 자세한 내용은 조건 표현식을 참조하세요. 이 값은 선택 사항입니다. -
_version
-
항목의 알려진 최신 버전을 나타내는 숫자 값입니다. 이 값은 선택 사항입니다. 이 필드는 충돌 감지에 사용되며 버전이 지정된 데이터 원본에만 지원됩니다.
customPartitionKey
-
활성화되면 이 문자열 값은 버전 관리가 활성화되었을 때 델타 동기화 테이블에서 사용되는
ds_sk
및ds_pk
레코드의 형식을 수정합니다(자세한 내용은 AWS AppSync 개발자 안내서의 충돌 감지 및 동기화 참조). 활성화되면populateIndexFields
항목 처리도 활성화됩니다. 이 필드는 선택 사항입니다. populateIndexFields
-
customPartitionKey
와 함께 활성화되면 델타 동기화 테이블, 특히gsi_ds_pk
및gsi_ds_sk
열의 각 레코드에 대해 새 항목을 생성하는 부울 값입니다. 자세한 내용은 AWS AppSync 개발자 안내서의 충돌 감지 및 동기화를 참조하세요. 이 필드는 선택 사항입니다.
DynamoDB에서 업데이트된 항목은 자동으로 GraphQL 및 JSON 기본 유형으로 변환되며 컨텍스트 결과(context.result
)에서 사용할 수 있습니다.
DynamoDB 유형 변환에 대한 자세한 내용은 유형 시스템(응답 매핑)을 참조하세요.
JavaScript 해석기에 대한 자세한 내용은 JavaScript 해석기 개요를 참조하세요.
예 1
다음 예제는 GraphQL 뮤테이션 upvote(id: ID!)
를 위한 함수 요청 핸들러입니다.
이 예에서 DynamoDB의 항목에는 1씩 증가하는 upvotes
및 version
필드가 있습니다.
import { util } from '@aws-appsync/utils'; export function request(ctx) { const { id } = ctx.args; return { operation: 'UpdateItem', key: util.dynamodb.toMapValues({ id }), update: { expression: 'ADD #votefield :plusOne, version :plusOne', expressionNames: { '#votefield': 'upvotes' }, expressionValues: { ':plusOne': { N: 1 } }, }, }; }
예제 2
다음 예제는 GraphQL 뮤테이션 updateItem(id: ID!, title: String, author: String, expectedVersion:
Int!)
을 위한 함수 요청 핸들러입니다.
다음은 인수를 조사해 클라이언트에서 제공한 인수만 포함하는 업데이트 표현식을 동적으로 생성하는 복잡한 예입니다. 예를 들어, title
및 author
는 생략되면 업데이트되지 않습니다. 인수가 지정되어 있으나 그 값이 null
이면 DynamoDB의 객체에서 해당 필드가 삭제됩니다. 마지막으로, 이 작업에는 DynamoDB에 현재 있는 항목에 expectedVersion
으로 설정된 version
필드가 있는지 확인하는 조건이 있습니다.
import { util } from '@aws-appsync/utils'; export function request(ctx) { const { args: { input: { id, ...values } } } = ctx; const condition = { id: { attributeExists: true }, version: { eq: values.expectedVersion }, }; values.expectedVersion += 1; return dynamodbUpdateRequest({ keys: { id }, values, condition }); } /** * Helper function to update an item * @returns an UpdateItem request */ function dynamodbUpdateRequest(params) { const { keys, values, condition: inCondObj } = params; const sets = []; const removes = []; const expressionNames = {}; const expValues = {}; // Iterate through the keys of the values for (const [key, value] of Object.entries(values)) { expressionNames[`#${key}`] = key; if (value) { sets.push(`#${key} = :${key}`); expValues[`:${key}`] = value; } else { removes.push(`#${key}`); } } let expression = sets.length ? `SET ${sets.join(', ')}` : ''; expression += removes.length ? ` REMOVE ${removes.join(', ')}` : ''; const condition = JSON.parse( util.transform.toDynamoDBConditionExpression(inCondObj) ); return { operation: 'UpdateItem', key: util.dynamodb.toMapValues(keys), condition, update: { expression, expressionNames, expressionValues: util.dynamodb.toMapValues(expValues), }, }; }
DynamoDB UpdateItem
API에 대한 자세한 내용은 DynamoDB API 문서를 참조하십시오.