Partilhar via


Emulador baseado em Linux (visualização)

A próxima geração do emulador do Azure Cosmos DB é totalmente baseada em Linux e está disponível como um contêiner do Docker. Ele suporta a execução em uma ampla variedade de processadores e sistemas operacionais.

Importante

Esta versão do emulador suporta apenas a API para NoSQL no modo gateway, com um subconjunto selecionado de recursos. Para obter mais informações, consulte Suporte a recursos.

Pré-requisitos

Instalação

Obtenha a imagem do contêiner do Docker usando docker pullo . A imagem do contêiner é publicada no Microsoft Artifact Registry como mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-preview.

docker pull mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-preview

Em Execução

Para executar o contêiner, use docker run. Depois, use docker ps para validar se o contêiner está em execução.

docker run --detach --publish 8081:8081 --publish 1234:1234 mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-preview

docker ps
CONTAINER ID   IMAGE                                                             COMMAND                  CREATED         STATUS         PORTS                                                                                  NAMES
c1bb8cf53f8a   mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-preview  "/bin/bash -c /home/…"   5 seconds ago   Up 5 seconds   0.0.0.0:1234->1234/tcp, :::1234->1234/tcp, 0.0.0.0:8081->8081/tcp, :::8081->8081/tcp   <container-name>

Nota

O emulador é composto por dois componentes:

  • Data explorer - explore interativamente os dados no emulador. Por padrão, isso é executado na porta 1234
  • Emulador do Azure Cosmos DB - uma versão local do serviço de banco de dados do Azure Cosmos DB. Por padrão, isso é executado na porta 8081.

O ponto de extremidade do gateway do emulador normalmente está disponível na porta 8081 no endereço http://localhost:8081. Para navegar até o explorador de dados, use o endereço http://localhost:1234 no navegador da Web. Pode levar alguns segundos para que o data explorer esteja disponível. O ponto de extremidade do gateway normalmente está disponível imediatamente.

Importante

Os SDKs .NET e Java não suportam o modo HTTP no emulador. Como esta versão do emulador começa com HTTP por padrão, você precisará habilitar explicitamente o HTTPS ao iniciar o contêiner (veja abaixo). Para o Java SDK, você também precisará instalar certificados.

docker run --detach --publish 8081:8081 --publish 1234:1234 mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-preview --protocol https

Comandos do Docker

A tabela a seguir resume os comandos do Docker disponíveis para configurar o emulador. Esta tabela detalha os argumentos correspondentes, variáveis de ambiente, valores permitidos, configurações padrão e descrições de cada comando.

Necessidade Arg Env Valores permitidos Predefinido Description
Imprima as configurações para stdout a partir do contêiner --help, -h N/A N/D N/A Exibir informações sobre a configuração disponível
Definir a porta do ponto de extremidade Cosmos --port [INT] PORTA INT 8081 A porta do ponto de extremidade Cosmos no contêiner. Você ainda precisa publicar essa porta (por exemplo, -p 8081:8081).
Especificar o protocolo usado pelo ponto de extremidade Cosmos --protocol PROTOCOLO https, http, https-insecure http O protocolo do ponto de extremidade Cosmos no contêiner.
Ativar o explorador de dados --enable-explorer ENABLE_EXPLORER true, false true Habilite a execução do Cosmos Data Explorer no mesmo contêiner.
Definir a porta usada pelo data explorer --explorer-port EXPLORER_PORT INT 1234 A porta do Cosmos Data Explorer no contêiner. Você ainda precisa publicar essa porta (por exemplo, -p 1234:1234).
O usuário deve ser capaz de especificar o protocolo usado pelo explorador, caso contrário, padrão para o que o ponto de extremidade Cosmos está usando --explorer-protocol EXPLORER_PROTOCOL https, http, https-insecure <the value of --protocol> O protocolo do Cosmos Data Explorer no contêiner. O padrão é a configuração de protocolo no ponto de extremidade do Cosmos.
Especifique a chave via arquivo --key-file [PATH] KEY_FILE CAMINHO <default secret> Substitua a chave padrão pela chave especificada no arquivo. Você precisa montar esse arquivo no contêiner (por exemplo, se KEY_FILE=/mykey, você adicionaria uma opção como a seguinte à sua execução do docker: --mount type=bind,source=./myKey,target=/myKey)
Definir o caminho de dados --data-path [PATH] DATA_PATH CAMINHO /data Especifique um diretório para dados. Usado com freqüência com docker run --mount a opção (por exemplo, se DATA_PATH=/usr/cosmos/data, você adicionaria uma opção como a seguinte à sua execução do docker: --mount type=bind,source=./.local/data,target=/usr/cosmos/data)
Especifique o caminho de certificado a ser usado para https --cert-path [PATH] CERT_PATH CAMINHO <default cert> Especifique um caminho para um certificado para proteger o tráfego. Você precisa montar esse arquivo no contêiner (por exemplo, se CERT_PATH=/mycert.pfx, você adicionaria uma opção como a seguinte à execução do docker: --mount type=bind,source=./mycert.pfx,target=/mycert.pfx)
Especifique o segredo de certificado a ser usado para https N/A CERT_SECRET string <default secret> O segredo para o certificado especificado em CERT_PATH.
Definir o nível de log --log-level [LEVEL] LOG_LEVEL quiet, error, warn, info, debug, trace info A verbosidade dos logs emitidos pelo emulador e pelo explorador de dados.
Habilitar o envio de informações de diagnóstico para a Microsoft --enable-telemetry ENABLE_TELEMETRY true, false true Habilite o envio de logs para a Microsoft para nos ajudar a melhorar o emulador.

