Partilhar via


Criar um item no Azure Cosmos DB para NoSQL usando JavaScript

APLICA-SE A: NoSQL

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

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

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

Nome Operações
Item Funcionalidade incluindo Ler, Corrigir, Substituir, Excluir.
ItemDefinition Seu objeto de dados personalizado. Inclui id e ttl propriedades automaticamente.
ItemResponse Inclui statusCode, iteme 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á na faixa de 200-299.
  • activityId: identificador exclusivo para a operação, como criar, ler, substituir ou excluir.
  • etag: Tag de entidade associada aos dados. Use para simultaneidade otimista, cache e solicitações condicionais.
  • item: objeto de item usado para executar operações como ler, substituir, excluir.
  • resource: Os 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 id propriedade é a única propriedade necessá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 escopo de um contêiner, dois itens não podem compartilhar o mesmo identificador exclusivo.

Importante

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

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 fazer referência ao item usando um URI, use o identificador de recurso gerado pelo sistema em vez do id campo. Para obter mais informações sobre propriedades de item geradas pelo sistema no Azure Cosmos DB para NoSQL, consulte 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 
    });

Aceder a 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:

  • Itens (plural): Criar, agrupar, observar feed de alterações, ler tudo, upsert ou consultar itens.
  • Item (singular): Leia, corrija, substitua ou exclua 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 de leitura do objeto Item.

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

Eliminar um item

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

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

Próximos passos

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