Generación de operaciones API - Amazon DynamoDB

Generación de operaciones API

Para utilizar NoSQL Workbench para crear API CRUD de DynamoDB, seleccione Creador de operaciones de la izquierda de la interfaz de usuario de NoSQL Workbench.

A continuación, seleccione Abierto y elija una conexión.

Puede realizar las siguientes operaciones en el generador de operaciones.

Eliminar tabla

Para ejecutar una operación Delete Table, siga los pasos que se muestran a continuación.

  1. Encuentre la tabla que desea eliminar en la sección Tablas.

  2. Seleccione Eliminación de tabla en el menú de puntos suspensivos horizontales.

  3. Confirme que desea eliminar la tabla ingresando el Nombre de la tabla.

  4. Seleccione Eliminar.

Para obtener más información acerca de esta operación, consulte Eliminar tabla en la Referencia de la API de Amazon DynamoDB.

Eliminación de GSI

Para ejecutar una operación Delete GSI, siga los pasos que se muestran a continuación.

  1. Encuentre el GSI de una tabla que desea eliminar de la sección Tablas.

  2. Seleccione Eliminación de GSI en el menú de puntos suspensivos horizontales.

  3. Confirme que desea eliminar GSI ingresando el Nombre de GSI.

  4. Seleccione Eliminar.

Para obtener más información acerca de esta operación, consulte Eliminar tabla en la Referencia de la API de Amazon DynamoDB.

Crear tablas

Para ejecutar una operación Create Table, siga los pasos que se muestran a continuación.

  1. Elija el icono + junto a la sección Tablas.

  2. Ingrese el nombre de tabla que desee.

  3. Cree una clave de partición.

  4. Opcional: cree una clave de clasificación.

  5. Para personalizar la configuración de capacidad y desmarcar la casilla que hay junto a Uso de la configuración de capacidad predeterminada.

    • Ahora puede seleccionar Provisioned (Aprovisionada) o On-demand capacity (Capacidad bajo demanda).

      Si se selecciona Aprovisionada, puede establecer el mínimo y el máximo de las unidades de capacidad de lectura y escritura. También puede habilitar o deshabilitar el escalado automático.

    • Si la tabla está configurada actualmente en Bajo demanda, no podrá especificar un rendimiento aprovisionado.

    • Si cambia el rendimiento de Bajo demanda a Aprovisionado, el escalado automático se aplicará automáticamente a todos los GSI con mínimo: 1, máximo: 10; destino: 70 %.

  6. Seleccione Omisión de GSI y creación para crear esta tabla sin un GSI. Si lo desea, puede seleccionar Siguiente para crear un GSI con esta nueva tabla.

Para obtener más información acerca de esta operación, consulte Crear tabla en la Referencia de la API de Amazon DynamoDB.

Creación de GSI

Para ejecutar una operación Create GSI, siga los pasos que se muestran a continuación.

  1. Encuentre una tabla a la que quiera agregar un GSI.

  2. En el menú de puntos suspensivos horizontales, seleccione Creación de GSI.

  3. Asigne un nombre al GSI en Nombre de índice.

  4. Cree una clave de partición.

  5. Opcional: cree una clave de clasificación.

  6. Elija una opción de tipo de proyección en el menú desplegable.

  7. Seleccione Creación de GSI.

Para obtener más información acerca de esta operación, consulte Crear tabla en la Referencia de la API de Amazon DynamoDB.

Actualizar tabla

Para actualizar la configuración de capacidad de una tabla con una operación Update Table, haga lo siguiente.

  1. Encuentre la tabla para la que desea actualizar la configuración de capacidad.

  2. En el menú de puntos suspensivos horizontales, seleccione Actualización de la configuración de capacidad.

  3. Seleccione Aprovisionada o capacidad Bajo demanda.

    Si se selecciona Aprovisionada, puede establecer el mínimo y el máximo de las unidades de capacidad de lectura y escritura. También puede habilitar o deshabilitar el escalado automático.

  4. Seleccione Update (Actualizar).

Para obtener más información acerca de esta operación, consulte Actualizar tabla en la Referencia de la API de Amazon DynamoDB.

Actualización de GSI

Para actualizar la configuración de capacidad de GSI con una operación Update Table, haga lo siguiente.

nota

De forma predeterminada, los índices secundarios globales heredan la configuración de capacidad de la tabla base. Los índices secundarios globales pueden tener un modo de capacidad diferente solo cuando la tabla base está en el modo de capacidad aprovisionada. Al crear un índice secundario global en una tabla en modo aprovisionado, debe especificar las unidades de capacidad de lectura y escritura para la carga de trabajo prevista de ese índice. Para obtener más información, consulte Consideraciones sobre el rendimiento aprovisionado para los índices secundarios globales.

  1. Encuentre el GSI para el que desea actualizar la configuración de capacidad.

  2. En el menú de puntos suspensivos horizontales, seleccione Actualización de la configuración de capacidad.

  3. Ahora puede seleccionar Provisioned (Aprovisionada) o On-demand capacity (Capacidad bajo demanda).

    Si se selecciona Aprovisionada, puede establecer el mínimo y el máximo de las unidades de capacidad de lectura y escritura. También puede habilitar o deshabilitar el escalado automático.

  4. Seleccione Update (Actualizar).

