Couchbase

Entidades, operaciones y acciones

Todos los conectores de integración proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se te muestra como entidades, operaciones y acciones.

• Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o no tenga ninguna entidad. En ese caso, la lista Entities estará vacía.

• Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Mostrar
  • Obtener
  • Crear
  • Actualizar
  • Eliminar

  Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

• Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Acciones

Este conector admite la ejecución de las siguientes acciones:

• Procedimientos almacenados y funciones definidos por el usuario. Si tienes procedimientos y funciones almacenados en tu backend, se mostrarán en la columna Actions del cuadro de diálogo Configure connector task.
• Consultas de SQL personalizadas. Para ejecutar consultas de SQL personalizadas, el conector proporciona la acción Ejecutar consulta personalizada.

  Para crear una consulta personalizada, sigue estos pasos:

  1. Sigue las instrucciones detalladas para añadir una tarea de conectores.
  2. Cuando configure la tarea del conector, en el tipo de acción que quiera realizar, seleccione Acciones.
  3. En la lista Acción, selecciona Ejecutar consulta personalizada y, a continuación, haz clic en Hecho.

     

  4. Despliega la sección Entrada de la tarea y, a continuación, haz lo siguiente:
     1. En el campo Tiempo de espera tras, introduce el número de segundos que deben transcurrir hasta que se ejecute la consulta.

        Valor predeterminado: 180 segundos.

     2. En el campo Número máximo de filas, introduzca el número máximo de filas que se devolverán de la base de datos.

        Valor predeterminado: 25.

     3. Para actualizar la consulta personalizada, haz clic en Editar secuencia de comandos personalizada. Se abrirá el cuadro de diálogo Editor de secuencias de comandos.

        

     4. En el cuadro de diálogo Editor de secuencias de comandos, introduce la consulta de SQL y haz clic en Guardar.

        Puedes usar un signo de interrogación (?) en una instrucción SQL para representar un único parámetro que debe especificarse en la lista de parámetros de la consulta. Por ejemplo, la siguiente consulta SQL selecciona todas las filas de la tabla Employees que coinciden con los valores especificados en la columna LastName:

        SELECT * FROM Employees where LastName=?

     5. Si has usado signos de interrogación en tu consulta SQL, debes añadir el parámetro haciendo clic en + Añadir nombre de parámetro por cada signo de interrogación. Durante la ejecución de la integración, estos parámetros sustituyen secuencialmente los signos de interrogación (?) de la consulta de SQL. Por ejemplo, si has añadido tres signos de interrogación (?), debes añadir tres parámetros en orden de secuencia.

        

        Para añadir parámetros de consulta, siga estos pasos:

        1. En la lista Tipo, seleccione el tipo de datos del parámetro.
        2. En el campo Valor, introduzca el valor del parámetro.
        3. Para añadir varios parámetros, haga clic en + Añadir parámetro de consulta.

     La acción Ejecutar consulta personalizada no admite variables de matriz.

Acciones

En esta sección se enumeran las acciones que admite el conector. Para saber cómo configurar las acciones, consulta los ejemplos de acciones.

Acción AddDocument

Esta acción añade documentos en Couchbase.

Parámetros de entrada de la acción AddDocument

Parámetros de salida de la acción AddDocument

Esta acción devuelve el estado 200 (OK) si se realiza correctamente.

Para ver un ejemplo de cómo configurar la acción AddDocument, consulta los ejemplos de acciones.

Acción CreateCollection

Esta acción crea una colección en un ámbito.

Parámetros de entrada de la acción CreateCollection

Parámetros de salida de la acción CreateCollection

Esta acción devuelve el estado 200 (OK) si se realiza correctamente.

Para ver un ejemplo de cómo configurar la acción CreateCollection, consulta los ejemplos de acciones.

Acción DeleteCollection

Esta acción elimina una colección de un ámbito.

Parámetros de entrada de la acción DeleteCollection

Parámetros de salida de la acción DeleteCollection

Esta acción devuelve el estado 200 (OK) si se realiza correctamente.

Para ver un ejemplo de cómo configurar la acción DeleteCollection, consulta los ejemplos de acciones.

Acción CreateScope

Esta acción crea un ámbito en un segmento.

Parámetros de entrada de la acción CreateScope

Parámetros de salida de la acción CreateScope

Esta acción devuelve el estado 200 (OK) si se realiza correctamente.

