Referensi baris perintah dan PowerShell untuk emulator Windows (lokal)

BERLAKU UNTUK: NoSQL MongoDB Cassandra Gremlin Meja

Emulator Azure Cosmos DB menyediakan lingkungan lokal yang meniru layanan Azure Cosmos DB untuk tujuan pengembangan lokal. Setelah menginstal emulator,Anda dapat mengontrol emulator dengan baris perintah dan perintah PowerShell. Artikel ini menjelaskan cara menggunakan perintah baris perintah dan PowerShell untuk memulai dan menghentikan emulator, mengonfigurasi opsi, dan melakukan operasi lainnya. Anda harus menjalankan perintah dari lokasi pemasangan.

Mengelola emulator dengan sintaks baris perintah

Microsoft.Azure.Cosmos.Emulator.exe 
    [/Shutdown] [/DataPath] [/Port] [/MongoPort] 
    [/DirectPorts] [/Key] [/EnableRateLimiting] 
    [/DisableRateLimiting] [/NoUI] [/NoExplorer] 
    [/EnableMongoDbEndpoint] 
    [/?]

Untuk melihat daftar parameter, ketik Microsoft.Azure.Cosmos.Emulator.exe /? pada prompt perintah.

Mengelola emulator dengan cmdlet PowerShell

Emulator dilengkapi dengan modul PowerShell untuk memulai, menghentikan, menghapus instalasi, dan mengambil status layanan. Jalankan cmdlet berikut menggunakan modul PowerShell:

Import-Module "$env:ProgramFiles\Azure Cosmos DB Emulator\PSModules\Microsoft.Azure.CosmosDB.Emulator"

Atau letakkan PSModules direktori pada Anda PSModulePath dan impor seperti yang ditunjukkan dalam perintah berikut:

$env:PSModulePath += ";$env:ProgramFiles\Azure Cosmos DB Emulator\PSModules"
Import-Module Microsoft.Azure.CosmosDB.Emulator

Berikut adalah ringkasan perintah untuk mengontrol emulator dari PowerShell:

Get-CosmosDbEmulatorStatus

Mendapatkan status emulator. Mengembalikan salah satu nilai ini ServiceControllerStatus :

• ServiceControllerStatus.StartPending
• ServiceControllerStatus.Running
• ServiceControllerStatus.Stopped

Jika terjadi kesalahan, tidak ada nilai yang dikembalikan.

Sintaks

Get-CosmosDbEmulatorStatus 
    [[-AlternativeInstallLocation] <String>] 
    [<CommonParameters>]

Parameter

Contoh

• Dapatkan status emulator yang diinstal di D:\SomeFolder\AzureCosmosDBEmulator folder.

  @parameters = {
      AlternativeInstallLocation = "D:\SomeFolder\AzureCosmosDBEmulator"
  }
  Get-CosmosDbEmulatorStatus @parameters
  

Start-CosmosDbEmulator

Memulai emulator di komputer lokal. Secara default, perintah menunggu hingga emulator siap menerima permintaan. -NoWait Gunakan opsi , jika Anda ingin cmdlet kembali segera setelah memulai emulator. Gunakan parameter Start-CosmosDbEmulator untuk menentukan opsi, seperti port NoSQL, port langsung, dan nomor port MongoDB.

Sintaks

Start-CosmosDbEmulator [-AllowNetworkAccess]
    [-AlternativeInstallLocation <String>] [-CassandraPort <UInt16>]
    [-ComputePort <UInt16>] [-Consistency <String>] [-Credential
    <PSCredential>] [-DataPath <String>] [-DefaultPartitionCount
    <UInt16>] [-DirectPort <UInt16[]>] [-EnableMongoDb]
    [-EnableCassandra] [-EnableGremlin] [-EnableTable]
    [-EnableSqlCompute] [-EnablePreview]
    [-FailOnSslCertificateNameMismatch] [-GremlinPort <UInt16>]
    [-TablePort <UInt16>] [-SqlComputePort <UInt16>] [-Key <String>]
    [-MongoPort <UInt16>] [-MongoApiVersion <String>] [-NoFirewall]
    [-NoTelemetry] [-NoUI] [-NoWait] [-PartitionCount <UInt16>] [-Port
    <UInt16>] [-SimulateRateLimiting] [-Timeout <UInt32>] [-Trace]
    [<CommonParameters>]

