Crie um item no Azure Cosmos DB para NoSQL usando JavaScript

Os itens no Azure Cosmos DB representam uma entidade específica armazenada num contentor. Na API para NoSQL, um item consiste em dados formatados em JSON com um identificador exclusivo.

Item, definição do item e resposta do item

No SDK JavaScript, os três objetos relacionados com um item têm propósitos diferentes.

Nome	Operations
Número	Funcionalidades que incluem Ler, Atualizar, Substituir, Eliminar.
ItemDefinição	O teu objeto de dados personalizado. Inclui id e ttl propriedades automaticamente.
ItemResponse	Inclui statusCode, item, e outras propriedades.

Use as propriedades do objeto ItemResponse para compreender o resultado da operação.

• statusCode: Código de estado HTTP. Uma resposta bem-sucedida situa-se na faixa dos 200-299.
• activityId: Identificador único para a operação, como criar, ler, substituir ou eliminar.
• etag: Etiqueta de entidade associada aos dados. Use para concorrência otimista, armazenamento em cache e pedidos condicionais.
• item: Objeto item usado para realizar operações como ler, substituir, eliminar.
• Recurso: Os seus dados personalizados.

Criar um identificador exclusivo para um item

O identificador único é uma cadeia distinta que identifica um artigo dentro de um contentor. A id propriedade é a única obrigatória ao criar um novo documento JSON. Por exemplo, este documento JSON é um item válido no Azure Cosmos DB:

{
  "id": "unique-string-2309509"
}

No âmbito de um contentor, dois itens não podem partilhar o mesmo identificador único.

Importante

A id propriedade distingue entre maiúsculas e minúsculas. Propriedades nomeadas ID, Id, iD, e _id serão tratadas como propriedades JSON arbitrárias.

Uma vez criado, o URI de um item está neste formato:

https://<cosmos-account-name>.documents.azure.com/dbs/<database-name>/docs/<item-resource-identifier>

Ao referenciar o item usando um URI, use o identificador de recurso gerado pelo sistema em vez do id campo. Para mais informações sobre propriedades de itens gerados pelo sistema no Azure Cosmos DB para NoSQL, consulte propriedades de um item

Criar um item

Crie um item com o objeto item do contentor usando o método create .

const { statusCode, item, resource, activityId, etag} = await container.items.create({ 
        id: '2', 
        category: 'gear-surf-surfboards',
        name: 'Sunnox Surfboard',
        quantity: 8,
        sale: true 
    });

Aceda a um item

Acede a um item através do objeto Item . Isto pode ser acedido a partir do objeto Container ou alterado a partir do objeto Database ou do CosmosClient.

// Chained, then use a method of the Item object such as `read`
const { statusCode, item, resource, activityId, etag} = await client.database(databaseId).container(containerId).item(itemId).read();

Acesso por objeto:

• Itens (plural): Criar, agrupar, monitorizar mudanças no feed, ler tudo, fazer upsert ou consultar itens.
• Item (singular): Ler, atualizar, substituir ou eliminar um item.

Substituir um item

Substitua os dados pelo objeto Item com o método de substituição .

const { statusCode, item, resource, activityId, etag} = await item.replace({ 
        id: '2', 
        category: 'gear-surf-surfboards-retro',
        name: 'Sunnox Surfboard Retro',
        quantity: 5,
        sale: false 
    });

Leia o item

Leia os dados mais recentes com o método de leitura do objeto Item.

const { statusCode, item, resource, activityId, etag} = await item.read();

Excluir um item

Apaga o item com o método delete do objeto Item.

const { statusCode, item, activityId, etag} = await item.delete();

Próximos passos

Agora que já criou vários itens, use o próximo guia para pesquisar o item.

Ler um item