Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
356 lines (219 sloc) 9.85 KB

Table of Contents

Dynamola

Dynamola, the DynamoDB easy library for Lambda functions. (https://github.com/javichur/dynamola)

Parameters

  • tableName string nombre de la tabla en DynamoDB.
  • partitionKeyName string nombre de la Clave de Partición de la tabla.
  • sortKeyName string nombre de la Clave de Ordenación de la tabla (opcional).

Meta

constructor

Parameters

  • tableName
  • partitionKeyName
  • sortKeyName

Examples

// constructor, para tabla con Clave Principal Compuesta (Clave Partición y Clave Ordenación)
let myDb = new Dynamola("nombreMiTablaMensajes", "userId", "fechaHora");
// constructor, para tabla con Clave Principal Simple (solo Clave Partición):
let myDb = new Dynamola("nombreMiTablaUsuarios", "userId", null);

getItemWithPrimarySortKey

Obtiene un elemento en una tabla con clave principal compuesta (clave partición + clave ordenación).

Parameters

  • partitionKeyValue string valor de la clave de partición.
  • sortKeyValue string valor de la clave de ordenación.

Returns Promise<Object> promise con el elemento.

getItem

Obtiene un elemento en una tabla con Clave Principal Simple (solo Clave Partición)

Parameters

  • partitionKeyValue string valor de la clave de partición.

Returns Promise<Object> promise con el elemento.

getAllItemsByPartitionKey

En tablas con Clave Principal Compuesta (partición+ordenación), devuelve todos los items para el valor de Clave de Partición dado.

Parameters

  • partitionKeyValue string valor de la clave de partición.

Returns Promise<Object> promise con array de elementos.

getItemsBySortKeyInRange

En tablas con Clave Principal Compuesta (partición+ordenación), devuelve todos los items para el valor de Clave de Partición dado, cuya Clave de Ordenación está en el rango dado.

Parameters

  • partitionKeyValue string valor de la clave de partición.
  • sortKeyRangeFrom
  • sortKeyRangeTo
  • rangeFrom string inicio rango de la clave de ordenación.
  • rangeTo string fin rango de la clave de ordenación.

Returns Promise<Object> promise con array de elementos.

getItemsByPartitionKeyInRange

Devuelve todos los items cuyo valor de partition key está entre los 2 valores dados.

Parameters

  • partitionKeyFrom string Inicio del rango de la clave de partición.
  • partitionKeyTo string Fin del rango de la clave de partición.

Returns Promise<Object> promise con array de elementos.

addItemWithPrimarySortKey

Añade un elemento a la tabla, con una clave de partición + clave de ordenación y un conjunto de atributos.

Parameters

  • partitionKeyValue string valor de la clave de partición del elemento a insertar.
  • sortKeyValue string valor de la clave de ordenación del elemento a insertar.
  • itemAttributes Object conjunto de atributos del elemento a insertar.

Returns Promise<Object> promise de la inserción. revolve(Item) o reject(err)

addItem

Añade un elemento a la tabla, con una clave de partición y un conjunto de atributos.

Parameters

  • partitionKeyValue string valor de la clave de partición del elemento a insertar.
  • itemAttributes Object conjunto de atributos del elemento a insertar.

Returns Promise<Object> promise de la inserción.

addItemFromObject

Añade un elemento en la tabla a partir de un objeto, que debe tener al menos 1 atributo llamado como la Clave de Partición y, si hay clave de ordenación, otro atributo llamado como la clave de ordenación. Además, puede tener otros atributos que también se almacenarán en la tabla con sus nombres.

Parameters

  • item object item que se guardará en la tabla.

Returns Promise<Object> promise de la inserción.

deleteItemWithPrimarySortKey

Elimina un elemento a la tabla, con una clave de partición y clave de ordenación.

Parameters

  • partitionKeyValue string valor de la clave de partición del elemento a eliminar.
  • sortKeyValue string valor de la clave de ordenación del elemento a eliminar.

Returns Promise<Object> promise de la eliminación.

deleteItem

Elimina un elemento a la tabla, con una clave de partición.

Parameters

  • partitionKeyValue string valor de la clave de partición del elemento a eliminar.

Returns Promise<Object> promise de la eliminación.

updateItemWithPrimarySortKey

Actualiza un elemento a la tabla, con una clave de partición + clave de ordenación, y listado de atributos-valores que se actualizarán.

No funciona con espacios en los nombres de los atributos.

Parameters

  • partitionKeyValue string valor de la clave de partición del elemento a actualizar.
  • sortKeyValue string valor de la clave de ordenación del elemento a actualizar.
  • itemAttributesToChange Object listado de atributos-valores que se actualizarán.

Returns Promise<Object> promise de la actualización.

updateItem

Actualiza un elemento a la tabla, con una clave de partición, y listado de atributos-valores que se actualizarán.

Parameters

  • partitionKeyValue string valor de la clave de partición del elemento a actualizar.
  • itemAttributesToChange Object listado de atributos-valores que se actualizarán.

Returns Promise<Object> promise de la actualización.

incrementCounterWithPrimarySortKey

Incrementando de forma atómica el valor de un atributo en X cantidad.

Parameters

  • partitionKeyValue string valor de la clave de partición del elemento a actualizar.
  • sortKeyValue string valor de la clave de ordenación del elemento a actualizar.
  • attributeName string nombre del atributo a incrementar.
  • increment int cantidad en la que se incrementa el valor.

Returns Promise<Object> promise de la actualización.

incrementCounter

Incrementando de forma atómica el valor de un atributo en X unidades.

Parameters

  • partitionKeyValue string valor de la clave de partición del elemento a actualizar.
  • attributeName string nombre del atributo a incrementar.
  • increment int cantidad en la que se incrementa el valor.

Returns Promise<Object> promise de la actualización.

createTableBasic

Crea una tabla dynamodb básica, con:

  • una clave de partición con nombre "Key" y tipo string.
  • sin clave de ordenación.
  • con capacidad aprovisionada de 5 lecturas y 5 escrituras.
  • sin índices secundarios.

Parameters

  • tableName string nombre de la tabla

createTableBasicWithSortKey

Crea una tabla dynamodb básica, con:

  • una clave de partición con nombre "Key" y tipo string.
  • una clave de ordenación con nombre "KeySort" y tipo string.
  • con capacidad aprovisionada de 5 lecturas y 5 escrituras.
  • sin índices secundarios.

Parameters

  • tableName string nombre de la tabla
You can’t perform that action at this time.