Para ver un ejemplo de cómo configurar la acción CreateScope, consulta los ejemplos de acciones.

Acción DeleteScope

Esta acción elimina un ámbito y todas sus colecciones.

Parámetros de entrada de la acción DeleteScope

Parámetros de salida de la acción DeleteScope

Esta acción devuelve el estado 200 (OK) si se realiza correctamente.

Para ver un ejemplo de cómo configurar la acción DeleteScope, consulta los ejemplos de acciones.

Acción ListIndices

Esta acción muestra todos los índices disponibles en Couchbase.

Parámetros de entrada de la acción ListIndices

Parámetros de salida de la acción ListIndices

Esta acción devuelve el estado 200 (OK) si se realiza correctamente.

Para ver un ejemplo de cómo configurar la acción ListIndices, consulta Ejemplos de acciones.

Acción ManageIndices

Esta acción crea o elimina un índice en un segmento.

Parámetros de entrada de la acción ManageIndices

Parámetros de salida de la acción ManageIndices

Esta acción devuelve el estado 200 (OK) si se realiza correctamente.

Para ver un ejemplo de cómo configurar la acción ManageIndices, consulta Ejemplos de acciones.

Acción ExecuteCustomQuery

Esta acción te permite ejecutar una consulta personalizada.

Para crear una consulta personalizada, sigue estos pasos:

1. Sigue las instrucciones detalladas para añadir una tarea de conectores.
2. Cuando configure la tarea del conector, en el tipo de acción que quiera realizar, seleccione Acciones.
3. En la lista Acción, selecciona Ejecutar consulta personalizada y, a continuación, haz clic en Hecho.

   

4. Despliega la sección Entrada de la tarea y, a continuación, haz lo siguiente:
   1. En el campo Tiempo de espera tras, introduce el número de segundos que deben transcurrir hasta que se ejecute la consulta.

      Valor predeterminado: 180 segundos.

   2. En el campo Número máximo de filas, introduzca el número máximo de filas que se devolverán de la base de datos.

      Valor predeterminado: 25.

   3. Para actualizar la consulta personalizada, haz clic en Editar secuencia de comandos personalizada. Se abrirá el cuadro de diálogo Editor de secuencias de comandos.

      

   4. En el cuadro de diálogo Editor de secuencias de comandos, introduce la consulta de SQL y haz clic en Guardar.

      Puedes usar un signo de interrogación (?) en una instrucción SQL para representar un único parámetro que debe especificarse en la lista de parámetros de la consulta. Por ejemplo, la siguiente consulta SQL selecciona todas las filas de la tabla Employees que coinciden con los valores especificados en la columna LastName:

      SELECT * FROM Employees where LastName=?

   5. Si has usado signos de interrogación en tu consulta SQL, debes añadir el parámetro haciendo clic en + Añadir nombre de parámetro por cada signo de interrogación. Durante la ejecución de la integración, estos parámetros sustituyen secuencialmente los signos de interrogación (?) de la consulta de SQL. Por ejemplo, si has añadido tres signos de interrogación (?), debes añadir tres parámetros en orden de secuencia.

      

      Para añadir parámetros de consulta, siga estos pasos:

      1. En la lista Tipo, seleccione el tipo de datos del parámetro.
      2. En el campo Valor, introduzca el valor del parámetro.
      3. Para añadir varios parámetros, haga clic en + Añadir parámetro de consulta.

   La acción Ejecutar consulta personalizada no admite variables de matriz.

Si se ejecuta correctamente, esta acción devuelve el estado 200 (OK) con un cuerpo de respuesta que contiene los resultados de la consulta.

Ejemplos de acciones

En esta sección se describe cómo realizar algunas de las acciones de este conector.

Ejemplo: añadir un documento

En este ejemplo se añade un documento a un segmento de Couchbase.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción AddDocument y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Document": "{\"ID\":10,\"Name\":\"TestDoc\"}",
   "BucketName": "CouchbaseTestBucket",
   "ID": "Test"
   }

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea AddDocument tendrá un valor similar al siguiente:

[{
"RowsAffected": "1"
}]

Ejemplo: crear una colección

En este ejemplo se crea una colección.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción CreateCollection y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "bucket": "CouchbaseTestBucket",
   "scope": "TestScope",
   "name": "CollectionFromGoogleCloud"
   }