Parameter

Contoh

• Mulai emulator dan tunggu hingga siap untuk menerima permintaan.

  Start-CosmosDbEmulator
  

• Mulai emulator dengan 5 partisi yang dicadangkan untuk setiap koleksi yang dipartisi. Jumlah total partisi diatur ke default: 25. Oleh karena itu, jumlah total koleksi yang dipartisi yang dapat dibuat adalah 5 = 25 partitions / 5 partitions/collection. Setiap koleksi yang dipartisi dibatasi di 50 GB = 5 partitions * 10 GB / partiton.

  @parameters = {
      DefaultPartitionCount = 5
  }
  Start-CosmosDbEmulator @parameters
  

• Memulai emulator dengan nomor port alternatif.

  @parameters = {
      Port = 443 
      MongoPort = 27017 
      DirectPort = 20001,20002,20003,20004
  }
  Start-CosmosDbEmulator @parameters
  

Stop-CosmosDbEmulator

Menghentikan emulator. Secara default, perintah ini menunggu hingga emulator sepenuhnya dimatikan. Gunakan opsi -NoWait, jika Anda ingin cmdlet kembali segera setelah mulai mematikan emulator.

Sintaks

Stop-CosmosDbEmulator 
    [[-AlternativeInstallLocation] <String>]
    [-NoWait] [[-Timeout] <UInt32>] [-Trace] 
    [<CommonParameters>]

Parameter

Contoh

@parameters = {
    NoWait = $true
}
Stop-CosmosDbEmulator @parameters

Uninstall-CosmosDbEmulator

Menghapus instalan emulator dan secara opsional menghapus konten $env:LOCALAPPDATA\CosmosDbEmulatorlengkap . Cmdlet memastikan emulator dihentikan sebelum menghapus instalasinya.

Sintaks

Uninstall-CosmosDbEmulator 
    [-RemoveData] 
    [<CommonParameters>]

Parameter

Contoh

@parameters = {
    RemoveData = $false
}
Uninstall-CosmosDbEmulator @parameters

Mengubah jumlah kontainer default

Secara default, Anda dapat membuat hingga 25 kontainer ukuran tetap (hanya didukung menggunakan kit pengembangan perangkat lunak (SDK) Azure Cosmos DB, atau 5 kontainer tanpa batas menggunakan emulator. Dengan memodifikasi nilai PartitionCount , Anda dapat membuat hingga 250 kontainer ukuran tetap atau 50 kontainer tidak terbatas, atau kombinasi apa pun dari keduanya yang tidak melebihi 250 kontainer ukuran tetap (di mana satu kontainer tak terbatas = 5 kontainer ukuran tetap). Namun, kami tidak menyarankan Anda menyiapkan emulator untuk dijalankan dengan lebih dari 200 kontainer ukuran tetap. Karena overhead yang ditambahkan ke operasi IO disk, yang menghasilkan batas waktu yang tidak dapat diprediksi saat menggunakan API titik akhir.

Jika Anda mencoba membuat kontainer setelah jumlah partisi saat ini terlampaui, emulator akan menampilkan pengecualian ServiceUnavailable, dengan pesan berikut.

Sorry, we are currently experiencing high demand in this region, and cannot fulfill your request at this time. We work continuously to bring more and more capacity online, and encourage you to try again.
ActivityId: 12345678-1234-1234-1234-123456789abc

Untuk mengubah jumlah kontainer yang tersedia di emulator, jalankan langkah-langkah berikut:

1. Hapus semua data emulator lokal dengan mengklik kanan ikon emulator pada baki sistem, lalu klik Reset Data....

2. Hapus semua data emulator di folder %LOCALAPPDATA%\CosmosDBEmulator ini.

3. Keluar dari semua instans terbuka dengan mengklik kanan ikon emulator pada baki sistem, lalu klik Keluar. Mungkin perlu waktu satu menit agar semua instans keluar.

4. Instal emulator versi terbaru.

5. Luncurkan emulator dengan flag PartitionCount dengan menetapkan nilai <= 250. Misalnya: C:\Program Files\emulator> Microsoft.Azure.Cosmos.Emulator.exe /PartitionCount=100.

Langkah berikutnya

• Pelajari selengkapnya tentang emulator Azure Cosmos DB
• Tinjau catatan rilis emulator