Criar um item no Azure Cosmos DB for NoSQL usando JavaScript

APLICA-SE A: NoSQL

Os itens do Azure Cosmos DB representam uma entidade específica armazenada dentro de um contêiner. Na API do NoSQL, um item consiste em dados formatados em JSON com um identificador exclusivo.

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

No SDK do JavaScript, os três objetos relacionados a um item têm finalidades diferentes.

Nome	Operations
Item	Funcionalidade incluindo Read, Patch, Replace, Delete.
ItemDefinition	Seu objeto de dados personalizado. Inclui as propriedades id e ttl automaticamente.
ItemResponse	Inclui statusCode, item e outras propriedades.

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

• statusCode: código de status HTTP. Uma resposta bem-sucedida está no intervalo de 200 a 299.
• activityId: identificador exclusivo para a operação, como criar, ler, substituir ou excluir.
• etag: marca de entidade associada aos dados. Use para simultaneidade otimista, cache e solicitações condicionais.
• item: objeto Item usado para executar operações como ler, substituir, excluir.
• resource: seus dados personalizados.

Criar um identificador exclusivo para um item

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

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

No escopo de um contêiner, dois itens não podem compartilhar o mesmo identificador exclusivo.

Importante

A propriedade id diferencia maiúsculas de minúsculas. Propriedades denominadas ID, Id, iD e _id serão tratadas como uma propriedade JSON arbitrária.

Depois de criado, o URI de um item estará nesse formato:

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

Ao fazer referência ao item usando um URI, use o identificador de recurso gerado pelo sistema em vez do campo id. Para obter mais informações sobre propriedades de item geradas pelo sistema no Azure Cosmos DB for NoSQL, confira Propriedades de um item

Criar um item

Crie um item com o objeto items do contêiner 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 
    });

Acessar um item

Acesse um item por meio do objeto Item . Isso pode ser acessado a partir do objeto Container ou alterado a partir dos objetos Database ou 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:

• Items (plural): criar, agrupar em lote, observar o feed de alterações, ler tudo, executar upsert ou consultar itens.
• Item (singular): ler, aplicar patch, substituir ou excluir um item.

Substituir um item

Substitua os dados pelo objeto Item pelo método replace .

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

Ler um item

Leia os dados mais atuais com o método read do objeto Item.

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

Excluir um item

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

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

Próximas etapas

Agora que você criou vários itens, use o próximo guia para consultar um item.

Ler um item