Herramientas Couchbase incluidas con la biblioteca cliente C de Couchbase (libcouchbase)

En esta entrada del blog, voy a revelar algunas de las características menos conocidas de la biblioteca cliente libcouchbase. Describe las herramientas de libcouchbase que están colectivamente bajo cbcel comando originalmente escrito por Trond Norbye. Probablemente no los utilices para escribir tus bindings de alto nivel o implementar tu aplicación, pero siguen siendo útiles de muchas maneras. Son un gran ejemplo del uso de libcouchbase, son útiles como herramientas de diagnóstico o depuración o incluso puedes usarlas en tus scripts.

Debido a que existe una versión actual (1.0) de libcouchbase y una vista previa para desarrolladores de la próxima versión (1.1) que soporta la nueva funcionalidad que viene en Couchbase Server 2.0, describiré la vista previa 1.1 y señalaré qué características no son accesibles en la versión actual.

[Editar] Este blog fue escrito para la nueva funcionalidad en las herramientas que se envían con libcouchbase 2.0. La última versión es ahora la 3.0, y puedes encontrar información sobre cómo instalarla en https://docs.couchbase.com/c-sdk/3.0/hello-world/start-using-sdk.html y lea un poco más sobre la última versión de las herramientas en https://docs.couchbase.com/c-sdk/3.0/hello-world/cbc.html#command-line

Tras la instalación tendrás disponible el comando cbc y podrás comprobar la versión instalada:

Tenga en cuenta que, en el momento de escribir esto, la versión actual es 1.1.0dp6, pero los paquetes para las versiones más recientes están disponibles a través del repositorio de instantáneas. Más información al final.

Puede imprimir todos los subcomandos posibles con la función ayudasubcomando:

El comando "help" acepta el nombre del comando como argumento y muestra la breve descripción del comando y todas las opciones que el comando puede procesar, p. ej. cbc ayuda cp.

Este comando se ha añadido recientemente y puede que no esté disponible en todas las versiones. Todavía es posible obtener la lista de comandos en cualquier versión que tenga instalada: simplemente ejecute cbcsin argumentos y "cbc cp -help" correspondientemente.

Todos los comandos son accesibles como subcomandos o enlaces simbólicos al binario principal, por ejemplo, "cbc cp" y "cbc-cp". Esta última forma es útil en scripts de shell.

Conexión al clúster

Todos los comandos aceptan un conjunto común de argumentos como --host, --bucket, --usuario, --contraseñay --timeout. Estos argumentos deben especificarse en todos los comandos que requieran interacción con clústeres que necesiten opciones de conexión especiales, como nombre de bucket o autorización.

La opción --enable-timingshará que cbc registre los tiempos de todas las operaciones y los enviará a STDERR.

Por defecto utilizará localhostpara --host, por defectopara --bucketnada para --usuario/--contraseñay por último 2500000microsegundos para --timeout.

Si tu configuración de conexión no es la predeterminada, pero aún así no te gusta escribirla cada vez, tenemos la solución: simplemente pon toda la configuración en un archivo en $HOME/.cbcrcy todas las herramientas libcouchbase lo utilizarán antes de comenzar. El formato es bastante simple: todas las líneas vacías y las que empiezan por #se omiten. Este es mi ejemplo de configuración:

También hay una forma de anular la función .cbcrcpero respetan los argumentos de la línea de comandos: establecer variables de entorno. Las herramientas cbc de Couchbase consultan las siguientes variables al iniciarse: COUCHBASE_CLUSTER_URI, COUCHBASE_CLUSTER_USER, COUCHBASE_CLUSTER_PASSWORD, COUCHBASE_CLUSTER_BUCKET.

cbc-cpcbc-cp: Copiar archivo(s) al cluster

Este comando copia el contenido de un archivo al cluster dado usando el nombre del archivo como clave. Por ejemplo, el siguiente comando almacenará el contenido del archivo JSON buzz.json:

Después de almacenar verá el estado en el error estándar. El comando cbc-cputiliza el nombre del archivo como nombre clave y el contenido del archivo como valor. Es posible almacenar varios archivos rápidamente, ya que el comando canalizará las operaciones:

El comando también puede leer la lista de archivos desde STDIN. Por ejemplo, puede alimentar la salida del comando lscomando para cbc cp(tenga en cuenta que los nombres de archivo deben separarse con un carácter de nueva línea):

cbc-crear: Crear claves con opciones específicas

Este comando crea el elemento en el cluster con las opciones dadas, como el tiempo de expiración (--exptime), banderas (--flag) o forzarlo a utilizar el comando ADD (--añadir) que fallará si la clave ya está en el cluster. El comando opera sobre una sola clave y luego espera el valor en STDIN (escriba a ^Dpara insertar el EOF requerido). Por ejemplo:

cbc-gato: Imprimir claves en STDOUT

Este comando simplemente escribe el contenido de todas las claves a STDOUT como el comando Unix cat(1). También escribe información útil en STDERR. Por ejemplo, podemos obtener la clave holapuesto arriba:

cbc-rm: Quitar llave

Este comando elimina una clave determinada del clúster:

cbc-hash: Realizar el cálculo hash

Este comando calcula el valor hash de la clave y localiza el servidor que debería almacenarla, usando la configuración actual del cluster. También escribe información útil sobre qué vbucket es responsable de la clave, cuál es la dirección de ese vbucket, el endpoint para peticiones de Couchbase Views y la lista de nodos réplica.

cbc-stats: Volcado de estadísticas de cluster

Este comando devuelve tuplas separadas por tabuladores de las estadísticas del servidor. Primero está el nombre de host del nodo con el puerto, luego la clave stat y el valor stat.

Para mostrar un ejemplo sencillo de scripting, así es como se puede calcular la memoria utilizada en todo el cluster (este cluster tiene 5 nodos):

La salida de estadísticas no sólo contiene estadísticas del clúster en vivo, sino también sus parámetros de configuración. Puede obtener el tiempo máximo y predeterminado (en segundos) para los bloqueos de teclas (que querremos conocer pronto):

cbc-lock: Llave de cerradura

Este comando bloquea las claves especificadas, haciendo que todas las peticiones de mutación generen un error. Permite especificar el tiempo de expiración ("-exptime"). Puede inspeccionar los tiempos de expiración máximos y predeterminados del clúster con el comando "cbc-stats", tal y como se ha descrito anteriormente.

En cbc-lockpermite varias teclas.

cbc-desbloquear: Llave de desbloqueo

Este comando desbloquea las claves dadas. Acepta pares de valores clave y CAS. Si coinciden, el servidor libera el bloqueo.

cbc-verify: Verificar claves

Este comando verifica la consistencia de las claves. Compara el contenido de las claves con los archivos correspondientes. Si todo está bien, devuelve un código cero a la salida y no imprime nada. Así que es más interesante el caso de que algo vaya mal. Eliminemos buzz.jsony añadir algo a barbie.json: