# Node.js e DAX
<a name="DAX.client.run-application-nodejs-3"></a>

# Configuração do cliente padrão para Node.js
<a name="DAX-client-config-JS"></a>

Ao configurar o cliente SDK JavaScript do DAX, você pode personalizar vários parâmetros para otimizar a performance, o tratamento da conexão e a resiliência a erros. A tabela a seguir descreve as configurações padrão que controlam como o cliente interage com o cluster DAX, como valores de tempo limite, mecanismos de repetição, gerenciamento de credenciais e opções de monitoramento de integridade. Para ter mais informações, consulte [DynamoDBClient Operations](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dynamodb/).


**Padrões do cliente SDK JS do DAX**  

| Parâmetro | Tipo | Descrição | 
| --- | --- | --- | 
|  `region` optional  |  `string`  |  A Região da AWS a ser usada para o cliente DAX (exemplo: “us-east-1”). É um parâmetro obrigatório caso não seja fornecido por meio da variável de ambiente.  | 
|  `endpoint` obrigatório  |  `string`  | O endpoint do cluster ao qual o SDK se conecta. Exemplos: Não criptografado: dax-cluster-name.region.amazonaws.com Criptografado: daxs://my-cluster.l6fzcv.dax-clusters.us-east-1.amazonaws.com  | 
|  `requestTimeout` padrão 6.000 ms  |  `number`  | Isso define o tempo máximo que o cliente aguardará por uma resposta do DAX.  | 
|  `writeRetries` padrão 1  |  `number`  | O número de tentativas para solicitações de gravação que falharam.  | 
|  `readRetries` padrão 1  |  `number`  | O número de tentativas para solicitações de leitura que falharam.  | 
|  `maxRetries` padrão 1  |  `number`  | A quantidade máxima de tentativas após solicitações com falha. Se readRetries/writeRetries estiverem definidos, a configuração em readRetries e writeRetries terá prioridade sobre maxRetries.  | 
|  `connectTimeout` padrão 10.000 ms  |  `number`  | O tempo limite (em milissegundos) para estabelecer conexão com qualquer um dos nós do cluster.  | 
|  `maxConcurrentConnections` padrão 100  |  `number`  | Limita o número total de conexões simultâneas que uma instância cliente pode criar por nó em um cluster do DAX.  | 
|  `maxRetryDelay` padrão 7.000 ms  |  `number`  | Quando o servidor DAX indicar que a recuperação é necessária definindo o sinalizador `waitForRecoveryBeforeRetrying` como verdadeiro, o cliente fará uma pausa antes de tentar novamente. Durante esses períodos de recuperação, o parâmetro `maxRetryDelay` determina o tempo máximo de espera entre as tentativas. Essa configuração específica de recuperação só se aplica quando o servidor DAX está no modo de recuperação. Em todos os outros cenários, o comportamento de tentativa segue um dos dois padrões: um atraso exponencial com base na contagem de tentativas (controlado pelos parâmetros `writeRetries`, `readRetries` ou `maxRetries`) ou uma nova tentativa imediata, dependendo do tipo de exceção.  | 
|  `credentials` optional  |  `[AwsCredentialIdentity](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-credential-providers/)` \$1 `[AwsCredentialIdentityProvider](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-credential-providers/)`  |  As credenciais da AWS a serem usadas para autenticar solicitações. Isso pode ser fornecido como um AwsCredentialIdentity ou um AwsCredentialIdentityProvider. Se não for fornecido, o SDK da AWS usará automaticamente a cadeia de provedores de credenciais padrão. Exemplo: `\$1 accessKeyId: 'AKIA...', secretAccessKey: '...', sessionToken: '...' \$1` \$1 @default usa a cadeia de provedores de credenciais padrão da AWS.  | 
|  `healthCheckInterval` padrão 5.000 ms  |  `number`  | O intervalo (em milissegundos) entre as verificações de integridade do cluster. Um intervalo menor fará verificações com maior frequência.  | 
|  `healthCheckTimeout` padrão 1.000 ms  |  `number`  | O tempo limite (em milissegundos) para a conclusão da verificação de integridade.  | 
|  `skipHostnameVerification` padrão falso  |  `boolean`  |  Ignore a verificação do nome do host das conexões TLS. Isso não tem impacto em clusters não criptografados. O padrão é realizar a verificação do nome do host. Se definida como True, a verificação será ignorada. Você precisa entender a implicação de desativá-la, que é a impossibilidade de autenticar o cluster ao qual você está se conectando.   | 
|  `unhealthyConsecutiveErrorCount` padrão 5  |  `number`  | Define o número de erros consecutivos necessários para sinalizar que o nó não está íntegro no intervalo de verificação de integridade.  | 
|  `clusterUpdateInterval` padrão 4.000 ms  |  `number`  | Exibe o intervalo entre as sondagens dos membros do cluster para alterações de associação.  | 
|  `clusterUpdateThreshold` padrão 125  |  `number`  | Exibe o limite abaixo do qual o cluster não será sondado para alterações de associação.  | 
|  `credentailProvider` opcional \$1 padrão nulo  |  `[AwsCredentialIdentityProvider](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-credential-providers/)`  | Provedor definido pelo usuário para credenciais da AWS usadas para autenticar solicitações ao DAX.  | 


**Configuração de paginação para DaxDocument**  

| Nome | Tipo | Detalhes | 
| --- | --- | --- | 
|  `client`  |  DaxDocument  |  Instância do tipo DaxDocument.  | 
|  `pageSize`  |  número  |  Determina o número de itens por página.  | 
|  `startingToken` Opcional  |  quaisquer  |  A LastEvaluatedKey da resposta anterior pode ser usada para solicitações subsequentes.  | 

Quanto ao uso da paginação, consulte [TryDax.js](DAX.client.tutorial-TryDax.md).

# Migrar para o DAX Node.js SDK V3
<a name="DAX.client.run-application-nodejs-3-migrating"></a>

Este guia de migração ajudará você a fazer a transição de aplicações DAX Node.js existentes. O novo SDK requer o Node.js 18 ou posterior e introduz várias alterações importantes na forma como você estruturará o código do DynamoDB Accelerator. Este guia explicará as principais diferenças, incluindo alterações de sintaxe, novos métodos de importação e padrões de programação assíncrona atualizados.

## Uso do DAX Node.js V2
<a name="DAX.client.run-application-nodejs-3-migrating-V2-usage"></a>

```
const AmazonDaxClient = require('amazon-dax-client');
const AWS = require('aws-sdk');

var region = "us-west-2";

AWS.config.update({
  region: region,
});

var client = new AWS.DynamoDB.DocumentClient();

if (process.argv.length > 2) {
  var dax = new AmazonDaxClient({
    endpoints: [process.argv[2]],
    region: region,
  });
  client = new AWS.DynamoDB.DocumentClient({ service: dax });
}

// Make Get Call using Dax
var params = {
    TableName: 'TryDaxTable',
    pk: 1,
    sk: 1
}
client.get(params, function (err, data) {
    if (err) {
        console.error(
            "Unable to read item. Error JSON:",
            JSON.stringify(err, null, 2)
          );
    } else {
        console.log(data);
    }
});
```

## Uso do DAX Node.js V3
<a name="DAX.client.run-application-nodejs-3-migrating-V3-dax-usage"></a>

Para usar o DAX Node.js V3, a versão 18 ou posterior do Node é a versão preferencial. Para mudar para o Node 18, use o seguinte:

