Ferramentas do Couchbase fornecidas com a biblioteca do cliente C do Couchbase (libcouchbase)

Nesta publicação do blog, revelarei alguns dos recursos menos conhecidos da biblioteca cliente libcouchbase. Ele descreve as ferramentas da libcouchbase que estão coletivamente sob cbco comando originalmente escrito por Trond Norbye. Você provavelmente não os usará para escrever suas ligações de alto nível ou implementar seu aplicativo, mas eles ainda são úteis de várias maneiras. Eles são um ótimo exemplo de uso da libcouchbase, são úteis como ferramentas de diagnóstico ou depuração ou você pode até mesmo usá-los em seus scripts.

Como há uma versão atual (1.0) da libcouchbase e uma prévia para desenvolvedores da próxima versão (1.1) que oferece suporte à nova funcionalidade do Couchbase Server 2.0, descreverei a prévia da 1.1 e observarei quais recursos não estão acessíveis na versão atual.

[Editar] Este blog foi escrito para a nova funcionalidade das ferramentas enviadas com a libcouchbase 2.0. A versão mais recente agora é a 3.0, e você pode descobrir como instalá-la em https://docs.couchbase.com/c-sdk/3.0/hello-world/start-using-sdk.html e leia um pouco mais sobre a versão mais recente das ferramentas em https://docs.couchbase.com/c-sdk/3.0/hello-world/cbc.html#command-line

Após a instalação, você terá o comando cbc disponível e poderá verificar a versão instalada:

Observe que, no momento em que este texto foi escrito, a versão lançada atualmente é a 1.1.0dp6, mas os pacotes para as compilações mais recentes estão disponíveis no repositório de snapshot. Mais informações sobre isso no final.

Você pode imprimir todos os subcomandos possíveis usando o comando ajudasubcomando:

O comando "help" aceita o nome do comando como um argumento e mostra a descrição resumida do comando e todas as opções que o comando pode processar, por exemplo cbc ajuda cp.

Esse comando foi adicionado recentemente e pode não estar disponível em todas as versões. Ainda é possível obter a lista de comandos em qualquer versão que você tenha instalado: basta executar cbcsem argumentos e "cbc cp -help", respectivamente.

Todos os comandos podem ser acessados como subcomandos ou links simbólicos para o binário principal, por exemplo, "cbc cp" e "cbc-cp". A última forma é útil em scripts de shell.

Conexão com o cluster

Todos os comandos aceitam um conjunto comum de argumentos, como --Hospedagem, --bucket, --usuário, -senhae --timeout. Esses argumentos devem ser especificados em todos os comandos que exigem interação com clusters que precisam de opções especiais de conexão, como nome do bucket ou autorização.

A opção --enable-timingsdefinirá os tempos de registro do make cbc para todas as operações e os enviará para STDERR.

Por padrão, ele usará localhostpara --Hospedagem, padrãopara --bucket, nada para --usuário/-senhae, finalmente 2500000microssegundos para --timeout.

Se suas configurações de conexão não forem as padrão, mas você ainda não gosta de digitá-las todas as vezes, temos uma solução: basta colocar todas as configurações em um arquivo em $HOME/.cbcrce todas as ferramentas da libcouchbase usarão isso antes de iniciar. O formato é bastante simples: todas as linhas vazias e as linhas que começam com #são ignorados. Este é o meu exemplo de configuração:

Há também uma maneira de substituir o .cbcrcmas respeitam os argumentos da linha de comando: definir variáveis de ambiente. As ferramentas cbc do Couchbase examinam as seguintes variáveis na inicialização: COUCHBASE_CLUSTER_URI, COUCHBASE_CLUSTER_USER, COUCHBASE_CLUSTER_PASSWORD, COUCHBASE_CLUSTER_BUCKET.

cbc-cpcbc-cp: Copiar arquivo(s) para o cluster

Esse comando copia o conteúdo do arquivo para o cluster fornecido usando o nome do arquivo como chave. Por exemplo, o comando a seguir armazenará o conteúdo do arquivo JSON buzz.json:

Após o armazenamento, você verá o status no erro padrão. O comando cbc-cpusa o nome do arquivo como o nome da chave e o conteúdo do arquivo como um valor. É possível armazenar vários arquivos rapidamente, já que o comando canalizará as operações:

O comando também pode ler a lista de arquivos do STDIN. Por exemplo, você pode alimentar a saída do comando lscomando para cbc cp(observe que os nomes de arquivos devem ser separados por um caractere de nova linha):

cbc-create: Criar chaves com opções específicas

Esse comando cria o item no cluster com as opções fornecidas, como o tempo de expiração (--exptime), sinalizadores (--flag) ou forçá-lo a usar o comando ADD (--adicionar), que falhará se a chave já estiver no cluster. O comando opera somente em uma única chave e, em seguida, aguarda o valor em STDIN (digite um ^Dpara inserir o EOF necessário). Por exemplo:

cbc-gato: Imprimir chaves para STDOUT

Esse comando simplesmente grava o conteúdo de todas as chaves no STDOUT, como o comando Unix cat(1). Além disso, ele grava informações úteis no STDERR. Por exemplo, vamos gerar a chave Oládefinido acima:

cbc-rm: Remover chave

Esse comando remove uma determinada chave do cluster:

cbc-hash: Executar cálculo de hash

Esse comando calcula o valor de hash da chave e localiza o servidor que deve armazená-la, usando a configuração atual do cluster. Ele também grava informações úteis sobre qual vbucket é responsável pela chave, qual é o endereço desse vbucket, o ponto de extremidade para solicitações de visualizações do Couchbase e a lista de nós de réplica.

Estatísticas da cbc: Estatísticas do cluster de despejo

Esse comando retorna tuplas separadas por tabulação das estatísticas do servidor. O primeiro é o nome do host do nó com a porta, depois a chave e o valor da estatística.

Para mostrar um exemplo simples de script, veja como você pode calcular a memória usada em todo o cluster (esse cluster tem 5 nós):

A saída de estatísticas contém não apenas estatísticas do cluster ativo, mas também seus parâmetros de configuração. Você pode obter o tempo máximo e o tempo padrão (em segundos) para bloqueios de chaves (que precisaremos saber em breve):

cbc-lock: Chave de bloqueio

Esse comando bloqueia as chaves especificadas, fazendo com que todas as solicitações de mutação gerem um erro. Ele permite que você especifique o tempo de expiração ("-exptime"). Você pode inspecionar os tempos limite máximo e padrão do cluster com o comando "cbc-stats", conforme descrito acima.

O cbc-lockpermite várias teclas.

cbc-desbloqueio: Chave de desbloqueio

Esse comando desbloqueia as chaves fornecidas. Ele aceita pares de valores de chave e CAS. Se eles corresponderem, o servidor libera o bloqueio.

cbc-verify: Verificar chaves

Esse comando verifica a consistência das chaves. Ele compara o conteúdo das chaves com os arquivos correspondentes. Se tudo estiver ok, ele apenas retorna o código zero na saída e não imprime nada. Portanto, é mais interessante o caso em que algo está errado. Vamos remover buzz.jsone adicionar algo a barbie.json: