- Dynamola
- Parameters
- constructor
- getItemWithPrimarySortKey
- getItem
- getItemGreatestWithPrimarySortKey
- getItemGreatestByLSI
- getAllItemsByPartitionKey
- getItemsBySortKeyInRange
- getItemsBySortKeyBeginsWith
- getItemsByLSI
- getItemsByGSI
- getItemsByPartitionKeyInRange
- addItemWithPrimarySortKey
- addItem
- addItemFromObject
- deleteItemWithPrimarySortKey
- deleteItem
- updateItemWithPrimarySortKey
- updateItem
- incrementCounterWithPrimarySortKey
- incrementCounter
- createTableBasic
- createTableBasicWithSortKey
- createTableBasicWithSortKeyAndLSI
- createTableBasicWithSortKeyGSI
Dynamola, the DynamoDB easy library for Lambda functions. (https://github.com/javichur/dynamola)
tableNamestring nombre de la tabla en DynamoDB.partitionKeyNamestring nombre de la Clave de Partición de la tabla.sortKeyNamestring nombre de la Clave de Ordenación de la tabla (opcional).
Meta
- version: 1.4.5
- author: Javier Campos (https://javiercampos.es).
- license: MIT
tableNamepartitionKeyNamesortKeyName
// 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);Obtiene un elemento en una tabla con clave principal compuesta (clave partición + clave ordenación).
partitionKeyValuestring valor de la clave de partición.sortKeyValuestring valor de la clave de ordenación.
Returns Promise<Object> promise con el elemento.
Obtiene un elemento en una tabla con Clave Principal Simple (solo Clave Partición)
partitionKeyValuestring valor de la clave de partición.
Returns Promise<Object> promise con el elemento.
Devuelve el elemento con mayor valor en SortKey, y con el partitionKeyValue indicado.
partitionKeyValuestring
Devuelve el elemento con valor máximo en la clave de ordenación del índice secundario local.
partitionKeyValuestring valor de clave de partición.lsiIndexNamestring Nombre del índice secundario local.
Returns any elemento con valor máximo en clave de ordenación del índice secundario local.
En tablas con Clave Principal Compuesta (partición+ordenación), devuelve todos los items para el valor de Clave de Partición dado.
partitionKeyValuestring valor de la clave de partición.
Returns Promise<Object> promise con array de elementos.
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.
partitionKeyValuestring valor de la clave de partición.sortKeyRangeFromsortKeyRangeTorangeFromstring inicio rango de la clave de ordenación.rangeTostring fin rango de la clave de ordenación.
Returns Promise<Object> promise con array de elementos.
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 Ordenación empieza por sortKeyValueBeginsWith.
Returns Promise<Object> promise con array de elementos.
Busca utilizando un Índice Local Secundario (LSI) de la tabla.
partitionKeyValueany Valor de la Clave de Partición, para la búsqueda.lsiValueany Valor del LSI, para la búsqueda.lsiIndexNamestring Nombre del índice LSI.lsiAttributeNamestring Nombre del atributo (perteneciente al LSI) por el cual realizar la consulta.operatorstring Operador utilizado en la consulta (=, <, >, <=, >=).
Returns Promise<Object> promise con array de elementos.
Busca utilizando un Índice Global Secundario (GSI) simple de la tabla.
gsiValuestring Valor a buscar en Partition KeygsiIndexNamestring Nombre del índice GSI.gsiAttributeNamestring Nombre del atributo Partition Key del GSI.
Returns any promise con array de elementos.
Devuelve todos los items cuyo valor de partition key está entre los 2 valores dados. ADVERTENCIA: Se recomienda que diseñes tus tablas DynamoDB para no tener que utilizar este método, ya que éste necesita usar internamente scan(), que es más costoso que Query().
partitionKeyFromstring Inicio del rango de la clave de partición.partitionKeyTostring Fin del rango de la clave de partición.
Returns Promise<Object> promise con array de elementos.
Añade un elemento a la tabla, con una clave de partición + clave de ordenación y un conjunto de atributos.
partitionKeyValuestring valor de la clave de partición del elemento a insertar.sortKeyValuestring valor de la clave de ordenación del elemento a insertar.itemAttributesObject conjunto de atributos del elemento a insertar.
Returns Promise<Object> promise de la inserción. revolve(Item) o reject(err)
Añade un elemento a la tabla, con una clave de partición y un conjunto de atributos.
partitionKeyValuestring valor de la clave de partición del elemento a insertar.itemAttributesObject conjunto de atributos del elemento a insertar.
Returns Promise<Object> promise de la inserción.
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.
itemobject item que se guardará en la tabla.
Returns Promise<Object> promise de la inserción.
Elimina un elemento a la tabla, con una clave de partición y clave de ordenación.
partitionKeyValuestring valor de la clave de partición del elemento a eliminar.sortKeyValuestring valor de la clave de ordenación del elemento a eliminar.
Returns Promise<Object> promise de la eliminación.
Elimina un elemento a la tabla, con una clave de partición.
partitionKeyValuestring valor de la clave de partición del elemento a eliminar.
Returns Promise<Object> promise de la eliminación.
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.
partitionKeyValuestring valor de la clave de partición del elemento a actualizar.sortKeyValuestring valor de la clave de ordenación del elemento a actualizar.itemAttributesToChangeObject listado de atributos-valores que se actualizarán.
Returns Promise<Object> promise de la actualización.
Actualiza un elemento a la tabla, con una clave de partición, y listado de atributos-valores que se actualizarán.
partitionKeyValuestring valor de la clave de partición del elemento a actualizar.itemAttributesToChangeObject listado de atributos-valores que se actualizarán.
Returns Promise<Object> promise de la actualización.
Incrementando de forma atómica el valor de un atributo en X cantidad.
partitionKeyValuestring valor de la clave de partición del elemento a actualizar.sortKeyValuestring valor de la clave de ordenación del elemento a actualizar.attributeNamestring nombre del atributo a incrementar.incrementint cantidad en la que se incrementa el valor.
Returns Promise<Object> promise de la actualización.
Incrementando de forma atómica el valor de un atributo en X unidades.
partitionKeyValuestring valor de la clave de partición del elemento a actualizar.attributeNamestring nombre del atributo a incrementar.incrementint cantidad en la que se incrementa el valor.
Returns Promise<Object> promise de la actualización.
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.
tableNamestring nombre de la tabla
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 "SortKey" y tipo string.
- con capacidad aprovisionada de 5 lecturas y 5 escrituras.
- sin índices secundarios.
tableNamestring nombre de la tabla
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 "SortKey" y tipo string.
- un atributo con nombre "Lsi", de tipo int.
- un LSI (Índice Local Secundario) llamado "Lsi-index", que tiene como Clave de Partición y Ordenación a "Key" y "Lsi" respectivamente.
- con capacidad aprovisionada de 5 lecturas y 5 escrituras.
tableNamestring nombre de la tabla
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 "SortKey" y tipo string.
- un GSI (Índice Global Secundario) simple llamado "Gsi-index", que tiene como Clave de Partición a "SortKey", pero que no tiene una Clave de Ordenación.
- con capacidad aprovisionada de 5 lecturas y 5 escrituras.
tableNamestring nombre de la tabla