```
import { DaxDocument } from '@amazon-dax-sdk/lib-dax';
import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
import { DynamoDBClient } from '@aws-sdk/client-dynamodb';

let client: DynamoDBDocument | DaxDocument = DynamoDBDocument.from(
  new DynamoDBClient({ region: 'us-west-2' })
);

if (process.argv.length > 2) {
  client = new DaxDocument({
    endpoints: [process.argv[2]],
    region: 'us-west-2',
  });
}

const params = {
  TableName: 'TryDaxTable',
  Key: { pk: 1, sk: 1 },
};

try {
  const results = await client.get(params);
  console.log(results);
} catch (err) {
  console.error(err);
}
```

O DAX SDK para Node.js v3.x é compatível com o [AWS SDK para Node.js v3.x](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/introduction/). O DAX SDK para Node.js v3.x aceita o uso de clientes [agregados](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/introduction/#high-level-concepts). Observe que o DAX não aceita a criação de clientes básicos. Para ter mais detalhes sobre os recursos não aceitos, consulte [Recursos que não estão em paridade com o AWS SDK para V3](#DAX.client.run-application-nodejs-3-not-in-parity).

Siga estas etapas para executar a aplicação de exemplo em Node.js na instância do Amazon EC2.

**Para executar o exemplo em Node.js para DAX**

1. Configure o Node.js na instância do Amazon EC2 da seguinte forma:

   1. Instale o gerenciador de versão de nó (`nvm`).

      ```
      curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
      ```

   1. Use o nvm para instalar o Node.js.

      ```
      nvm install 18
      ```

   1. Usar nvm para utilizar o Node 18

      ```
      nvm use 18
      ```

   1. Verifique se o Node.js está instalado e funcionando corretamente.

      ```
      node -e "console.log('Running Node.js ' + process.version)"
      ```

      Isso deve exibir a seguinte mensagem.

      `Running Node.js v18.x.x`

1. Instale o cliente Node.js do DaxDocument usando o gerenciador de pacotes de nó (`npm`).

   ```
   npm install @amazon-dax-sdk/lib-dax
   ```

## Código de exemplo do TryDax
<a name="DAX.client.run-application-nodejs-3-TryDax-sample-code"></a>

Se quiser avaliar os benefícios de performance do DynamoDB Accelerator (DAX), siga estas etapas para executar um teste de amostra que compara os tempos de operação de leitura entre o DynamoDB padrão e um cluster do DAX.

1. Depois de configurar seu espaço de trabalho e instalar o `lib-dax` como uma dependência, copie [TryDax.js](DAX.client.tutorial-TryDax.md) no projeto.

1. Execute o programa no cluster do DAX. Para determinar o endpoint do cluster do DAX, escolha uma das seguintes opções: 
   +  **Usando o console do DynamoDB**: escolha seu cluster do DAX. O endpoint do cluster é mostrado no console, como no exemplo a seguir.

     ```
     dax://my-cluster.l6fzcv.dax-clusters.us-east-1.amazonaws.com
     ```
   + **Usando a AWS CLI**: insira o comando a seguir.

     ```
     aws dax describe-clusters --query "Clusters[*].ClusterDiscoveryEndpoint"
     ```

     O endpoint do cluster é mostrado na saída, como no exemplo a seguir.

     ```
     {
         "Address": "my-cluster.l6fzcv.dax-clusters.us-east-1.amazonaws.com",
         "Port": 8111,
         "URL": "dax://my-cluster.l6fzcv.dax-clusters.us-east-1.amazonaws.com"
     }
     ```

1. Agora execute o programa especificando o endpoint do cluster como um parâmetro de linha de comandos.

   ```
   node TryDax.js dax://my-cluster.l6fzcv.dax-clusters.us-east-1.amazonaws.com
   ```

   Você deve ver uma saída semelhante a:

   ```
   Attempting to create table; please wait...
   Successfully created table. Table status: ACTIVE
   Writing data to the table...
   Writing 20 items for partition key:  1
   Writing 20 items for partition key:  2
   Writing 20 items for partition key:  3
   ...
   Running GetItem Test
           Total time: 153555.10 µs - Avg time: 383.89 µs
           Total time: 44679.96 µs - Avg time: 111.70 µs
           Total time: 36885.86 µs - Avg time: 92.21 µs
           Total time: 32467.25 µs - Avg time: 81.17 µs
           Total time: 32202.60 µs - Avg time: 80.51 µs
   Running Query Test
           Total time: 14869.25 µs - Avg time: 2973.85 µs
           Total time: 3036.31 µs - Avg time: 607.26 µs
           Total time: 2468.92 µs - Avg time: 493.78 µs
           Total time: 2062.53 µs - Avg time: 412.51 µs
           Total time: 2178.22 µs - Avg time: 435.64 µs
   Running Scan Test
           Total time: 2395.88 µs - Avg time: 479.18 µs
           Total time: 2207.16 µs - Avg time: 441.43 µs
           Total time: 2443.14 µs - Avg time: 488.63 µs
           Total time: 2038.24 µs - Avg time: 407.65 µs
           Total time: 1972.17 µs - Avg time: 394.43 µs
   Running Pagination Test
   Scan Pagination
   [
     { pk: 1, sk: 1, someData: 'XXXXXXXXXX' },
     { pk: 1, sk: 2, someData: 'XXXXXXXXXX' },
     { pk: 1, sk: 3, someData: 'XXXXXXXXXX' }
   ]
   [
     { pk: 1, sk: 4, someData: 'XXXXXXXXXX' },
     { pk: 1, sk: 5, someData: 'XXXXXXXXXX' },
     { pk: 1, sk: 6, someData: 'XXXXXXXXXX' }
   ]
   ...
   Query Pagination
   [
     { pk: 1, sk: 1, someData: 'XXXXXXXXXX' },
     { pk: 1, sk: 2, someData: 'XXXXXXXXXX' },
     { pk: 1, sk: 3, someData: 'XXXXXXXXXX' }
   ]
   [
     { pk: 1, sk: 4, someData: 'XXXXXXXXXX' },
     { pk: 1, sk: 5, someData: 'XXXXXXXXXX' },
     { pk: 1, sk: 6, someData: 'XXXXXXXXXX' }
   ]
   ...
   Attempting to delete table; please wait...
   Successfully deleted table.
   ```

   Anote as informações de tempo. O número de microssegundos necessários para os testes `GetItem`, `Query` e `Scan`.

1. Nesse caso, você executou os programas no cluster do DAX. Agora você executará o programa novamente, desta vez no DynamoDB.

1. Execute o programa novamente, mas, desta vez, sem o URL do endpoint do cluster como um parâmetro de linha de comandos.

   ```
   node TryDax.js
   ```

   Observe o restante da saída e anote as informações de tempo. Os tempos decorridos para `GetItem`, `Query` e `Scan` devem ser muito mais baixos com o DAX em comparação ao DynamoDB.

## Recursos que não estão em paridade com o AWS SDK para V3
<a name="DAX.client.run-application-nodejs-3-not-in-parity"></a>
+ [Clientes básicos](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/introduction/#high-level-concepts): o Dax Node.js V3 não aceita clientes básicos. 

  ```
  const dynamoDBClient = new DynamoDBClient({ region: 'us-west-2' });
  const regularParams = {
      TableName: 'TryDaxTable',
      Key: {
          pk: 1,
          sk: 1
      }
  };
  // The DynamoDB client supports the send operation.
  const dynamoResult = await dynamoDBClient.send(new GetCommand(regularParams));
  
  // However, the DaxDocument client does not support the send operation.
  const daxClient = new DaxDocument({
      endpoints: ['your-dax-endpoint'],
      region: 'us-west-2',
  });
  
  const params = {
      TableName: 'TryDaxTable',
      Key: {
          pk: 1,
          sk: 1
      }
  };
  
  // This will throw an error - send operation is not supported for DAX. Please refer to documentation.
  const result = await daxClient.send(new GetCommand(params));
  console.log(result);
  ```
+ [Middleware Stack](https://aws.amazon.com/blogs/developer/middleware-stack-modular-aws-sdk-js/): o Dax Node.js V3 não comporta o uso de funções de Middleware.

  ```
  const dynamoDBClient = new DynamoDBClient({ region: 'us-west-2' });
  // The DynamoDB client supports the middlewareStack.
  dynamoDBClient.middlewareStack.add(
    (next, context) =>> async (args) => {
      console.log("Before operation:", args);
      const result = await next(args);
      console.log("After operation:", result);
      return result;
    },
    {
      step: "initialize", // or "build", "finalizeRequest", "deserialize"
      name: "loggingMiddleware",
    }
  );
  
  // However, the DaxDocument client does not support the middlewareStack.
  const daxClient = new DaxDocument({
      endpoints: ['your-dax-endpoint'],
      region: 'us-west-2',
  });
  
  // This will throw an error - custom middleware and middlewareStacks are not supported for DAX. Please refer to documentation.
  daxClient.middlewareStack.add(
    (next, context) => async (args) => {
      console.log("Before operation:", args);
      const result = await next(args);
      console.log("After operation:", result);
      return result;
    },
    {
      step: "initialize", // or "build", "finalizeRequest", "deserialize"
      name: "loggingMiddleware",
    }
  );
  ```

# TryDax.js
<a name="DAX.client.tutorial-TryDax"></a>

```
import { DynamoDB, waitUntilTableExists, waitUntilTableNotExists } from "@aws-sdk/client-dynamodb";
import { DaxDocument, daxPaginateScan, daxPaginateQuery } from "@amazon-dax-sdk/lib-dax";
import { DynamoDBDocument, paginateQuery, paginateScan } from "@aws-sdk/lib-dynamodb";

const region = "us-east-1";
const tableName = "TryDaxTable";

// Determine the client (DynamoDB or DAX)
let client = DynamoDBDocument.from(new DynamoDB({ region }));
if (process.argv.length > 2) {
  client = new DaxDocument({ region, endpoint: process.argv[2] });
}

// Function to create table
async function createTable() {
  const dynamodb = new DynamoDB({ region });
  const params = {
    TableName: tableName,
    KeySchema: [
      { AttributeName: "pk", KeyType: "HASH" },
      { AttributeName: "sk", KeyType: "RANGE" },
    ],
    AttributeDefinitions: [
      { AttributeName: "pk", AttributeType: "N" },
      { AttributeName: "sk", AttributeType: "N" },
    ],
    ProvisionedThroughput: { ReadCapacityUnits: 25, WriteCapacityUnits: 25 },
  };

  try {
    console.log("Attempting to create table; please wait...");
    await dynamodb.createTable(params);
    await waitUntilTableExists({ client: dynamodb, maxWaitTime: 30 }, { TableName: tableName });
    console.log("Successfully created table. Table status: ACTIVE");
  } catch (err) {
    console.error("Error in table creation:", err);
  }
}

// Function to insert data
async function writeData() {
  console.log("Writing data to the table...");
  const someData = "X".repeat(10);
  for (let ipk = 1; ipk <= 20; ipk++) {
    console.log("Writing 20 items for partition key: ", ipk)
    for (let isk = 1; isk <= 20; isk++) {
      try {
        await client.put({ TableName: tableName, Item: { pk: ipk, sk: isk, someData } });
      } catch (err) {
        console.error("Error inserting data:", err);
      }
    }
  }
}

// Function to test GetItem
async function getItemTest() {
  console.log("Running GetItem Test");
  for (let i = 0; i < 5; i++) {
    const startTime = performance.now();
    const promises = [];
    for (let ipk = 1; ipk <= 20; ipk++) {
      for (let isk = 1; isk <= 20; isk++) {
        promises.push(client.get({ TableName: tableName, Key: { pk: ipk, sk: isk } }));
      }
    }
    await Promise.all(promises);
    const endTime = performance.now();
    const iterTime = (endTime - startTime) * 1000;
    const totalTime = iterTime.toFixed(2).padStart(3, ' ');
    const avgTime = (iterTime / 400).toFixed(2).padStart(3, ' ');
    console.log(`\tTotal time: ${totalTime} \u00B5s - Avg time: ${avgTime} \u00B5s`);
  }
}

// Function to test Query
async function queryTest() {
  console.log("Running Query Test");
  for (let i = 0; i < 5; i++) {
    const startTime = performance.now();
    const promises = [];
    for (let pk = 1; pk <= 5; pk++) {
      const params = {
        TableName: tableName,
        KeyConditionExpression: "pk = :pkval and sk between :skval1 and :skval2",
        ExpressionAttributeValues: { ":pkval": pk, ":skval1": 1, ":skval2": 2 },
      };
      promises.push(client.query(params));
    }
    await Promise.all(promises);
    const endTime = performance.now();
    const iterTime = (endTime - startTime) * 1000;
    const totalTime = iterTime.toFixed(2).padStart(3, ' ');
    const avgTime = (iterTime / 5).toFixed(2).padStart(3, ' ');
    console.log(`\tTotal time: ${totalTime} \u00B5s - Avg time: ${avgTime} \u00B5s`);
  }
}

// Function to test Scan
async function scanTest() {
  console.log("Running Scan Test");
  for (let i = 0; i < 5; i++) {
    const startTime = performance.now();
    const promises = [];
    for (let pk = 1; pk <= 5; pk++) {
      const params = {
        TableName: tableName,
        FilterExpression: "pk = :pkval and sk between :skval1 and :skval2",
        ExpressionAttributeValues: { ":pkval": pk, ":skval1": 1, ":skval2": 2 },
      };
      promises.push(client.scan(params));
    }
    await Promise.all(promises);
    const endTime = performance.now();
    const iterTime = (endTime - startTime) * 1000;
    const totalTime = iterTime.toFixed(2).padStart(3, ' ');
    const avgTime = (iterTime / 5).toFixed(2).padStart(3, ' ');
    console.log(`\tTotal time: ${totalTime} \u00B5s - Avg time: ${avgTime} \u00B5s`);
  }
}

// Function to test Pagination
async function paginationTest() {
  console.log("Running Pagination Test");
  console.log("Scan Pagination");
  const scanParams = { TableName: tableName };
  const paginator = process.argv.length > 2 ? daxPaginateScan : paginateScan;
  for await (const page of paginator({ client, pageSize: 3 }, scanParams)) {
    console.log(page.Items);
  }

  console.log("Query Pagination");
  const queryParams = {
    TableName: tableName,
    KeyConditionExpression: "pk = :pkval and sk between :skval1 and :skval2",
    ExpressionAttributeValues: { ":pkval": 1, ":skval1": 1, ":skval2": 10 },
  };
  const queryPaginator = process.argv.length > 2 ? daxPaginateQuery : paginateQuery;
  for await (const page of queryPaginator({ client, pageSize: 3 }, queryParams)) {
    console.log(page.Items);
  }
}

// Function to delete the table
async function deleteTable() {
  const dynamodb = new DynamoDB({ region });
  console.log("Attempting to delete table; please wait...")
  try {
    await dynamodb.deleteTable({ TableName: tableName });
    await waitUntilTableNotExists({ client: dynamodb, maxWaitTime: 30 }, { TableName: tableName });
    console.log("Successfully deleted table.");
  } catch (err) {
    console.error("Error deleting table:", err);
  }
}

// Execute functions sequentially
(async function () {
  await createTable();
  await writeData();
  await getItemTest();
  await queryTest();
  await scanTest();
  await paginationTest();
  await deleteTable();
})();
```