Bewährte Methoden für Azure Cosmos DB für NoSQL in GitHub Copilot für Visual Studio Code

Gilt für:: ✅ NoSQL

GitHub Copilot in Visual Studio Code bietet intelligente Codevorschläge, aber diese Vorschläge werden noch leistungsfähiger, wenn sie Ihren spezifischen Datenbankkontext verstehen. Die Azure Cosmos DB für Visual Studio Code-Erweiterung stellt jetzt automatisch GitHub Copilot mit Azure Cosmos DB spezifischen bewährten Methoden und Empfehlungen bereit, um kontextbezogene KI-Unterstützung für Ihre Datenbankentwicklung zu ermöglichen.

Wenn Sie über die Visual Studio Code-Erweiterung eine Verbindung mit Ihrem Azure Cosmos DB-Konto herstellen, wird automatisch eine azurecosmosdb.instructions.md Datei im Benutzerprofilordner erstellt. Diese Datei fungiert als Kontextanbieter für GitHub Copilot, um sicherzustellen, dass die KI Ihr Azure Cosmos DB-Setup versteht und optimierte Vorschläge für Partitionierung, Leistungsoptimierung, Diagnose und vieles mehr bietet.

Warum kontextbewusste KI wichtig ist

KI-Codierungsassistenten wie GitHub Copilot sind nur so effektiv wie der Kontext, den sie haben. Ohne zu verstehen, wie Ihre Anwendung mit Azure Cosmos DB interagiert – z. B. Partitionierungsstrategien, Indizierungsmuster oder Abfragedesign – generiert Copilot möglicherweise Vorschläge, die für Ihre Datenbankeinrichtung nicht optimiert sind.

Mit der automatischen Bereitstellung der azurecosmosdb.instructions.md Datei erhält Copilot sofortigen Zugriff auf:

Bewährte Methoden für Azure Cosmos DB bei der Gestaltung von Partitionsschlüsseln und Durchsatzverwaltung
Tipps zur Leistungsoptimierung für Abfragen mit mehreren Partitionen und Indizierung
Diagnoseprotokollierungsempfehlungen für die Problembehandlung bei Latenz oder Fehlern
Kostengünstige Einrichtungsleitfaden für verschiedene Szenarien, einschließlich Vektorsuche
SDK-Verwendungsmuster und Fehlerbehandlungsstrategien

Prerequisites

Visual Studio Code auf Ihrem Computer installiert
GitHub Copilot-Abonnement (Einzel-, Geschäfts- oder Unternehmensabonnement)
Ein Azure Cosmos DB-Konto (beliebige API)
Azure-Abonnement mit entsprechenden Berechtigungen für den Zugriff auf Cosmos DB-Ressourcen

Schritt 1: Installieren erforderlicher Erweiterungen

Stellen Sie zunächst sicher, dass sowohl die Azure Cosmos DB-Erweiterung als auch die GitHub Copilot-Erweiterung installiert sind:

Installieren der Azure Cosmos DB-Erweiterung

Öffnen von Visual Studio Code
Wechseln Sie zur Ansicht "Erweiterungen", indem Sie "Erweiterungen anzeigen" > auswählen oder STRG+UMSCHALT+X (Windows/Linux) oder CMD+UMSCHALT+X (macOS) drücken.
Suchen Sie nach "Azure Cosmos DB", oder verwenden Sie die Erweiterungs-ID: ms-azuretools.vscode-cosmosdb
Wählen Sie "Installieren " für die Azure-Datenbanken-Erweiterung von Microsoft aus.
Laden Sie Visual Studio Code erneut, wenn Sie dazu aufgefordert werden.

Installieren von GitHub Copilot

Suchen Sie in der Ansicht "Erweiterungen " nach "GitHub Copilot".
Installieren der GitHub Copilot-Erweiterung von GitHub
Melden Sie sich bei Ihrem GitHub-Konto an, wenn Sie dazu aufgefordert werden
Aktivieren Sie Ihr Copilot-Abonnement, wenn Sie es noch nicht getan haben.

Schritt 2: Herstellen einer Verbindung mit Ihrem Azure Cosmos DB-Konto

Verbinden Sie Ihr Azure Cosmos DB-Konto, um die kontextfähigen Features zu aktivieren:

Für Azure Cosmos DB für NoSQL

Öffnen Sie in Visual Studio Code den Azure-Bereich , indem Sie das Azure-Symbol in der Aktivitätsleiste auswählen.
Melden Sie sich mit der Microsoft Entra-ID bei Ihrem Azure-Konto an
Erweitern Sie In der Azure-Strukturansicht Ihr Abonnement
Suchen und Erweitern von Azure Cosmos DB
Klicken Sie mit der rechten Maustaste auf Ihr Azure Cosmos DB für NoSQL-Konto, oder wählen Sie es aus, um eine Verbindung herzustellen.

Note

