CockroachDB

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

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 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

Ejemplo: buscar 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 que es mayor.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción find_greater 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:

   {
   "$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 entidad en este conector.

Ejemplo: listar 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, a continuación, haz clic en Hecho.
4. Entrada de tarea de la tarea Conectores, puede definir el filterClause según los requisitos del cliente.

El valor de la cláusula de filtro siempre debe incluirse entre comillas simples (") con este formato.
Se puede usar para filtrar los registros en función de cualquier columna.

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

Cockroach_Datatypes, Accounts, SpatialData, UNICODE, LANGUAGES y View_Cockroach

Ejemplo: Obtener 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 Get y, a continuación, haz clic en Hecho.
4. Asigna el valor 5 al ID de entidad, que es la clave que se va a transferir. Para definir el ID de entidad, en la sección Asignación de datos de Asignador de datos, haga clic en Abrir editor de asignación de datos. A continuación, introduzca 5 en el campo Valor de entrada y elija EntityId como variable local.

   El valor de Entity Id debe enviarse directamente. En este caso, 5 es el valor de clave principal único que se debe transferir.

   En algunos casos, si se pasa un solo ID de entidad, se producirá un error, ya que habrá dos claves compuestas.
   En estos casos, puede usar la cláusula de filtro y transferir el valor, como EmployeeId='5'.

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

Cockroach_Datatypes, Accounts, SpatialData, UNICODE y LANGUAGES

Ejemplo: eliminar 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, a continuación, haz clic en Hecho.
4. Asigna el valor 2 al ID de entidad, que es la clave que se va a transferir. Para definir el ID de entidad, en la sección Asignación de datos de Asignador de datos, haga clic en Abrir editor de asignación de datos. A continuación, introduzca 2 en el campo Valor de entrada y elija EntityId como variable local.

   Si Entity tiene dos claves empresariales o primarias compuestas en lugar de especificar entityId, también puedes definir filterClause como EmployeeId='2'.

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

Cockroach_Datatypes, Accounts, SpatialData, UNICODE y LANGUAGES

Ejemplo: crear 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, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija 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 connectorOutputPayload response de la tarea Employees tendrá un valor similar al siguiente:

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

Ejemplo: crear un registro Cockroach_Datatypes

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Seleccione Cockroach_Datatypes en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija 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 connectorOutputPayload response 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: crear un registro de ENTIDADES 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 Create y, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija 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 connectorOutputPayload de la respuesta LANGUAGES tendrá un valor similar al siguiente:

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

Ejemplo: Crear 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, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload como variable local.

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

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

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

Ejemplo: crear un registro 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, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija 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 connectorOutputPayload de la respuesta SpatialData tendrá un valor similar al siguiente:

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

Ejemplo: crear 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, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija 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 connectorOutputPayload de la respuesta SpatialData tendrá un valor similar al siguiente:

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

Ejemplo: actualizar un registro de empleados

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Empleados en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

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

5. Define el ID de entidad en Data Mapper como la entidad de los empleados . Para definir el ID de entidad, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar el entityId, también puede definir filterClause como 1.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
   }
   

Ejemplo: Actualizar un registro 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, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

    {
     "englishtest": "UpdateTest_TEST"
   }
   

5. Define el ID de entidad en Data Mapper como la entidad de los arrays. Para definir el ID de entidad, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar el entityId, también puede definir filterClause como 1.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
   }
   

Ejemplo: actualizar 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, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

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

5. Define el ID de entidad en Data Mapper como la entidad de ObjectType . Para definir el ID de entidad, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar el entityId, también puede definir filterClause como 3.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
   }
   

Ejemplo: actualizar 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, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

   {
   "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164543"
   } 
   

5. Define el ID de entidad en Data Mapper como la entidad de TableType . Para definir el ID de entidad, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar el entityId, también puede definir filterClause como id= 1.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

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

Ejemplo: actualizar 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 Update y, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

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

5. Define el ID de entidad en Data Mapper como la entidad de TableType . Para definir el ID de entidad, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar el entityId, también puede definir filterClause como id= 1.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

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

Ejemplo: actualizar 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, a continuación, haz clic en Hecho.
4. En la sección Data Mapper (Asignador de datos) de la tarea Data Mapping (Asignación de datos), haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

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

5. Define el ID de entidad en Data Mapper como la entidad de TableType . Para definir el ID de entidad, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija EntityId/ConnectorInputPayload/FilterClause como variable local.

   En lugar de especificar el entityId, también puede definir filterClause como 2.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
   }