CockroachDB

Entidades, operaciones y acciones

Todos los Integration Connectors 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 expone como entidades, operaciones y acciones.

• Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

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

• Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Lista
  • Obtener
  • Crear
  • Actualizar
  • Borrar

  Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se incluirán en la lista Operations.

• Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, 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

En esta sección, se enumeran las acciones que admite el conector. Para comprender cómo configurar las acciones, 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 agregar una tarea de conectores.
2. Cuando configures la tarea del conector, en el tipo de acción que deseas realizar, selecciona Acciones.
3. En la lista Acción, selecciona Ejecutar consulta personalizada y, luego, haz clic en Listo.

   

4. Expande la sección Task input y, luego, haz lo siguiente:
   1. En el campo Tiempo de espera después de, ingresa la cantidad de segundos que se debe esperar hasta que se ejecute la consulta.

      El valor predeterminado es 180 segundos.

   2. En el campo Cantidad máxima de filas, ingresa la cantidad máxima 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 diálogo Editor de secuencias de comandos.

      

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

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

      SELECT * FROM Employees where LastName=?

   5. Si usaste signos de interrogación en tu consulta en SQL, debes agregar el parámetro haciendo clic en + Agregar nombre de parámetro para cada signo de interrogación. Mientras se ejecuta la integración, estos parámetros reemplazan los signos de interrogación (?) en la consulta en SQL de forma secuencial. Por ejemplo, si agregaste tres signos de interrogación (?), debes agregar tres parámetros en orden de secuencia.

      

      Para agregar parámetros de búsqueda, haz lo siguiente:

      1. En la lista Tipo, selecciona el tipo de datos del parámetro.
      2. En el campo Valor, ingresa el valor del parámetro.
      3. Para agregar varios parámetros, haz clic en + Agregar parámetro de consulta.

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

Ejemplos de acciones

Ejemplo: Busca el valor mayor

En este ejemplo, se muestra cómo ejecutar una función definida por el usuario. La función find_greater de este ejemplo compara dos números enteros y devuelve el mayor.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción find_greater y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

   {
   "$1": 1.0,
   "$2": 5.0
   }

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

[{
"bignum": 5.0
}]

Ejemplos de operaciones de entidades

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

Ejemplo: Enumera todos los registros de empleados

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Employees en la lista Entity.
3. Selecciona la operación List y haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Connectors, puedes establecer la filterClause según los requisitos del cliente.

El valor de la cláusula de filtro siempre debe pasarse entre comillas simples (') en este formato.
Se puede usar para filtrar los registros según cualquier columna.

Puedes realizar la operación List en las siguientes entidades:

Cockroach_Datatypes, Accounts, SpatialData, UNICODE, LANGUAGES y View_Cockroach

Ejemplo: Obtén un registro de empleados

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Employees en la lista Entity.
3. Selecciona la operación Get y haz clic en Listo.
4. Establece el ID de la entidad en 5, que es la clave que se pasará. Para establecer el ID de la entidad, en la sección Data Mapper de Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa 5 en el campo Input Value y elige EntityId como variable local.

   El valor del ID de la entidad se debe pasar directamente. Aquí, 5 es el valor de la clave primaria única que se debe pasar.

   En ciertos casos, pasar un solo ID de entidad generaría un error, ya que habría dos claves compuestas.
   En estos casos, puedes usar la cláusula de filtro y pasar el valor, por ejemplo, EmployeeId='5'.

Puedes realizar la operación List en las siguientes entidades:

Cockroach_Datatypes, Accounts, SpatialData, UNICODE y LANGUAGES

Ejemplo: Borra un registro de empleados

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Employees en la lista Entity.
3. Selecciona la operación Delete y haz clic en Listo.
4. Establece el ID de la entidad en 2, que es la clave que se pasará. Para establecer el ID de la entidad, en la sección Data Mapper de Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa 2 en el campo Input Value y elige EntityId como variable local.

   Si la entidad tiene dos claves comerciales o primarias compuestas, en lugar de especificar entityId, también puedes establecer filterClause en EmployeeId='2'.

Puedes realizar la operación de eliminación en las siguientes entidades:

Cockroach_Datatypes, Accounts, SpatialData, UNICODE y LANGUAGES

Ejemplo: Crea un registro de empleados

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Employees en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload como variable local.

   {
     "id": 100.0,
     "gender": "Male",
     "firstname": "Charlie",
     "lastname": "Cruz",
     "designation": "Tester",
     "dept": "IT"
   }
   

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

   {
     "id": 100.0,
     "gender": "Male",
     "firstname": "Charlie",
     "lastname": "Cruz",
     "designation": "Tester",
     "dept": "IT"
     }
     

Ejemplo: Crea un registro de Cockroach_Datatypes

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Cockroach_Datatypes en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload como variable local.

   {
     "col_int": 8.0,
     "col_date": "2016-03-26",
     "col_inet": "190.0.0.0",
     "col_collate": "Cruz",
     "col_string": "Charlie",
     "col_timestamp": "1992-10-05 12:12:12",
     "col_float": 12.12,
     "col_decimal": 10.1,
     "col_json": "{\"type\": \"account creation\", \"username\": \"harvestboy93\"}",
     "col_bool": true,
     "col_interval": "1 year 2 mons 3 days 04:05:06",
     "col_array": "{sky,road,car}",
     "col_uuid": "63616665-6630-3064-6465-616462656562",
     "col_time": "05:41:39",
     "col_bytes": "abc",
     "col_bit": "1",
     "col_name": "Charlie",
     "col_character": "A",
     "col_tsvector": "ts",
     "col_tsquery": "normal",
     "col_oid": "11",
     "col_bytea": "01100001"
   }
   

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

   {
     "col_int": 8.0,
     "col_date": "2016-03-26",
     "col_inet": "190.0.0.0",
     "col_collate": "Cruz",
     "col_string": "Charlie",
     "col_timestamp": "1992-10-05 12:12:12",
     "col_float": 12.12,
     "col_decimal": 10.1,
     "col_json": "{\"type\": \"account creation\", \"username\": \"harvestboy93\"}",
     "col_bool": true,
     "col_interval": "1 year 2 mons 3 days 04:05:06",
     "col_array": "{sky,road,car}",
     "col_uuid": "63616665-6630-3064-6465-616462656562",
     "col_time": "05:41:39",
     "col_bytes": "abc",
     "col_bit": "1",
     "col_name": "Charlie",
     "col_character": "A",
     "col_tsvector": "ts",
     "col_tsquery": "normal",
     "col_oid": "11",
     "col_bytea": "01100001"
     }
     

Ejemplo: Crea un registro de la entidad LANGUAGES

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona LANGUAGES en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload como variable local.

   {
     "id": 5.0,
     "hinditext": "नमस्ते",
     "englishtest": "Namaste",
     "arabictext": "مرحبا",
     "germantext": "Günther"
   } 
   

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

   {
   "id": 6.0,
   "hinditext": "नमस्ते",
   "englishtest": "Namaste",
   "arabictext": "مرحبا",
   "germantext": "Günther"
   }
   

Ejemplo: Crea un registro UNICODE

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona UNICODE en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload como variable local.

   {
     "id": 2.0,
     "unicodedata": "Unicode データ型はグローバル化されたデータの保存に使用されます",
     "test": "UnicodeTest"
   }
   

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

{
"id": 2.0,
"unicodedata": "Unicode データ型はグローバル化されたデータの保存に使用されます",
"test": "UnicodeTest"
}

Ejemplo: Crea un registro de SpatialData

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona SpatialData en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload como variable local.

   {
     "id": 10.0,
     "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164548"
   }
   

   En este ejemplo, se crearán los registros de SpatialData. Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea SpatialData tendrá un valor similar al siguiente:

   {
   "id": 10.0,
   "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164548"
   }
   

Ejemplo: Crea un registro de cuentas

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Accounts en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload como variable local.

   {
     "balance": 2000.0,
     "status": "open",
     "id": 7.0
   }
   

   En este ejemplo, se crearán los registros de SpatialData. Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea SpatialData tendrá un valor similar al siguiente:

   {
   "balance": 2000.0,
   "status": "open",
   "id": 7.0
   }
   

Ejemplo: Actualiza un registro de Employees

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Employees en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

    {
     "dept": "Comp",
     "designation": "QA"
   }
   

5. Establece el ID de la entidad en Data Mapper como la entidad de Employees . Para establecer el ID de la entidad, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar entityId, también puedes establecer filterClause en 1.

   Si ejecutas este ejemplo, se mostrará una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   }
   

Ejemplo: Actualiza un registro de LANGUAGES

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona LANGUAGES en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

    {
     "englishtest": "UpdateTest_TEST"
   }
   

5. Configura el ID de la entidad en Data Mapper como la entidad de los arrays. Para establecer el ID de la entidad, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar entityId, también puedes establecer filterClause en 1.

   Si ejecutas este ejemplo, se mostrará una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   }
   

Ejemplo: Actualiza un registro UNICODE

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona UNICODE en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

    {
     "unicodedata": "ータ型はグロ",
     "test": "UpdateTest"
   }
   

5. Establece el ID de la entidad en Data Mapper como la entidad de ObjectType . Para establecer el ID de la entidad, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar entityId, también puedes establecer filterClause en 3.

   Si ejecutas este ejemplo, se mostrará una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   }
   

Ejemplo: Actualiza un registro de SpatialData

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Spatialdata en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

   {
   "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164543"
   } 
   

5. Establece el ID de la entidad en Data Mapper en la entidad de TableType . Para establecer el ID de la entidad, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar entityId, también puedes establecer filterClause en id= 1.

   Si ejecutas este ejemplo, se mostrará una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   "id": 1,
   "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164543"
   }
   

Ejemplo: Actualiza un registro de Accounts

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Accounts en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

   {
   "balance": 1500.0,
   "status": "open"
   }
   

5. Establece el ID de la entidad en Data Mapper en la entidad de TableType . Para establecer el ID de la entidad, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar entityId, también puedes establecer filterClause en id= 1.

   Si ejecutas este ejemplo, se mostrará una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   "id": 1,
   "balance": 1500,
   "status": "open"
   }
   

Ejemplo: Actualiza un registro de Cockroach_Datatypes

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Cockroach_Datatypes en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

   {
   "col_date": "2019-03-26",
   "col_collate": "Charlie",
   "col_string": "Cruz"
   }
   

5. Establece el ID de la entidad en Data Mapper en la entidad de TableType . Para establecer el ID de la entidad, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar entityId, también puedes establecer filterClause en 2.

   Si ejecutas este ejemplo, se mostrará una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   }