Suporte de funcionalidades

Este emulador está em desenvolvimento ativo e visualização. Como resultado, nem todos os recursos do Azure Cosmos DB são suportados. Alguns recursos também não serão suportados no futuro. Esta tabela inclui o estado de vários recursos e seu nível de suporte.

Caraterística Suporte
API de lote ✅ Suportado
API em massa ✅ Suportado
Alterar feed ⚠️ Ainda não implementado
Criar e ler documentos com dados utf ✅ Suportado
Criar coleção ✅ Suportado
Criar conflito de coleção duas vezes ✅ Suportado
Criar coleção com política de índice personalizada ⚠️ Ainda não implementado
Criar coleção com expiração ttl ⚠️ Ainda não implementado
Criar base de dados ✅ Suportado
Criar conflito de banco de dados duas vezes ✅ Suportado
Criar documento ✅ Suportado
Criar coleção particionada ⚠️ Ainda não implementado
Excluir coleção ✅ Suportado
Excluir banco de dados ✅ Suportado
Eliminar documento ✅ Suportado
Obter e alterar o desempenho da coleção ⚠️ Ainda não implementado
Inserir documento grande ✅ Suportado
Documento de patch ⚠️ Ainda não implementado
Consultar coleção particionada em paralelo ⚠️ Ainda não implementado
Consulta com agregados ⚠️ Ainda não implementado
Consultar e filtrar ⚠️ Ainda não implementado
Consulta com, filtro e projeção ⚠️ Ainda não implementado
Consulta com igualdade ✅ Suportado
Consulta com igual em id ✅ Suportado
Consulta com junções ⚠️ Ainda não implementado
Consulta com ordem por ✅ Suportado
Consulta com ordem por para coleção particionada ⚠️ Ainda não implementado
Consulta com ordem por números ✅ Suportado
Consulta com ordem por cadeias de caracteres ⚠️ Ainda não implementado
Consulta com paginação ⚠️ Ainda não implementado
Consulta com operadores de intervalo data horas ⚠️ Ainda não implementado
Consulta com operadores de intervalo em números ⚠️ Ainda não implementado
Consulta com operadores de intervalo em cadeias de caracteres ⚠️ Ainda não implementado
Consulta com associação única ⚠️ Ainda não implementado
Consulta com matemática de cadeia de caracteres e operadores de matriz ⚠️ Ainda não implementado
Consulta com subdocumentos ⚠️ Ainda não implementado
Consulta com duas junções ⚠️ Ainda não implementado
Consulta com duas junções e filtro ⚠️ Ainda não implementado
Ler coleção ✅ Suportado
Ler feed de coleção ⚠️ Ainda não implementado
Ler base de dados ✅ Suportado
Ler feed de banco de dados ⚠️ Ainda não implementado
Ler o documento ✅ Suportado
Ler feed de documentos ✅ Suportado
Substituir documento ✅ Suportado
Unidades de Pedido ⚠️ Ainda não implementado
Procedimentos armazenados ❌ Não previsto
Acionadores ❌ Não previsto
FDU ❌ Não previsto
Atualizar coleção ⚠️ Ainda não implementado
Atualizar documento ✅ Suportado

Limitações

Além dos recursos ainda não suportados ou não planejados, a lista a seguir inclui as limitações atuais do emulador.

  • O SDK do .NET para Azure Cosmos DB não oferece suporte à execução em massa no emulador.
  • Os SDKs .NET e Java não suportam o modo HTTP no emulador.

Instalando certificados para Java SDK

Ao usar o Java SDK para Azure Cosmos DB com esta versão do emulador no modo https, é necessário instalar seus certificados em seu armazenamento confiável Java local.

Obter certificado

Em uma bash janela, execute o seguinte:

# If the emulator was started with /AllowNetworkAccess, replace localhost with the actual IP address of it:
EMULATOR_HOST=localhost
EMULATOR_PORT=8081
EMULATOR_CERT_PATH=/tmp/cosmos_emulator.cert
openssl s_client -connect ${EMULATOR_HOST}:${EMULATOR_PORT} </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > $EMULATOR_CERT_PATH

Instalar certificado

Navegue até o diretório de sua instalação java onde cacerts o arquivo está localizado (substitua abaixo pelo diretório correto):

cd "C:/Program Files/Eclipse Adoptium/jdk-17.0.10.7-hotspot/bin"

Importe o certificado (pode ser-lhe pedida uma palavra-passe, o valor predefinido é "changeit"):

keytool -cacerts -importcert -alias cosmos_emulator -file $EMULATOR_CERT_PATH

Se você receber um erro porque o alias já existe, exclua-o e execute o acima novamente:

keytool -cacerts -delete -alias cosmos_emulator

Comunicar problemas

Se você encontrar problemas com o uso desta versão do emulador, abra um problema no repositório GitHub (https://github.com/Azure/azure-cosmos-db-emulator-docker) e marque-o com o rótulo cosmosEmulatorVnextPreview.