En este ejemplo, se crea una colección en TestScope. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea CreateCollection tendrá un valor similar al siguiente:

[{
"Success": true,
"scope": null,
"uid": null,
"collection": null,
"collections.uid": null,
"maxTTL": null,
"history": null
}]

Ejemplo: eliminar una colección

En este ejemplo se elimina una colección.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción DeleteCollection y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "bucket": "CouchbaseTestBucket",
   "scope": "TestScope",
   "name": "CollectionFromGoogleCloud"
   }

En este ejemplo se elimina una colección de TestScope. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea CreateCollection tendrá un valor similar al siguiente:

[{
"Success": true,
"uid": "12"
}]

Ejemplo: crear un ámbito

En este ejemplo se crea un ámbito.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción CreateScope y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "bucket": "CouchbaseTestBucket",
   "name": "ScopeFromGoogleCloud"
   }

En este ejemplo, se crea un ámbito en CouchbaseTestBucket. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea CreateScope tendrá un valor similar al siguiente:

[{
"Success": true,
"name": null,
"uid": null,
"collections": null,
"collections.name": null,
"collections.uid": null,
"collections.maxTTL": null,
"collections.history": null
}]

Ejemplo: eliminar un permiso

En este ejemplo se elimina un ámbito.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción DeleteScope y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "bucket": "CouchbaseTestBucket",
   "name": "ScopeFromGoogleCloud"
   }

En este ejemplo se elimina el permiso ScopeFromGoogleCloud. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea DeleteScope tendrá un valor similar al siguiente:

[{
"Success": true,
"uid": "10"
}]

Ejemplo: mostrar índices

En este ejemplo se enumeran todos los índices disponibles en Couchbase.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción ListIndices y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload de la respuesta ListIndices tendrá un valor similar al siguiente:

[{
"id": "3d8a78cd2e302ac2",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": null,
"scope_id": null,
"keyspace_id": "CouchbaseTestBucket",
"index_key": "",
"condition": null,
"is_primary": "false",
"name": "test",
"state": "online",
"using": "gsi"
}, {
"id": "d6ce8c103b97a00d",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": "CouchbaseTestBucket",
"scope_id": "TestScope",
"keyspace_id": "CouchBaseDatatypes",
"index_key": "",
"condition": null,
"is_primary": "true",
"name": "#primary",
"state": "online",
"using": "gsi"
},
{
"id": "58c25aef49dd32b3",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": "CouchbaseTestBucket",
"scope_id": "TestScope",
"keyspace_id": "TestCollection",
"index_key": "",
"condition": null,
"is_primary": "false",
"name": "SearchIndexTest_1",
"state": "online",
"using": "fts"
}]

Ejemplo: gestionar índices

En este ejemplo se elimina un índice del segmento especificado.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción ManageIndices y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "BucketName": "CouchbaseTestBucket",
   "Action": "DROP",
   "Name": "CouchBaseTestIndex"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea ManageIndices tendrá un valor similar al siguiente:

[{
"Success": "true"
}]

Ejemplos de operaciones de entidades

En esta sección se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: listar todos los registros

En este ejemplo se enumeran todos los registros de la entidad TestCollection.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TestCollection en la lista Entity.
3. Selecciona la operación List y, a continuación, haz clic en Hecho.
4. Opcionalmente, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar el conjunto de resultados especificando una cláusula de filtro. Especifica siempre el valor de la cláusula de filtro entre comillas simples (').

Ejemplo: obtener un registro de una entidad

En este ejemplo se obtiene un registro con el ID especificado de la entidad TestCollection.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TestCollection en la lista Entity.
3. Selecciona la operación Get y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haga clic en EntityId y, a continuación, introduzca 120 en el campo Valor predeterminado.

   En este caso, 120 es un ID de registro único de la entidad TestCollection.

Ejemplo: actualizar un registro de una entidad

En este ejemplo se actualiza un registro de la entidad TestCollection.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TestCollection en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "COL_TEXT": "CouchBase Update"
   }

5. Haga clic en entityId y, a continuación, introduzca 120 en el campo Valor predeterminado.

   Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

   [{
   "Document.Id": "120"
   }]

Ejemplo: eliminar un registro de una entidad

En este ejemplo se elimina el registro con el ID especificado de la entidad TestCollection.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TestCollection en la lista Entity.
3. Selecciona la operación Delete y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 20 en el campo Valor predeterminado.