DynamoDB (Beta Restrito)

Descubra mais sobre o componente DynamoDB e como utilizá-lo na Digibee Integration Platform.

Esta funcionalidade está atualmente na fase Beta restrito e disponível apenas para clientes específicos.

O componente DynamoDB permite que pipelines realizem operações em tabelas DynamoDB na AWS. Atualmente, estão disponíveis as seguintes operações:

  • PutItem: cria ou substitui um item em uma tabela DynamoDB.

  • GetItem: busca atributos de um item existente em uma tabela DynamoDB pela chave primária.

  • UpdateItem: edita os atributos de um item existente ou adiciona um item novo a uma tabela DynamoDB.

  • DeleteItem: remove um único item em uma tabela pela chave primária.

Parâmetros

Os parâmetros disponíveis estão divididos em quatro abas e podem variar de acordo com a operação selecionada. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Aba General

ParâmetroDescriçãoValor padrãoTipo de dado

Fail On Error

Se a opção estiver ativada, a execução do pipeline com um erro será interrompida. Do contrário, a execução do pipeline será mantida, mas o resultado mostrará um valor falso para a propriedade "success".

False

Booleano

Aba Authentication

ParâmetroDescriçãoValor padrãoTipo de dado

DynamoDB Client Account

Conta usada para conectar o pipeline à tabela de destino do DynamoDB.

NULL

BASIC, AWS-V4

AWS Region (Opcional)

A região AWS onde a tabela de destino está disponível.

Este parâmetro é opcional ao usar uma conta tipo AWS-V4, uma vez que isso pode ser inferido a partir da conta.

NULL

String

Aba Operation Settings

ParâmetroDescriçãoValor padrãoTipo de dado

Operation

Operação a ser realizada.

PutItem

String

Table Name

Nome da tabela na qual a operação será realizada.

NULL

String

Parâmetros da operação PutItem

ParâmetroDescriçãoValor padrãoTipo de dado

Upsert

Quando ativado, o parâmetro substitui completamente um item existente com a mesma chave primária. Do contrário, a operação irá falhar quando um item com a chave primária especificada já existir.

True

Booleano

Body (DB)

Objeto JSON a ser usado pela operação.

Arrays JSON e outras definições válidas de JSON não são permitidas.

{{ message.$ }}

JSON

Parâmetros da operação GetItem

ParâmetroDescriçãoValor padrãoTipo de dado

Partition Key Value (DB)

Valor da chave de partição (partition key) do item de destino. Este parâmetro é obrigatório.

NULL

String

Sort Key Value (DB)

Valor da chave de classificação (sort key) do item de destino. É necessária somente quando a tabela de destino usa uma chave primária composta (chave de partição + chave de classificação).

NULL

String

Attributes to Return (DB)

Lista de nomes de atributos separados por vírgula a serem retornados pela operação.

NULL

String

Consistent Read

Este parâmetro se sobrepõe ao comportamento padrão de consistência eventual do DynamoDB quando ativado.

False

Booleano

Parâmetros da operação UpdateItem

ParâmetroDescriçãoValor padrãoTipo de dado

Partition Key Value (DB)

Valor da chave de partição do item de destino. Este parâmetro é obrigatório.

NULL

String

Sort Key Value (DB)

Valor da chave de classificação do item de destino. É necessária somente quando a tabela de destino usa uma chave primária composta (chave de partição + chave de classificação).

NULL

String

Return Values

Lista de opções para obter os valores dos atributos, antes ou depois da operação de atualização ser realizada.

As opções são: ALL NEW (Retorna todos os valores como estão, após atualizar), ALL OLD (Todos os valores como estavam antes de atualizar), NONE (Nada é retornado), UPDATED NEW (Somente valores atualizados são retornados como estão após atualizar), e UPDATED OLD (Somente valores atualizados como estavam antes de atualizar).

NONE

String

Body (DB)

Objeto JSON a ser usado pela operação.

Arrays JSON e outras definições válidas de JSON não são permitidas.

{{ message.$ }}

JSON

Parâmetros da operação DeleteItem

ParâmetroDescriçãoValor padrãoTipo de dado

Partition Key Value (DB)

Valor da chave de partição do item de destino. Este parâmetro é obrigatório.

NULL

String

Sort Key Value (DB)

Valor da chave de classificação do item de destino. É necessária somente quando a tabela de destino usa uma chave primária composta (chave de partição + chave de classificação).

NULL

String

Saída

Todas as operações retornam:

  • Um atributo booleano "success" para indicar se a operação foi realizada com sucesso (true) ou se falhou (false).

  • Um atributo de contagem, indicando quantos itens foram afetados pela operação. Este parâmetro recebe o nome da operação no seguinte formato: <operation's name>+"Count".

  • Um atributo "data" contendo um array de registros de itens retornados. Isto é restrito às operações que retornam algum resultado.

Exemplo GetItem

{
	"success": true,
	"getItemCount": 1,
	"data": [
		{
	"Age": 8,
	"Colors": [
		"White", 
		"Brown",
		"Black"
],
"Name": "Fido",
"Vaccinations": {
	"Rabies": [
		"2009-03-17",
		"2011-09-21",
		"2014-07-08"
	],
	"Distemper": "2015-10-13"
},
"Breed": "Beagle",
"AnimalType": "Dog"
}
	]
}

Last updated