Snabbstart: Azure Cosmos DB för NoSQL-bibliotek för Node.js

GÄLLER FÖR: NoSQL

• .NET
• Node.js
• Java
• Python
• Kör

Kom igång med Azure Cosmos DB for NoSQL-klientbiblioteket för Node.js för att köra frågor mot data i containrarna och utföra vanliga åtgärder på enskilda objekt. Följ de här stegen för att distribuera en minimal lösning till din miljö med hjälp av Azure Developer CLI.

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

Förutsättningar

• Ett Azure-konto med en aktiv prenumeration. Skapa ett konto utan kostnad.
• GitHub-konto

• Ett Azure-konto med en aktiv prenumeration. Skapa ett konto utan kostnad.
• Azure Developer CLI
• Docker Desktop

Konfigurera

Distribuera projektets utvecklingscontainer till din miljö. Använd sedan Azure Developer CLI (azd) för att skapa ett Azure Cosmos DB för NoSQL-konto och distribuera ett containerbaserat exempelprogram. Exempelprogrammet använder klientbiblioteket för att hantera, skapa, läsa och fråga efter exempeldata.

Viktigt!

GitHub-konton innehåller en berättigande till lagring och kärntimmar utan kostnad. Mer information finns i inkluderade lagrings- och kärntimmar för GitHub-konton.

1. Öppna en terminal i projektets rotkatalog.

2. Autentisera 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-dotnet-quickstart
   

   Kommentar

   Den här snabbstarten använder GitHub-lagringsplatsen azure-samples/cosmos-db-nosql-dotnet-quickstart . Azure Developer CLI klonar automatiskt det här projektet till datorn om det inte redan finns där.

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

   Dricks

   Miljönamnet används också som målresursgruppnamn. För den här snabbstarten bör du överväga att använda msdocs-cosmos-db.

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 och önskad plats. 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.

   

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

• Autentisera klienten
• Hämta en databas
• Hämta en container
• Skapa ett objekt
• Hämta ett objekt
• Frågeobjekt

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

Programbegäranden till de flesta Azure-tjänster måste auktoriseras. Använd typen DefaultAzureCredential som det bästa sättet att implementera en lösenordslös anslutning mellan dina program och Azure Cosmos DB för NoSQL. DefaultAzureCredential stöder flera autentiseringsmetoder och avgör vilken metod som ska användas vid körning.

Viktigt!

Du kan också auktorisera begäranden till Azure-tjänster med hjälp av lösenord, anslutningssträng eller andra autentiseringsuppgifter direkt. Den här metoden bör dock användas med försiktighet. Utvecklare måste vara noggranna för att aldrig exponera dessa hemligheter på en osäker plats. Alla som får åtkomst till lösenordet eller den hemliga nyckeln kan autentisera till databastjänsten. DefaultAzureCredential ger bättre hanterings- och säkerhetsfördelar jämfört med kontonyckeln för att tillåta lösenordslös autentisering utan risk för lagring av nycklar.

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

JavaScript

const credential = new DefaultAzureCredential();

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

TypeScript

const credential = 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.

JavaScript

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

TypeScript

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

Hämta en container

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

JavaScript

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

TypeScript

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.

JavaScript

const item = {
    'id': '70b63682-b93a-4c77-aad2-65501347265f',
    'category': 'gear-surf-surfboards',
    'name': 'Yamba Surfboard',
    'quantity': 12,
    'price': 850.00,
    'clearance': false
};

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

TypeScript

const item: Product = {
    'id': '70b63682-b93a-4c77-aad2-65501347265f',
    '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.

JavaScript

const id = '70b63682-b93a-4c77-aad2-65501347265f';
const partitionKey = 'gear-surf-surfboards';

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

TypeScript

const id = '70b63682-b93a-4c77-aad2-65501347265f';
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.

JavaScript

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
}

TypeScript

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
}

Relaterat innehåll

• .NET-snabbstart
• Snabbstart för Java
• Snabbstart för Python
• Snabbstart för Go