UpdateItem

Mit der UpdateItem Anforderung können Sie die AWS AppSync DynamoDB-Funktion anweisen, eine UpdateItem Anforderung an DynamoDB zu stellen, und Sie können Folgendes angeben:

Die UpdateItem Anfrage hat die folgende Struktur:

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;
};

Die Felder sind wie folgt definiert:

UpdateItem Felder

Das in DynamoDB aktualisierte Element wird automatisch in die primitiven GraphQL- und JSON-Typen konvertiert und ist im Kontext result () verfügbar. context.result

Weitere Informationen zur DynamoDB-Typkonvertierung finden Sie unter Typsystem (Antwortzuordnung).

Weitere Informationen zu JavaScript Resolvern finden Sie unter JavaScript Übersicht über Resolver.

Beispiel 1

Das folgende Beispiel ist ein Funktionsanforderungshandler für die GraphQL-Mutation. upvote(id: ID!)

In diesem Beispiel werden die version Felder upvotes und für ein Element in DynamoDB um 1 erhöht.

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 } },
    },
  };
}

Beispiel 2

Das folgende Beispiel ist ein Funktionsanforderungshandler für eine GraphQL-Mutation. updateItem(id: ID!, title: String, author: String, expectedVersion: Int!)

Hierbei handelt es sich um ein komplexes Beispiel, das die Argumente prüft und den Aktualisierungsausdruck dynamisch generiert, der nur die Argumente enthält, die vom Client bereitgestellt wurden. Beispiel: Wenn title und author nicht angegeben werden, werden sie nicht aktualisiert. Wenn ein Argument angegeben ist, sein Wert jedochnull, wird dieses Feld aus dem Objekt in DynamoDB gelöscht. Schließlich hat die Operation eine Bedingung, die überprüft, ob für das aktuell in DynamoDB befindliche Element das Feld wie folgt festgelegt ist: version expectedVersion

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),
    },
  };
}

Weitere Informationen zur DynamoDB UpdateItem-API finden Sie in der DynamoDB API-Dokumentation.