Wenn Sie sich in einer Unternehmensumgebung mit Netzwerkeinschränkungen befinden, müssen Sie möglicherweise Firewallregeln konfigurieren, um Ihre IP-Adresse zuzulassen. Erwägen Sie zunächst, alle IP-Adressen (0.0.0.0 - 255.255.255.255) zum Testen zuzulassen und dann die Zulassungsliste für die Produktionsverwendung zu verfeinern.

Schritt 3: Überprüfen der Bereitstellung von Kontextdateien

Nach der Verbindung erstellt die Erweiterung automatisch die azurecosmosdb.instructions.md Datei im Benutzerprofilordner:

Windows-Standort:

%APPDATA%\Code\User\prompts\azurecosmosdb.instructions.md

macOS-Speicherort:

~/Library/Application Support/Code/User/prompts/azurecosmosdb.instructions.md

Linux-Standort:

~/.config/Code/User/prompts/azurecosmosdb.instructions.md

Diese Datei wird automatisch in Ihrem Benutzerprofil bereitgestellt, sodass sie in allen Visual Studio Code-Arbeitsbereichen verfügbar ist, ohne dass in jedem Projekt dupliziert werden muss.

Schritt 4: Erleben Sie Kontextbezogene Vorschläge

Jetzt bietet GitHub Copilot Azure-Cosmos-DB-optimierte Vorschläge. Hier sind einige Beispiele dafür, wie der erweiterte Kontext Ihre Entwicklungserfahrung verbessert:

Optimierte Abfragevorschläge

Wenn Sie Abfragen schreiben, versteht Copilot jetzt Azure Cosmos DB-spezifische Muster:

// Copilot will suggest optimized query patterns
const query = {
    query: "SELECT * FROM c WHERE c.partitionKey = @partitionKey AND c.status = @status",
    parameters: [
        { name: "@partitionKey", value: userId },
        { name: "@status", value: "active" }
    ]
};

Empfehlungen für bewährte Methoden

Copilot schlägt die folgenden bewährten Methoden für die Datenmodellierung von Azure Cosmos DB vor:

// Copilot suggests embedding related data for single-partition queries
const userDocument = {
    id: userId,
    partitionKey: userId, // Copilot suggests consistent partition key usage
    profile: {
        name: "John Doe",
        email: "john@example.com",
        preferences: {
            theme: "dark",
            notifications: true
        }
    },
    // Embed frequently accessed related data
    recentActivity: [
        { action: "login", timestamp: "2024-01-01T10:00:00Z" },
        { action: "purchase", timestamp: "2024-01-01T11:30:00Z" }
    ]
};

Fehlerbehandlung und Diagnose

Copilot schlägt geeignete Fehlerbehandlungsmuster vor, die für Azure Cosmos DB spezifisch sind:

try {
    const response = await container.items.create(document);
    console.log("Document created successfully");
} catch (error) {
    // Copilot suggests Azure Cosmos DB-specific error handling
    if (error.code === 429) {
        console.log("Rate limited. Retry after:", error.retryAfterInMilliseconds);
        // Implement exponential backoff
    } else if (error.code === 409) {
        console.log("Document already exists");
    } else {
        console.error("Error creating document:", error.message);
        // Log diagnostic information for troubleshooting
        console.log("Diagnostic info:", response.diagnostics);
    }
}

Vorteile von Entwicklern

Diese Integration wandelt die Azure Cosmos DB-Erweiterung in mehr als nur ein Verwaltungstool um – es wird zu einer KI-Wissensschicht in Ihrer Entwicklungsumgebung. Mit kontextbezogener Unterstützung können Sie:

✅ Schreiben optimierter Abfragen und SDK-Aufrufe , die durch kontextbezogene bewährte Methoden geführt werden
✅ Vermeiden sie häufige Fallstricke frühzeitig in der Entwicklung
✅ Erhalten Sie Vorschläge, die mit den realen Azure Cosmos DB-Richtlinien übereinstimmen, statt mit generischer Datenbanklogik
✅ Verbessern der Leistung durch KI-vorgeschlagene Optimierungen
✅ Verringern der Entwicklungszeit mit relevanten, kontextfähigen Codeabschlussen

Anpassen der Anleitungen

Die azurecosmosdb.instructions.md Datei ist geöffnet und erweiterbar. Sie haben folgende Möglichkeiten:

Überprüfen Sie die Datei , um zu verstehen, welcher Kontext für Copilot bereitgestellt wird
Hinzufügen von projektspezifischen Anleitungen für die Codierungsstandards Ihres Teams
Beitragen von Verbesserungen durch Übermitteln von Pullanforderungen an das GitHub-Repository
Melden von Problemen oder Vorschlägen im Abschnitt "Probleme"

Alternative: Azure Cosmos DB Agent Kit

Für eine umfassendere Abdeckung sollten Sie das Azure Cosmos DB Agent Kit als Alternative oder Ergänzung zur Anleitungsdatei verwenden. Das Agent Kit bietet Folgendes:

45+ kuratierte Regeln in acht Kategorien (Datenmodellierung, Partitionsschlüssel, Abfragen, SDKs, Indizierung, Durchsatz, globale Verteilung und Überwachung)
Prioritätsbasierte Anleitungen mit Regeln, die nach realen Auswirkungen bewertet werden
Umfassendere Kompatibilität mit GitHub Copilot, Claude Code, Gemini CLI und anderen Tools, die mit Agent Skills kompatibel sind
Beiträge der Gemeinschaft für kontinuierlich aktualisierte bewährte Methoden

Installieren Sie das Agent Kit mit einem einzigen Befehl:

npx add-skill AzureCosmosDB/cosmosdb-agent-kit

Deaktivieren der Anweisungendatei

Wenn Sie lieber nur das Agent Kit verwenden oder die Datei für automatische Anweisungen deaktivieren möchten:

Navigieren Sie zu Ihrem Benutzerprofilordner:
- Windows: %APPDATA%\Code\User\prompts\
- macOS: ~/Library/Application Support/Code/User/prompts/
- Linux: ~/.config/Code/User/prompts/
Löschen oder Umbenennen der azurecosmosdb.instructions.md Datei
Erstellen Sie optional eine leere Datei mit demselben Namen, um zu verhindern, dass die Erweiterung neu erstellt wird.

Note

Die Erweiterung kann die Anweisungendatei neu erstellen, wenn Sie eine Verbindung mit Ihrem Azure Cosmos DB-Konto herstellen. Um sie dauerhaft zu deaktivieren, können Sie eine Sicherung Ihrer bevorzugten Konfiguration erstellen oder das Agent Kit exklusiv verwenden.

Bewährte Methoden für maximalen Nutzen

So profitieren Sie von dieser kontextfähigen KI-Unterstützung optimal:

1. Halten Sie Ihre Erweiterung auf dem neuesten Stand

Aktualisieren Sie regelmäßig die Azure Cosmos DB-Erweiterung, um die neuesten bewährten Methoden und Verbesserungen zu erhalten.

2. Verwenden sie beschreibende Variablennamen

Copilot bietet bessere Vorschläge, wenn Ihr Code klare, beschreibende Namen verwendet, die Azure Cosmos DB-Konzepte angeben:

// Good - Clear Azure Cosmos DB context
const cosmosClient = new CosmosClient({ endpoint, key });
const database = cosmosClient.database("productCatalog");
const container = database.container("products");

// Less optimal - Generic naming
const client = new CosmosClient({ endpoint, key });
const db = client.database("productCatalog");
const coll = db.container("products");

3. Fügen Sie Kommentare zu Ihrem Datenmodell ein

Helfen Sie Copilot, relevantere Vorschläge bereitzustellen, indem Sie Kommentare zu Ihrer Partitionierungsstrategie und Ihrem Datenmodell hinzufügen:

// Partition by userId to ensure user data is co-located
// Embed user preferences to minimize cross-partition queries
const userDocument = {
    id: generateUserId(),
    partitionKey: userId, // Using userId as partition key for user isolation
    // ... rest of document
};

4. Verwenden der Datenverwaltungsfeatures der Erweiterung

Verwenden Sie die integrierten Features der Erweiterung zusammen mit Copilot für eine vollständige Entwicklungserfahrung:

Abfrage-Editor zum Testen und Optimieren von Abfragen
Dokumentverwaltung für die Echtzeitbearbeitung
Leistungsmetriken zum Verständnis der Abfragekosten
Exportfunktionen für datenanalyse

Troubleshooting

Copilot stellt keine Azure Cosmos DB-spezifischen Vorschläge bereit

Überprüfen der Dateibereitstellung: Überprüfen, ob azurecosmosdb.instructions.md in Ihrem Benutzerprofilordner vorhanden ist
Visual Studio Code neu starten: Manchmal ist ein Neustart erforderlich, damit Änderungen wirksam werden.
GitHub Copilot-Status überprüfen: Sicherstellen, dass Copilot aktiv und ordnungsgemäß authentifiziert ist
Erneute Verbindung mit Azure Cosmos DB: Versuchen Sie, Ihr Konto zu trennen und erneut zu verbinden

Erweiterung, die die Anweisungendatei nicht bereitstellt

Aktualisieren Sie die Erweiterung: Stellen Sie sicher, dass Sie über die neueste Version der Azure Cosmos DB-Erweiterung verfügen
Überprüfen von Berechtigungen: Überprüfen, ob Visual Studio Code Schreibberechtigungen für den Benutzerprofilordner hat
Manuelle Verbindung: Versuchen Sie, eine manuelle Verbindung mit Ihrem Azure Cosmos DB-Konto über die Erweiterung herzustellen.

Feedback

War diese Seite hilfreich?

Last updated on 2026-04-27