Para obtener más información acerca de esta operación, consulte Actualizar tabla en la Referencia de la API de Amazon DynamoDB.

Poner elemento

Se crea un elemento mediante la operación Put Item. Para ejecutar o generar código para una operación Put Item, haga lo siguiente.

  1. Encuentre la tabla en la que desea crear un elemento.

  2. En el menú desplegable de Acciones, seleccione Creación de elemento.

  3. Escriba el valor de la clave de partición.

  4. Escriba el valor de la clave de clasificación, si hay una.

  5. Si desea añadir atributos que no sean de clave, haga lo siguiente:

    1. Seleccione + Agregación de otros atributos.

    2. Especifique los valores de Attribute name (Nombre de atributo), Type (Tipo) y Value (Valor).

  6. Si debe satisfacerse una expresión de condición para que la operación Put Item se realice correctamente, haga lo siguiente:

    1. Elija Condition (Condición).

    2. Especifique el nombre de atributo, el operador de comparación, el tipo de atributo y el valor de atributo.

    3. Si se necesitan otras condiciones, seleccione Condition (Condición) de nuevo.

    Para obtener más información, consulte Ejemplo de la CLI de expresión de condición de DynamoDB.

  7. Si desea generar código, seleccione Generate code (Generar código).

    Seleccione el idioma que desee en las pestañas mostradas. Ahora puede copiar este código y utilizarlo en su aplicación.

  8. Si desea que la operación se ejecute inmediatamente, seleccione Execute (Ejecutar).

  9. Si desea guardar esta operación para su uso posterior, elija Save operation (Guardar la operación), escriba el nombre de la operación y elija Save (Guardar).

Para obtener más información acerca de esta operación, consulte PutItem en la Referencia de la API de Amazon DynamoDB.

Actualizar elemento

Para ejecutar o generar código para una operación Update Item, haga lo siguiente:

  1. Encuentre la tabla en la que desea actualizar un elemento.

  2. Seleccione el elemento.

  3. Escriba el nombre y el valor del atributo para la expresión seleccionada.

  4. Si desea agregar más expresiones, elija otra de la lista desplegable Actualización de expresión y, a continuación, seleccione el icono +.

  5. Si debe satisfacerse una expresión de condición para que la operación Update Item se realice correctamente, haga lo siguiente:

    1. Elija Condition (Condición).

    2. Especifique el nombre de atributo, el operador de comparación, el tipo de atributo y el valor de atributo.

    3. Si se necesitan otras condiciones, seleccione Condition (Condición) de nuevo.

    Para obtener más información, consulte Ejemplo de la CLI de expresión de condición de DynamoDB.

  6. Si desea generar código, seleccione Generate code (Generar código).

    Elija la pestaña del idioma que desee. Ahora puede copiar este código y utilizarlo en su aplicación.

  7. Si desea que la operación se ejecute inmediatamente, seleccione Execute (Ejecutar).

  8. Si desea guardar esta operación para su uso posterior, elija Save operation (Guardar la operación), escriba el nombre de la operación y elija Save (Guardar).

Para obtener más información acerca de esta operación, consulte UpdateItem en la Referencia de la API de Amazon DynamoDB.

Eliminar elemento

Para ejecutar una operación Delete Item, siga los pasos que se muestran a continuación.

  1. Encuentre la tabla de la que desea eliminar un elemento.

  2. Seleccione el elemento.

  3. Del menú desplegable Acciones, seleccione Eliminación de elemento.

  4. Confirme que desea eliminar el elemento seleccionando Eliminación.

Para obtener más información acerca de esta operación, consulte DeleteItem en la Referencia de la API de Amazon DynamoDB.

Duplicado de elemento

Puede duplicar un elemento creando uno nuevo con los mismos atributos. Para duplicar un elemento, haga lo siguiente.

  1. Encuentre la tabla en la que desea duplicar un elemento.

  2. Seleccione el elemento.

  3. Del menú desplegable Acciones, seleccione Duplicación de elemento.

  4. Especifique una nueva clave de partición.

  5. Especifique una nueva clave de clasificación (si es necesario).

  6. Seleccione Ejecución.

Para obtener más información acerca de esta operación, consulte DeleteItem en la Referencia de la API de Amazon DynamoDB.

Consultar

