Introdução
Esta será a terceira postagem de uma série sobre o Couchbase Mobile pilha. Você pode encontrar a primeira e a segunda postagens aqui e aquirespectivamente. Eles cobrem a instalação de Servidor Couchbase e algumas partes interessantes de Console da Web do Couchbase. Nesta postagem, falaremos sobre como trabalhar com o Couchbase Server a partir da linha de comando.
Histórico
Para se familiarizar com toda a pilha, é ótimo instalar e executar tudo em sua máquina de desenvolvimento. Nesta série de postagens, explicarei as etapas para começar a usar cada componente. Também mostrarei como fazer uma pequena exploração extra ao longo do caminho.
Farei apenas a configuração mínima. O objetivo não é explicar o que você precisa para um ambiente de produção. Presumo que você conheça alguns conceitos básicos de NoSQL, tenha algum conhecimento sobre o Couchbase e saiba como criar aplicativos em algo como Java, Android ou iOS. Se quiser ler sobre bancos de dados NoSQL ou sobre o Couchbase, você pode encontrar muitos recursos no site Couchbase local.
O Couchbase é de código aberto. Tudo o que usarei aqui é gratuito para ser testado. Consulte o final da postagem para obter mais recursos se precisar de ajuda.
Linha de comando
O Couchbase Server tem várias ferramentas de linha de comando. Ele também tem uma API REST extensa. Vamos dar uma olhada em alguns pontos interessantes.
Utilitários de linha de comando
Em um Mac, geralmente você pode encontrar as ferramentas de linha de comando em /Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin.
Você pode descobrir os locais dos comandos para Linux e Windows aqui: http://developer.couchbase.com/documentation/server/current/cli/cli-intro.html
couchbase-cli: a ferramenta de gerenciamento de cluster de linha de comando
Essa ferramenta pode funcionar em nós únicos ou em clusters inteiros. Ela oferece suporte a comandos para tudo, desde a manipulação de buckets até replicações entre centros de dados. Aqui estão apenas alguns exemplos.
Lista de servidores
O próximo comando retornará uma breve lista de servidores em um cluster.
|
1 |
$ couchbase-cli servidor-lista -c localhost:8091 -u Administrador -p senha |
Saída
|
1 |
ns_1@127.0.0.1 127.0.0.1:8091 saudável ativo |
Como era de se esperar, isso mostra que temos um servidor ativo em execução localmente.
(Observação: para ser breve, deixarei de lado as opções de cluster, nome de usuário e senha daqui para frente. No entanto, você precisará delas para os comandos reais).
Coleta de registros
Podemos ativar o registro. Há opções para carregar automaticamente os dados para o suporte.
|
1 |
$ couchbase-cli coletar-registros-iniciar --todos-nós |
Saída
|
1 |
SUCESSO: Registro coleção iniciado |
Em seguida, verifique o status.
|
1 |
$ couchbase-cli coletar-registros-status |
Saída
|
1 2 3 4 5 |
Status: concluído Detalhes: Nó: ns_1@127.0.0.1 Status: coletados caminho : /Usuários/hod/Biblioteca/Aplicativo Suporte/Couchbase/var/lib/couchbase/tmp/coleta de informações-2016-12-06T213207-ns_1@127.0.0.1.zip |
E pare de registrar.
|
1 |
$ couchbase-cli coletar-registros-parar |
Saída
|
1 |
SUCESSO: coletar registros com sucesso interrompido |
Os arquivos de registro são extensos. A amostra aqui continha muitos arquivos e mais de um megabyte de informações. Tudo isso é texto que você pode examinar. Se você precisar de suporte para uma instalação do CB Server, é bom saber como obter esses dados.
cbq: o shell de linha de comando para N1QL
A outra ferramenta que examinaremos é o cbq, o shell interativo para executar consultas N1QL.
Nesse caso, o comando fará um loop solicitando a entrada de dados. Comece executando sem opções.
|
1 |
$ cbq |
Você deverá ver imediatamente alguns avisos e o prompt de comando.
|
1 2 3 4 5 |
Não entrada credenciais. Em ordem para conectar para a servidor com autenticação, por favor fornecer credenciais. Conectado para : http://Digite Ctrl-D ou QUIT para sair. Caminho para histórico arquivo para o casca : /Usuários/hod/.cbq_history cbq> |
Criar um índice primário
Para executar consultas, você precisará pelo menos de um índice primário. Algumas versões dos dados da amostra de cerveja vêm com um, outras não.
|
1 |
cbq> CRIAR PRIMÁRIO ÍNDICE em `cerveja-amostra`; |
Saída
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
{ "requestID": "e708d3aa-cfa4-4322-9c8c-a6b6524ba99b", "assinatura": nulo, "resultados": [ ], "status": "sucesso", "métricas": { "elapsedTime" (tempo decorrido): "579.828473ms", "executionTime": "578.844657ms", "resultCount": 0, "resultSize": 0 } } |
Consultas em execução
Aqui está um exemplo de uma consulta bastante simples.
|
1 |
cbq> SELECIONAR DISTINTO categoria, estilo DE `cerveja-amostra` ONDE tipo = "cerveja" E estilo GOSTO "%Imperial%" ORDEM BY categoria, estilo; |
Saída
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
{ "requestID": "2d4b3052-d42f-4081-bff1-1a06576dec92", "assinatura": { "category" (categoria): "json", "estilo": "json" }, "resultados": [ { "category" (categoria): "North American Ale" (cerveja norte-americana), "estilo": "Imperial Stout de estilo americano" }, { "category" (categoria): "North American Ale" (cerveja norte-americana), "estilo": "Imperial ou Double India Pale Ale" }, { "category" (categoria): "North American Ale" (cerveja norte-americana), "estilo": "Imperial ou Double Red Ale" } ], "status": "sucesso", "métricas": { "elapsedTime" (tempo decorrido): "259.555065ms", "executionTime": "259.496458ms", "resultCount": 3, "resultSize": 331, "sortCount": 3 } } |
Selecionamos todas as cervejas que têm "Imperial" como parte de sua descrição de estilo.
Observe os ticks posteriores em torno da amostra de cerveja. Eles são necessários por causa do traço no nome.
O N1QL deve lhe parecer familiar se você conhece SQL. O N1QL é um superconjunto do SQL. Os dados JSON geralmente não são planos como os dados relacionais. O N1QL tem extensões para fazer coisas como desenrolar matrizes. Você pode ler mais sobre o N1QL aqui.
Para entender o N1QL com mais profundidade, recomendo que você experimente este excelente tutorial interativo.
Você pode encontrar uma postagem útil de Nic Raboy sobre recursos mais avançados do cbq aqui.
API REST
O Couchbase Server tem um conjunto extenso de Pontos de extremidade REST. A maioria deles tem a ver com o gerenciamento de implementações.
Mostrarei exemplos usando o curl. Há uma ferramenta muito boa que eu recomendo como substituta do curl, httpie. É um pouco mais fácil de usar e cria uma saída colorida. Não o usarei aqui, pois o curl é mais comumente encontrado.
Acho outros pontos de extremidade interessantes para ver o que eles produzem, mas, para nossos propósitos, vou me concentrar nas consultas.
Ver consultas
Em minha postagem anterior sobre o Console da Web do CouchbaseNa última semana, demos uma olhada nas visualizações. As visualizações criam um índice estático que você pode usar para recuperar informações. Você pode controlar a resposta com várias opções. Grande parte do valor das visualizações vem de como você define as funções de mapa/redução, mas essas opções aprimoram ainda mais o uso das visualizações para consultar dados. A filtragem por chave é especialmente útil. Vamos dar uma olhada.
Você acessa as visualizações usando URIs do tipo
|
1 |
OBTER /[balde-nome]/_design/[ddoc-nome]/_visualizar/[visualização-nome] |
Para nossa amostra de cerveja, podemos obter todas as informações sobre a cervejaria e a cerveja da seguinte forma.
|
1 |
$ enrolar http://localhost:8092/beer-sample/_design/beer/_view/brewery_beers |
Isso gera muitas informações. Aqui está apenas uma pequena amostra da saída.
|
1 2 3 4 |
{"total_rows":7303,"rows" (linhas):[ {"id":"21st_amendment_brewery_cafe","chave":["21st_amendment_brewery_cafe"],"valor":nulo}, {"id":"21st_amendment_brewery_cafe-21a_ipa","chave":["21st_amendment_brewery_cafe","21st_amendment_brewery_cafe-21a_ipa"],"valor":nulo}, {"id":"21st_amendment_brewery_cafe-563_stout","chave":["21st_amendment_brewery_cafe","21st_amendment_brewery_cafe-563_stout"],"valor":nulo}, |
Você pode ver as principais informações. Podemos usar isso para restringir os resultados. Aqui está um exemplo usando uma única chave.
|
1 |
$ enrolar -g http://localhost:8092/beer-sample/_design/beer/_view/brewery_beers?key='["yuksom_breweries"]' |
E o resultado.
|
1 2 3 4 |
{"total_rows":7303,"rows" (linhas):[ {"id":"yuksom_breweries","chave":["yuksom_breweries"],"valor":nulo} ] } |
Observe que adicionei um sinalizador -g. Por padrão, o Curl permite certos tipos de correspondência de padrões (globbing). Isso funciona usando os caracteres especiais {} e []. Precisamos deles para especificar a chave no JSON. A maneira mais fácil é desativar o globbing. Não se esqueça também das aspas simples ao redor do parâmetro.
Esse exemplo foi filtrado por uma chave. Aqui está um que mostra como obter resultados que correspondem a mais de uma chave de cada vez.
|
1 |
$ enrolar -g -u Administrador:senha http://localhost:8092/beer-sample/_design/beer/_view/brewery_beers?keys='[["yuksom_breweries"],["wild_duck_brewing"]]' |
Observe que a saída não está classificada.
|
1 2 3 4 5 |
{"total_rows":7303,"rows" (linhas):[ {"id":"yuksom_breweries","chave":["yuksom_breweries"],"valor":nulo}, {"id":"cervejaria wild_duck","chave":["cervejaria wild_duck"],"valor":nulo} ] } |
Além do uso na depuração (ou apenas na compreensão do que está acontecendo) de exibições, já vi algumas coisas legais escritas usando apenas scripts de shell e esse tipo de consulta.
Consultas N1QL
Acontece que você também pode executar consultas N1QL a partir da linha de comando. Aqui está um exemplo simples que extrai tudo do balde de amostras de cerveja.
|
1 |
$ enrolar http://localhost:8093/query/service?statement='SELECT%20*%20FROM%20`beer-sample`' |
A saída inclui algumas estatísticas e os documentos completos. (As estatísticas são enviadas para stderr em um Mac).
|
1 2 3 |
% Total % Recebido % Xferd Média Velocidade Tempo Tempo Tempo Atual Dload Carregar Total Gastos Esquerda Velocidade 100 16240 0 16240 0 0 299k 0 --:--:-- --:--:-- --:--:-- 299k |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
{ "requestID": "936d7b6a-1dea-4625-a6b2-1be91967187e", "assinatura": { "*": "*" }, "resultados": [ { "amostra de cerveja": { "endereço": [ "563 Second Street" ], "cidade": "São Francisco", "código": "94107", "país": "Estados Unidos", "description" (descrição): "A 21st Amendment Brewery oferece uma variedade de cervejas artesanais premiadas e cozinha americana grelhada em um ambiente confortável como um loft. Junte-se a nós antes e depois dos jogos de beisebol do Giants em nossa cervejaria ao ar livre. Um ótimo local para eventos e festas em nosso Brewers Loft semiprivado. Vejo você em breve no 21A!", "geo": { "precisão": "ROOFTOP", "lat": 37.7825, "longo": -122.393 }, "name" (nome): "Café da Cervejaria 21ª Emenda", "telefone": "1-415-369-0900", "estado": "Califórnia", "tipo": "cervejaria", "atualizado": "2010-10-24 13:54:07", "website": "http://www.21st-amendment.com/" } }, { "amostra de cerveja": { ... |
The N1QL command must have certain characters encoded to work properly. In this case, you can probably guess that %20 is the encoding for a single space. You can read more about that on this Postagem no Stack Overflow.
Próximas etapas
Passamos um bom tempo analisando o Couchbase Server. Em seguida, entraremos na área de dispositivos móveis, mergulhando no Gateway de sincronização. Seguirei mais ou menos o mesmo formato. No caso do Sync Gateway, porém, veremos que há muito mais a fazer usando as APIs REST. Isso incluirá alguns truques para ajudar no diagnóstico de problemas comuns. Depois disso, daremos uma olhada no Couchbase Lite e, em seguida, encerraremos tudo examinando a movimentação de dados de ponta a ponta em toda a pilha. Fique ligado.
[buttongroup][button style="btn-link btn-lg" icon="fa fa-arrow-left" align="left" iconcolor="#dd3333″ type="link" target="false" title="Anterior: Console da Web do Couchbase" link="https://www.couchbase.com/blog/comfortable-couchbase-mobile-couchbase-web-console/" linkrel=""][button style="btn-link btn-lg" icon="fa fa-arrow-right" align="left" iconcolor="#dd3333″ type="link" target="false" title="Next: Instalando o Sync Gateway" link="https://www.couchbase.com/blog/getting-comfortable-couchbase-mobile-installing-sync-gateway/" linkrel=""][/buttongroup]
Pós-escrito
Confira mais recursos em nosso portal do desenvolvedor e nos siga no Twitter @CouchbaseDev.
Você pode postar perguntas em nosso fóruns. E participamos ativamente de Estouro de pilha.
Você pode me seguir pessoalmente em @HodGreeley
[...] Anterior: Instalando o Couchbase Server Próximo: Couchbase Server via linha de comando [...]
[...] Anterior: Couchbase Server via linha de comando Próximo: Sync Gateway por meio da linha de comando [...]