martes, 2 de diciembre de 2014

Administrar Couchbase buckets con curl y Api Rest

Hola, hoy expondré como administrar los buckets (bases de datos) de Couchbase a través de la API Rest y curl.

En los siguientes comandos deberán sustituir los términos listados a continuación:


[ipOHost] por la dirección IP o nombre de su servidor Couchbase, en los ejemplos usaré: 127.0.0.1.
[administrador] por el nombre del usuario administrador del servidor Couchbase, en los ejemplos usaré: elTodoPoderoso.
[contraseña] por la contraseña del usuario administrador, en los ejemplos usaré: miPasswordSeguro.
[bucket] por el bucket a consultar, administrar o crear, en los ejemplos usaré: misDocumentos.
[contraseñaDeAcceso] por la contraseña de lectura del bucket, en los ejemplos usaré: miContraseñaDeAcceso.

Comandos:

  1. Ver información de todos los buckets.

    Comando:
    curl -u [administrador]:[contraseña] http://[ipOHost]:8091/pools/default/buckets -v

    Ejemplo:
    curl -u elTodoPoderoso:miPasswordSeguro http://127.0.0.1:8091/pools/default/buckets -v

    Nota: En los comandos de CURL use la opción -v para ver a mejor detalle la respuesta de los comandos, también puede servir para ver posibles errores. Se puede omitir el parámetro -v.

  2. Ver información de un solo bucket.

    Comando:
    curl -u [administrador]:[contraseña] http://[ipOHost]:8091/pools/default/buckets/[bucket] -v

    Ejemplo:
    curl -u elTodoPoderoso:miPasswordSeguro http://127.0.0.1:8091/pools/default/buckets/misDocumentos -v

  3. Ver estadísticas de un bucket.

    Comando:
    curl -u [administrador]:[contraseña] http://[ipOHost]:8091/pools/default/buckets/[bucket]/stats -v

    Ejemplo:
    curl -u elTodoPoderoso:miPasswordSeguro http://127.0.0.1:8091/pools/default/buckets/misDocumentos/stats -v

  4. Borrar datos de un bucket.

    Comando:
    curl -X POST 'http://[administrador]:[contraseña]@[ipOHost]:8091/pools/default/buckets/[bucket]/controller/doFlush' -v

    Ejemplo:
    curl -X POST 'http://elTodoPoderoso:miPasswordSeguro@127.0.0.1:8091/pools/default/buckets/misDocumentos/controller/doFlush' -v

    Notas:
    1. El bucket debió crearse como flushEnabled, solo recomiendo hacer esto para buckets de desarrollo o temporales
    2. Hay que cuidar el uso de este comando, ya que no requiere confirmación y es responsabilidad del administrador o aplicación confirmar el borrado.

  5. Borrar un Bucket

    Comando:
    curl -X DELETE 'http://[administrador]:[contraseña]@[ipOHost]:8091/pools/default/buckets/[bucket]' -v

    Ejemplo:
    curl -X DELETE 'http://elTodoPoderoso:miPasswordSeguro@127.0.0.1:8091/pools/default/buckets/misDocumentos' -v


    NOTA IMPORTANTE: Este comando desaparece por completo el bucket, es responsabilidad del administrador o aplicación confirmar el borrado, de preferencia no lo usen.

  6. Crear un bucket.

    Comando:
    curl -X POST -u [administrador]:[contraseña] -d name=[bucket] -d bucketType=couchbase -d authType=sasl -d  saslPassword=[contraseñaDeAcceso] -d ramQuotaMB=1024 -d proxyPort=0 -d flushEnabled=1 http://[ipOHost]:8091/pools/default/buckets

    Ejemplo:
    curl -X POST -u elTodoPoderoso:miPasswordSeguro -d name=misDocumentos -d bucketType=couchbase -d authType=sasl -d  saslPassword=miContraseñaDeAcceso -d ramQuotaMB=1024 -d proxyPort=0 -d flushEnabled=1 http://127.0.0.1:8091/pools/default/buckets


    Nota: Este comando habilita el borrado, si el bucket a crear es productivo, es recomendable establecer el parámetro flushEnabled=0 u omitirlo del comando.

Espero que estos comandos les permitan seguir relajándose en sus desarrollos y administración de Couchbase.