Para ejecutar o generar código para una operación Query, haga lo siguiente.

  1. Seleccione Consulta en la parte superior de la interfaz de usuario de NoSQL Workbench.

  2. Especifique el valor de la clave de partición.

  3. Si se necesita una clave de clasificación para la operación Query:

    1. Seleccione Sort key (Clave de ordenación).

    2. Especifique el operador de comparación y el valor de atributo.

  4. Seleccione Consulta para ejecutar esta operación de consulta. Si necesita más opciones, compruebe la casilla de verificación Más opciones y siga con los pasos siguientes.

  5. Si no se deben devolver todos los atributos con el resultado de la operación, seleccione Projection expression (Expresión de proyección).

  6. Elija el icono +.

  7. Escriba el atributo que se devolverá con el resultado de la consulta.

  8. Si se necesitan más atributos, seleccione +.

  9. Si debe satisfacerse una expresión de condición para que la operación Query se realice correctamente, haga lo siguiente:

    1. Elija Condition (Condición).

    2. Especifique el nombre de atributo, el operador de comparación, el tipo de atributo y el valor de atributo.

    3. Si se necesitan otras condiciones, seleccione Condition (Condición) de nuevo.

    Para obtener más información, consulte Ejemplo de la CLI de expresión de condición de DynamoDB.

  10. Si desea generar código, seleccione Generate code (Generar código).

    Elija la pestaña del idioma que desee. Ahora puede copiar este código y utilizarlo en su aplicación.

  11. Si desea que la operación se ejecute inmediatamente, seleccione Execute (Ejecutar).

  12. Si desea guardar esta operación para su uso posterior, elija Save operation (Guardar la operación), escriba el nombre de la operación y elija Save (Guardar).

Para obtener más información acerca de esta operación, consulte Consulta en la Referencia de la API de Amazon DynamoDB.

Examen

Para ejecutar o generar código para una operación Scan, haga lo siguiente.

  1. Seleccione Escaneo en la parte superior de la interfaz de usuario de NoSQL Workbench.

  2. Seleccione el botón Escanear para realizar esta operación de escaneo básica. Si necesita más opciones, compruebe la casilla de verificación Más opciones y siga con los pasos siguientes.

  3. Especifique un nombre de atributo para filtrar los resultados del escaneo.

  4. Si no se deben devolver todos los atributos con el resultado de la operación, seleccione Projection expression (Expresión de proyección).

  5. Si debe satisfacerse una expresión de condición para que la operación de examen se realice correctamente, haga lo siguiente:

    1. Elija Condition (Condición).

    2. Especifique el nombre de atributo, el operador de comparación, el tipo de atributo y el valor de atributo.

    3. Si se necesitan otras condiciones, seleccione Condition (Condición) de nuevo.

    Para obtener más información, consulte Ejemplo de la CLI de expresión de condición de DynamoDB.

  6. Si desea generar código, seleccione Generate code (Generar código).

    Elija la pestaña del idioma que desee. Ahora puede copiar este código y utilizarlo en su aplicación.

  7. Si desea que la operación se ejecute inmediatamente, seleccione Execute (Ejecutar).

  8. Si desea guardar esta operación para su uso posterior, elija Save operation (Guardar la operación), escriba el nombre de la operación y elija Save (Guardar).

TransactGetItems

Para ejecutar o generar código para una operación TransactGetItems, haga lo siguiente.

  1. Del menú desplegable Más operaciones en la parte superior de la interfaz de usuario de NoSQL Workbench, elija TransactGetItems.

  2. Elija el icono + junto a TransactGetItem.

  3. Especifique una clave de partición.

  4. Especifique una clave de clasificación (si es necesario).

  5. Seleccione Ejecución para realizar la operación, Guardado de operación para guardarla o Generación de código para generar código para ella.

Para obtener más información sobre las transacciones, consulte Transacciones de Amazon DynamoDB.

TransactWriteItems

Para ejecutar o generar código para una operación TransactWriteItems, haga lo siguiente.

  1. Del menú desplegable Más operaciones en la parte superior de la interfaz de usuario de NoSQL Workbench, elija TransactWriteItems.

  2. Elija una operación del menú desplegable Acciones.

  3. Elija el icono + cerca de TransactWriteItem.

  4. En el menú desplegable Actions, elija la operación que desea realizar.

    Para cambiar el orden de las acciones, seleccione una acción en la lista de la izquierda y, a continuación, elija las flechas hacia arriba o hacia abajo para subirla o bajarla en la lista.

    Para eliminar una acción, seleccione la acción de la lista y, a continuación, el icono Delete (Eliminar) (papelera).

  5. Seleccione Ejecución para realizar la operación, Guardado de operación para guardarla o Generación de código para generar código para ella.

Para obtener más información sobre las transacciones, consulte Transacciones de Amazon DynamoDB.