Справочник по командной строке и PowerShell для эмулятора Windows (локального)

Область применения: Nosql Mongodb Кассандра Гремлин Таблица

Эмулятор Azure Cosmos DB предоставляет локальную среду, которая эмулирует службу Azure Cosmos DB для локальных целей разработки. Выполнив установку эмулятора, вы сможете управлять им с помощью команд в командной строке и PowerShell. В этой статье описывается, как использовать команды в командной строке и PowerShell для запуска и завершения работы эмулятора, настройки параметров и выполнения других операций. Описанные здесь команды нужно выполнять из расположения установки.

Синтаксис команд для управления эмулятором

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

Чтобы просмотреть список параметров, введите Microsoft.Azure.Cosmos.Emulator.exe /? в командной строке.

Управление эмулятором с помощью командлетов PowerShell

Эмулятор поставляется вместе с модулем PowerShell, который позволяет запускать, останавливать службу и получать сведения о ее состоянии. Выполните следующий командлет, чтобы использовать модуль PowerShell:

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

Или поместите PSModules каталог в каталог PSModulePath и импортируйте его, как показано в следующей команде:

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

Ниже приведена сводка команд для управления эмулятором из PowerShell:

Get-CosmosDbEmulatorStatus

Возвращает состояние эмулятора. Возвращает одно из следующих ServiceControllerStatus значений:

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

Если возникла ошибка, значение не возвращается.

Синтаксис

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

Параметры

Примеры

• Получите состояние эмулятора, установленного в папке D:\SomeFolder\AzureCosmosDBEmulator .

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

Start-CosmosDbEmulator

Запускает эмулятор на локальном компьютере. По умолчанию команда ожидает, когда эмулятор будет готов к приему запросов. -NoWait Используйте этот параметр, если вы хотите, чтобы командлет возвращался сразу после запуска эмулятора. Используйте параметры для указания параметров Start-CosmosDbEmulator , таких как порт NoSQL, прямой порт и номера портов MongoDB.

Синтаксис

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>]

Параметры

Примеры

• Запустите эмулятор и дождитесь, пока он не будет готов принять запросы.

  Start-CosmosDbEmulator
  

• Запустите эмулятор с 5 секций, зарезервированных для каждой секционированной коллекции. Общее число секций имеет значение по умолчанию: 25. Следовательно, общее количество секционированных коллекций, которые можно создать 5 = 25 partitions / 5 partitions/collection. Каждая секционированная коллекция ограничена 50 GB = 5 partitions * 10 GB / partiton.

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

• Запускает эмулятор с альтернативными номерами портов.

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

Stop-CosmosDbEmulator

Останавливает работу эмулятора. По умолчанию эта команда ожидает, когда эмулятор окончательно завершит работу. Используйте параметр -NoWait, если командлет должен вернуть результат сразу после перехода эмулятора в автономный режим.

Синтаксис

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

Параметры

Примеры

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

Uninstall-CosmosDbEmulator

Удаляет эмулятор и при необходимости удаляет полное содержимое $env:LOCALAPPDATA\CosmosDbEmulator. Командлет гарантирует остановку работы эмулятора перед удалением.

Синтаксис

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

Параметры

Примеры

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

Изменение числа контейнеров по умолчанию

По умолчанию можно создавать до 25 контейнеров фиксированного размера (только с помощью пакетов sdk для разработки программного обеспечения Azure Cosmos DB) или 5 неограниченных контейнеров с помощью эмулятора. Изменив значение PartitionCount , можно создать до 250 контейнеров фиксированного размера или 50 неограниченных контейнеров или любое сочетание двух контейнеров, не превышающих 250 контейнеров фиксированного размера (где один неограниченный контейнер = 5 контейнеров фиксированного размера). Однако мы не рекомендуем настроить эмулятор для запуска с более чем 200 контейнерами фиксированного размера. Дополнительное количество создаваемых ими операций ввода-вывода может привести к непредсказуемым превышениям времени ожидания при использовании API такой конечной точки.

Если вы пытаетесь создать контейнер после превышения текущего количества секций, эмулятор создает исключение ServiceUnavailable с приведенным ниже сообщением.

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

Чтобы изменить количество контейнеров, доступных в эмуляторе, выполните следующие действия.

1. Удалите все данные локального эмулятора, щелкнув правой кнопкой мыши значок эмулятора в области системы и нажав кнопку "Сбросить данные...".

2. Удалите все данные эмулятора в папке %LOCALAPPDATA%\CosmosDBEmulator.

3. Закройте все открытые экземпляры, щелкнув правой кнопкой мыши значок эмулятора в области системы, а затем нажмите кнопку "Выйти". Для завершения работы всех экземпляров может потребоваться несколько минут.

4. Установите последнюю версию эмулятора.

5. Запустите эмулятор с флагом PartitionCount, задав значение <= 250 Например: C:\Program Files\emulator> Microsoft.Azure.Cosmos.Emulator.exe /PartitionCount=100.

Следующие шаги

• Дополнительные сведения об эмуляторе Azure Cosmos DB
• Просмотрите заметки о выпуске эмулятора