Dela via

Snabbstart: Använda Azure Cosmos DB för NoSQL med Azure SDK för Node.js

  • Artikel
  • Gäller för:
    ✅ NoSQL

I den här snabbstarten distribuerar du ett grundläggande Azure Cosmos DB for Table-program med hjälp av Azure SDK för Node.js. Azure Cosmos DB for Table är ett schemalöst datalager som gör att program kan lagra strukturerade tabelldata i molnet. Du lär dig hur du skapar tabeller, rader och utför grundläggande uppgifter i din Azure Cosmos DB-resurs med hjälp av Azure SDK för Node.js.

API-referensdokumentation Bibliotek källkodspaket | (npm) | Azure Developer CLI |

Förutsättningar

  • Azure Developer CLI
  • Docker Desktop
  • Node.js 22 eller senare

Om du inte har något Azure-konto skapar du ett kostnadsfritt konto innan du börjar.

Initiera projektet

Använd Azure Developer CLI (azd) för att skapa ett Azure Cosmos DB för tabellkonto och distribuera ett containerbaserat exempelprogram. Exempelprogrammet använder klientbiblioteket för att hantera, skapa, läsa och fråga efter exempeldata.

  1. Öppna en terminal i en tom katalog.

  2. Om du inte redan är autentiserad autentiserar du till Azure Developer CLI med .azd auth login Följ stegen som anges av verktyget för att autentisera till CLI med dina önskade Azure-autentiseringsuppgifter.

    azd auth login

  3. Använd azd init för att initiera projektet.

    azd init --template cosmos-db-nosql-nodejs-quickstart

  4. Under initieringen konfigurerar du ett unikt miljönamn.

  5. Distribuera Azure Cosmos DB-kontot med .azd up Bicep-mallarna distribuerar också ett exempelwebbprogram.

    azd up

  6. Under etableringsprocessen väljer du din prenumeration, önskad plats och målresursgrupp. Vänta tills etableringsprocessen har slutförts. Processen kan ta ungefär fem minuter.

  7. När etableringen av dina Azure-resurser är klar inkluderas en URL till det webbprogram som körs i utdata.

    Deploying services (azd deploy)

  (✓) Done: Deploying service web
- Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>

SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.

  8. Använd URL:en i konsolen för att navigera till webbprogrammet i webbläsaren. Observera utdata från appen som körs.

Skärmbild av webbprogrammet som körs.

Skärmbild av webbprogrammet som körs.

Installera klientbiblioteket

Klientbiblioteket är tillgängligt via Node Package Manager som @azure/cosmos paket.

  1. Öppna en terminal och navigera till /src mappen.

    cd ./src

  2. Om det inte redan är installerat installerar du @azure/cosmos paketet med .npm install

    npm install --save @azure/cosmos

  3. Installera även paketet om det @azure/identity inte redan är installerat.

    npm install --save @azure/identity

  4. Öppna och granska filen src/package.json för att verifiera att båda posterna azure-cosmos och azure-identity finns.

Objektmodell

Name beskrivning
CosmosClient Den här klassen är den primära klientklassen och används för att hantera kontoomfattande metadata eller databaser.
Database Den här klassen representerar en databas i kontot.
Container Den här klassen används främst för att utföra läs-, uppdaterings- och borttagningsåtgärder på antingen containern eller objekten som lagras i containern.
PartitionKey Den här klassen representerar en logisk partitionsnyckel. Den här klassen krävs för många vanliga åtgärder och frågor.
SqlQuerySpec Det här gränssnittet representerar en SQL-fråga och alla frågeparametrar.

Kodexempel

Exempelkoden i mallen använder en databas med namnet cosmicworks och containern med namnet products. Containern products innehåller information som namn, kategori, kvantitet, en unik identifierare och en försäljningsflagga för varje produkt. Containern använder egenskapen /category som en logisk partitionsnyckel.

Autentisera klienten

Det här exemplet skapar en ny instans av typen och autentiserar CosmosClient med hjälp av en DefaultAzureCredential instans.

const credential = new DefaultAzureCredential();

const client = new CosmosClient({
    '<azure-cosmos-db-nosql-account-endpoint>',
    aadCredentials: credential
});

const credential: TokenCredential = new DefaultAzureCredential();

const client = new CosmosClient({
    '<azure-cosmos-db-nosql-account-endpoint>',
    aadCredentials: credential
});

Hämta en databas

Använd client.database för att hämta den befintliga databasen med namnet cosmicworks.

const database = client.database('cosmicworks');

const database: Database = client.database('cosmicworks');

Hämta en container

Hämta den befintliga products containern med .database.container

const container = database.container('products');

const container: Container = database.container('products');

Skapa ett objekt

Skapa ett nytt objekt med alla medlemmar som du vill serialisera till JSON. I det här exemplet har typen en unik identifierare och fält för kategori, namn, kvantitet, pris och försäljning. Skapa ett objekt i containern med .container.items.upsert Den här metoden "upserts" objektet ersätter objektet effektivt om det redan finns.

const item = {
    'id': 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    'category': 'gear-surf-surfboards',
    'name': 'Yamba Surfboard',
    'quantity': 12,
    'price': 850.00,
    'clearance': false
};

let response = await container.items.upsert(item);

const item: Product = {
    'id': 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    'category': 'gear-surf-surfboards',
    'name': 'Yamba Surfboard',
    'quantity': 12,
    'price': 850.00,
    'clearance': false
};

let response: ItemResponse<Product> = await container.items.upsert<Product>(item);

Läsa ett objekt

Utför en punktläsningsåtgärd med hjälp av både de unika identifierarna (id) och partitionsnyckelfälten. Använd container.item för att hämta en pekare till ett objekt och item.read för att effektivt hämta det specifika objektet.

const id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb';
const partitionKey = 'gear-surf-surfboards';

let response = await container.item(id, partitionKey).read();
let read_item = response.resource;

const id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb';
const partitionKey = 'gear-surf-surfboards';

let response: ItemResponse<Product> = await container.item(id, partitionKey).read<Product>();
let read_item: Product = response.resource!;

Frågeobjekt

Utför en fråga över flera objekt i en container med hjälp av container.items.query. Hitta alla objekt i en angiven kategori med den här parameteriserade frågan:

SELECT * FROM products p WHERE p.category = @category

Hämta alla resultat av frågan med hjälp query.fetchAllav . Loopa igenom resultatet av frågan.

const querySpec = {
    query: 'SELECT * FROM products p WHERE p.category = @category',
    parameters: [
        {
            name: '@category',
            value: 'gear-surf-surfboards'
        }
    ]
};

let response = await container.items.query(querySpec).fetchAll();
for (let item of response.resources) {
    // Do something
}

const querySpec: SqlQuerySpec = {
    query: 'SELECT * FROM products p WHERE p.category = @category',
    parameters: [
        {
            name: '@category',
            value: 'gear-surf-surfboards'
        }
    ]
};

let response: FeedResponse<Product> = await container.items.query<Product>(querySpec).fetchAll();
for (let item of response.resources) {
    // Do something
}

Rensa resurser

När du inte längre behöver exempelprogrammet eller resurserna tar du bort motsvarande distribution och alla resurser.

azd down

Relaterat innehåll