Criar um item no Azure Cosmos DB para NoSQL usando JavaScript

Os itens no Azure Cosmos DB representam uma entidade específica armazenada em 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 propósitos diferentes.

Nome	Operations
Item	Funcionalidade incluindo Ler, Patch, 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á 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.
• recurso: 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"
}

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

Importante

A propriedade id é case-sensitive. Propriedades nomeadasID, Ide iD_id serão tratadas como uma propriedade JSON arbitrária.

Depois de criado, o URI de um item está nesse 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 obter mais informações sobre as propriedades de item geradas pelo sistema no Azure Cosmos DB para NoSQL, consulte as propriedades de um item

Criar um item

Crie um item com o objeto de itens 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 do objeto Container ou alterado 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, em lote, monitorar feed de alterações, ler todos, "upsert" ou consultar itens.
• Item (singular): ler, corrigir, 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 de leitura do objeto Item.

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

Excluir um item

Exclua o item com o método de exclusão 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 o item.

Ler um item