PutItem - AWS AppSync
Campos PutItemEjemplo 1Ejemplo 2

PutItem

El documento de mapeo de solicitudes PutItem permite indicar a la función de DynamoDB de AWS AppSync que realice una solicitud PutItem a DynamoDB, así como especificar lo siguiente:

  • La clave del elemento de DynamoDB

  • El contenido completo del elemento (compuesto de key y attributeValues).

  • Condiciones para que la operación se lleve a cabo correctamente.

La solicitud PutItem tiene la estructura siguiente:

type DynamoDBPutItemRequest = {
  operation: 'PutItem';
  key: { [key: string]: any };
  attributeValues: { [key: string]: any};
  condition?: ConditionCheckExpression;
  customPartitionKey?: string;
  populateIndexFields?: boolean;
  _version?: number;
};

Los campos se definen de la siguiente manera:

Campos PutItem

operation

La operación de DynamoDB que se ha de realizar. Para ejecutar la operación de DynamoDB PutItem, este valor se debe establecer en PutItem. Este valor es obligatorio.

key

La clave del elemento de DynamoDB. Los elementos de DynamoDB pueden tener solo una clave hash o una clave hash y una clave de clasificación, dependiendo de la estructura de la tabla. Para obtener más información sobre cómo especificar un “valor con tipo”, consulte Sistema de tipos (mapeo de solicitud). Este valor es obligatorio.

attributeValues

El resto de los atributos del elemento que debe colocarse en DynamoDB. Para obtener más información sobre cómo especificar un “valor con tipo”, consulte Sistema de tipos (mapeo de solicitud). Este campo es opcional.

condition

Una condición para determinar si la solicitud debe realizarse correctamente o no, en función del estado del objeto ya incluido en DynamoDB. Si no se especifica ninguna condición, la solicitud PutItem sobrescribe todas las entradas existentes para dicho elemento. Para obtener más información sobre las condiciones, consulte Expresiones de condición. Este valor es opcional.

_version

Valor numérico que representa la última versión conocida de un elemento. Este valor es opcional. Este campo se utiliza para detectar conflictos y solo se admite en orígenes de datos con control de versiones.

customPartitionKey

Cuando se habilita, este valor de cadena modifica el formato de los registros ds_sk y ds_pk que utiliza la tabla Delta Sync una vez habilitado el control de versiones (para obtener más información, consulte el artículo sobre detección de conflictos y sincronización en la Guía para desarrolladores de AWS AppSync). Cuando se habilita, también lo hace el procesamiento de la entrada populateIndexFields. Este campo es opcional.

populateIndexFields

Valor booleano que, cuando se habilita junto con la customPartitionKey, crea nuevas entradas para cada registro de la tabla Delta Sync, específicamente en las columnas gsi_ds_pk y gsi_ds_sk. Para obtener más información, consulte el artículo sobre detección de conflictos y sincronización en la Guía para desarrolladores de AWS AppSync. Este campo es opcional.

El elemento que se escribe en DynamoDB se convierte automáticamente a los tipos primitivos de GraphQL y JSON, y está disponible en el resultado del contexto (context.result).

El elemento que se escribe en DynamoDB se convierte automáticamente a los tipos primitivos de GraphQL y JSON, y está disponible en el resultado del contexto (context.result).

Para obtener más información sobre la conversión de tipos de DynamoDB, consulte la sección Sistema de tipos (mapeo de respuestas).

Para obtener más información sobre los solucionadores de JavaScript, consulte el artículo sobre la descripción general de los solucionadores de JavaScript.

Ejemplo 1

El siguiente ejemplo es un controlador de solicitudes de función para una mutación de GraphQL updateThing(foo: String!, bar: String!, name: String!, version: Int!).

Si no existe ningún elemento con la clave especificada, dicho elemento se crea. Si ya existe un elemento con la clave especificada, dicho elemento se sobrescribe.

import { util } from '@aws-appsync/utils';
export function request(ctx) {
  const { foo, bar, ...values} = ctx.args
  return {
    operation: 'PutItem',
    key: util.dynamodb.toMapValues({foo, bar}),
    attributeValues: util.dynamodb.toMapValues(values),
  };
}

Ejemplo 2

El siguiente ejemplo es un controlador de solicitudes de función para una mutación de GraphQL updateThing(foo: String!, bar: String!, name: String!, expectedVersion: Int!).

En este ejemplo se comprueba que el elemento que se encuentra actualmente en DynamoDB tiene el campo version establecido en expectedVersion.

import { util } from '@aws-appsync/utils';
export function request(ctx) {
  const { foo, bar, name, expectedVersion } = ctx.args;
  const values = { name, version: expectedVersion + 1 };
  let condition = util.transform.toDynamoDBConditionExpression({
    version: { eq: expectedVersion },
  });

  return {
    operation: 'PutItem',
    key: util.dynamodb.toMapValues({ foo, bar }),
    attributeValues: util.dynamodb.toMapValues(values),
    condition,
  };
}

Para obtener más información sobre la API PutItem de DynamoDB, consulte la documentación de la API de DynamoDB.