Detalles de Conexión del Azure Data Catalog¶

Introducción¶

Versión del conector

Esta documentación se basa en la versión 21.0.8383 del conector.

Empezando¶

Compatibilidad con la versión de Azure Data Catalog

El conector aprovecha la API de Azure Data Catalog para habilitar el acceso de lectura a Azure Data Catalog.

Establecer una Conexión¶

Conexión al Azure Data Catalog¶

Opcionalmente, puede establecer lo siguiente para leer los diferentes datos de catálogo devueltos por Azure Data Catalog.

• CatalogName: establézcalo en el nombre del catálogo asociado con su Azure Data Catalog. Si se deja en blanco, se utilizará el catálogo predeterminado.

  Para obtener el nombre de su catálogo, navegue hasta Azure Portal home page -> Data Catalog -> Catalog Name

Autenticación Mediante Azure AD¶

Azure AD es un tipo de conexión que pasa por OAuth. Establecer su AuthScheme a AzureAD y consulte Uso de la autenticación OAuth para obtener una guía de autenticación.

Autenticación Mediante Azure Service Principal¶

Azure Service Principal es un tipo de conexión que pasa por OAuth. Establecer su AuthScheme a AzureServicePrincipal y consulte Uso de la autenticación principal de servicio de Azure para obtener una guía de autenticación.

Autenticación Mediante Autenticación MSI¶

Si ejecuta Azure Data Catalog en una máquina virtual de Azure, puede aprovechar las credenciales de Managed Service Identity (MSI) para conectarse:

• AuthScheme: Establézcalo en AzureMSI.

Las credenciales de MSI se obtendrán automáticamente para la autenticación.

Uso de la Autenticación OAuth¶

OAuth requiere que el usuario que se autentica interactúe con Azure Data Catalog mediante el explorador. El conector facilita esto de varias maneras, como se describe a continuación.

Credenciales Integradas¶

Consulte Credenciales integradas para conectarse con las credenciales incrustadas del conector y omitir la creación de una aplicación OAuth personalizada.

Credenciales Personalizadas¶

En lugar de conectarse con las credenciales integradas del conector, puede registrar una aplicación con Credenciales personalizadas para obtener el OAuthClientId y OAuthClientSecret.

Cuándo Crear una Aplicación OAuth Personalizada¶

La creación de una aplicación OAuth personalizada es opcional, ya que el conector ya está registrado en Azure Data Catalog y puede conectarse con sus credenciales incrustadas. Es posible que desee crear una aplicación de OAuth personalizada para cambiar la información que se muestra cuando los usuarios inician sesión en el extremo de OAuth de Azure Data Catalog para otorgar permisos al conector.

Creación de una Aplicación OAuth Personalizada¶

Consulte Crear una aplicación OAuth personalizada para un procedimiento.

Credenciales Integradas¶

Autenticarse con las Credenciales de OAuth Integradas¶

Autenticación de Escritorio con la Aplicación OAuth Integrada¶

Puede conectarse sin configurar ninguna propiedad de conexión para sus credenciales de usuario.

Cuando se conecta, el conector abre el extremo de OAuth en su navegador predeterminado. Inicie sesión y otorgue permisos a la aplicación. Luego, el conector completa el proceso de OAuth.

1. Extrae el token de acceso de la URL de devolución de llamada y autentica las solicitudes.
2. Obtiene un nuevo token de acceso cuando caduca el antiguo.
3. Guarda los valores de OAuth en OAuthSettingsLocation para persistir a través de las conexiones.

Credenciales Personalizadas¶

Hay dos tipos de autenticación de aplicaciones disponibles: usar un secreto de cliente y usar un certificado. Puede usar cualquiera de ellos dependiendo de la autenticación de la aplicación configurada.

Autenticación de Escritorio con Su Aplicación OAuth¶

Siga los pasos a continuación para autenticarse con las credenciales de una aplicación OAuth personalizada. Consulte Crear una aplicación OAuth personalizada.

Obtenga un Token de Acceso OAuth¶

Está listo para conectarse después de configurar uno de los siguientes grupos de propiedades de conexión según el tipo de autenticación.

1. Authenticating using a Client Secret
   • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
   • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.
   • CallbackURL: establezca esto en la URL de redireccionamiento en la configuración de su aplicación.
   • AuthScheme: establezca esto en "AzureAD" en la configuración de su aplicación.
   • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken..
2. Authenticating using a Certificate
   • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
   • OAuthJWTCert: establezca esto en el almacén de certificados JWT.
   • OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.
   • CallbackURL: establezca esto en la URL de redireccionamiento en la configuración de su aplicación.
   • AuthScheme: establezca esto en "AzureAD" en la configuración de su aplicación.
   • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken..

Cuando se conecta, el conector abre el extremo de OAuth en su navegador predeterminado. Inicie sesión y otorgue permisos a la aplicación. Luego, el conector completa el proceso de OAuth:

1. Extrae el token de acceso de la URL de devolución de llamada y autentica las solicitudes.
2. Obtiene un nuevo token de acceso cuando caduca el anterior.
3. Guarda los valores de OAuth en OAuthSettingsLocation para persistir a través de las conexiones.

Máquinas Sin Cabeza¶

Uso de OAuth en una Máquina Sin Cabeza¶

Para crear orígenes de datos de Azure Data Catalog en servidores sin periféricos u otras máquinas en las que el conector no puede abrir un explorador, debe autenticarse desde otra máquina. La autenticación es un proceso de dos pasos.

1. En lugar de instalar el conector en otra máquina, puede seguir los pasos a continuación para obtener el OAuthVerifier valor. O bien, puede instalar el conector en otra máquina y transferir los valores de autenticación de OAuth, después de autenticarse a través del flujo habitual basado en el navegador.
2. A continuación, puede configurar el conector para actualizar automáticamente el token de acceso desde la máquina sin periféricos.

Puede seguir el flujo de autenticación de OAuth sin cabeza usando las credenciales de OAuth integradas del conector o usando las credenciales de OAuth para su aplicación de OAuth personalizada.

Uso de las Credenciales para una Aplicación OAuth Personalizada¶

Cree una aplicación OAuth personalizada

Consulte Crear una aplicación OAuth personalizada para un procedimiento. Luego puede seguir los procedimientos a continuación para autenticarse y conectarse a los datos.

Obtenga un código verificador

En la máquina sin periféricos, configure uno de los siguientes grupos de propiedades según el tipo de autenticación:

1. Authenticating using a Client Secret
   • InitiateOAuth: Ajústelo a APAGADO.
   • OAuthClientId: establezca esto en la ID de la aplicación en la configuración de su aplicación.
   • OAuthClientSecret: establezca esto en el secreto de la aplicación en la configuración de su aplicación.
2. Authenticating using a Certificate
   • InitiateOAuth: Ajústelo a APAGADO.
   • OAuthClientId: establezca esto en la ID de la aplicación en la configuración de su aplicación.
   • OAuthJWTCert: establezca esto en el almacén de certificados JWT.
   • OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.

Luego puede seguir los pasos a continuación para autenticarse desde otra máquina y obtener el OAuthVerifier propiedad de conexión.

1. Llame a GetOAuthAuthorizationURL procedimiento almacenado* con el parámetro de entrada CallbackURL establecido en el URI de redirección exacto que especificó en la configuración de su aplicación.
2. Abra la URL devuelta en un navegador. Inicie sesión y otorgue permisos al conector. A continuación, se le redirigirá a la URL de devolución de llamada. La página web indicará que no se pudo acceder al sitio.
3. Inspeccione la URL de la página de este sitio y busque code valor. Estará presente en la URL en la forma code=XXXXXX (terminado con &, que denota el siguiente parámetro de URL ) El valor después de "code=" es el código verificador.
4. Guarde el valor del código verificador. Establecerá esto en el OAuthVerifier propiedad de conexión.

En la máquina sin periféricos, configure uno de los siguientes grupos de propiedades de conexión según el tipo de autenticación para obtener los valores de autenticación de OAuth:

• OAuthClientId: establezca esto en la clave de consumidor en la configuración de su aplicación.
• OAuthClientSecret: establezca esto en el secreto del consumidor en la configuración de su aplicación.
• OAuthVerifier: Establézcalo en el código del verificador.
• OAuthSettingsLocation: configure esto para conservar los valores de autenticación OAuth cifrados en el archivo especificado.
• InitiateOAuth: Establézcalo en ACTUALIZAR.

Conectarse a datos

Después de generar el archivo de configuración de OAuth, configure las siguientes propiedades para conectarse a los datos:

• OAuthSettingsLocation: Establézcalo en el archivo que contiene los valores de autenticación de OAuth cifrados. Asegúrese de que este archivo otorgue permisos de lectura y escritura al proveedor para habilitar la actualización automática del token de acceso.
• InitiateOAuth: Establézcalo en ACTUALIZAR.

Transferir configuración de OAuth

Siga los pasos a continuación para instalar el conector en otra máquina, autenticar y luego transferir los valores de OAuth resultantes.

En una segunda máquina, instale el conector y conéctese con uno de los siguientes grupos de propiedades según el tipo de autenticación:

1. Authenticating using a Client Secret
   • OAuthSettingsLocation: establezca esto en un archivo de texto grabable.
   • InitiateOAuth: Establézcalo en GETANDREFRESH.
   • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
   • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.
   • CallbackURL: establezca esto en la URL de devolución de llamada en la configuración de su aplicación.
2. Authenticating using a Certificate
   • OAuthSettingsLocation: establezca esto en un archivo de texto grabable.
   • InitiateOAuth: Establézcalo en GETANDREFRESH.
   • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
   • OAuthJWTCert: establezca esto en el almacén de certificados JWT.
   • OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.
   • CallbackURL: establezca esto en la URL de devolución de llamada en la configuración de su aplicación.

Pruebe la conexión para autenticarse. Los valores de autenticación resultantes se escriben, se cifran, en la ruta especificada por OAuthSettingsLocation. Una vez que haya probado con éxito la conexión, copie el archivo de configuración de OAuth en su máquina sin periféricos. En la máquina sin periféricos, configure las siguientes propiedades de conexión para conectarse a los datos:

• InitiateOAuth: Establézcalo en ACTUALIZAR.
• OAuthSettingsLocation: establezca esto en la ruta a su archivo de configuración de OAuth. Asegúrese de que este archivo otorgue permisos de lectura y escritura al conector para habilitar la actualización automática del token de acceso.

Creación de una Aplicación OAuth Personalizada¶

Cuándo Crear una Aplicación OAuth Personalizada¶

La creación de una aplicación OAuth personalizada es opcional, ya que el conector ya está registrado en Azure Data Catalog y puede conectarse con sus credenciales incrustadas.

Es posible que desee crear una aplicación de OAuth personalizada para cambiar la información que se muestra cuando los usuarios inician sesión en el extremo de OAuth de Azure Data Catalog para otorgar permisos al conector.

Siga los pasos a continuación para crear una aplicación OAuth personalizada y obtener las propiedades de conexión en un flujo de autenticación OAuth específico.

Pasos para Crear una Aplicación OAuth Personalizada¶

Siga los pasos a continuación para obtener los valores de OAuth para su aplicación, el OAuthClientId y OAuthClientSecret.

1. Inicie sesión en https://portal.azure.com.
2. En el panel de navegación de la izquierda, seleccione Azure Active Directory, luego Registros de aplicaciones y haga clic en el botón Nuevo registro.
3. Ingrese un nombre de aplicación y configure el botón de opción para la configuración de inquilino deseada. Al crear una aplicación OAuth personalizada en Azure Active Directory, puede definir si la aplicación es de un solo inquilino o de varios inquilinos. Si selecciona la opción predeterminada de "Cuentas solo en este directorio organizacional", deberá configurar AzureTenant propiedad de conexión con el ID del arrendatario de Azure AD al establecer una conexión con Jitterbit Connector para Azure Data Catalog. De lo contrario, el intento de autenticación fallará con un error. Si su aplicación es solo para uso privado, "Solo cuentas en el directorio de esta organización" debería ser suficiente. De lo contrario, si desea distribuir su aplicación, elija una de las opciones de múltiples inquilinos.
4. Luego configure la URL de redireccionamiento a algo como http://localhost:33333, el valor predeterminado del conector. O configure un puerto diferente de su elección y configure CallbackURL a la URL de respuesta exacta que definiste.
5. Defina el tipo de autenticación de la aplicación en la sección Certificados y secretos. Hay dos tipos de autenticación disponibles: usando un secreto de cliente y usando un certificado. El método de autenticación recomendado es a través de un certificado, pero también puede crear un secreto de aplicación.
   • Option 1 - Upload a certificate: En la sección Certificados y secretos, seleccione Cargar certificado y seleccione el certificado para cargar desde su máquina local.
   • Option 2 - Create a new application secret: En la sección Certificados y secretos, seleccione Nuevo secreto de cliente para la aplicación y seleccione su duración. Después de guardar el secreto del cliente, se muestra el valor de la clave. Copie este valor ya que se muestra solo una vez y se usa como OAuthClientSecret.
6. Seleccione Permisos de API y luego haga clic en Agregar. Si planea que su aplicación se conecte sin un contexto de usuario, seleccione los Permisos de la aplicación (OAuthGrantType = CLIENTE). De lo contrario, al seleccionar permisos, utilice los permisos Delegados.
7. Seleccione Catálogo de datos de Azure -> Permisos delegados -> suplantación_de_usuario.
8. Guarde sus cambios.
9. Si ha seleccionado usar permisos que requieren el consentimiento del administrador (como los Permisos de la aplicación), puede otorgarlos desde el arrendatario actual en la página Permisos de la API. De lo contrario, siga los pasos en Consentimiento del administrador.

Consentimiento del Administrador¶

El consentimiento del administrador se refiere a cuando el administrador de un arrendatario de Azure Active Directory otorga permisos a una aplicación que requiere que un administrador dé su consentimiento para el caso de uso. La aplicación integrada dentro de Jitterbit Connector para Azure Data Catalog no contiene permisos que requieran el consentimiento del administrador. Por lo tanto, esta información se aplica solo a las aplicaciones personalizadas.

Permisos de Consentimiento del Administrador¶

Al crear una nueva aplicación de OAuth en Azure Portal, debe especificar qué permisos requerirá la aplicación. Algunos permisos pueden estar marcados como "Consentimiento del administrador requerido". Por ejemplo, todos los permisos de Grupos requieren el consentimiento del administrador. Si su aplicación requiere el consentimiento del administrador, hay varias formas de hacerlo.

La forma más fácil de otorgar el consentimiento del administrador es simplemente hacer que un administrador inicie sesión en portal.azure.com y navegue hasta la aplicación que ha creado en Registros de aplicaciones. En Permisos de API, habrá un botón para Otorgar consentimiento. Puede dar su consentimiento aquí para que su aplicación tenga permisos en el arrendatario bajo el que se creó.

Si su organización tiene varios inquilinos o es necesario otorgar permisos a la aplicación para otros inquilinos fuera de su organización, GetAdminConsentURL se puede utilizar para generar la URL de autorización del administrador. A diferencia de GetOAuthAuthorizationURL, no se devolverá información importante desde este extremo. Si otorga acceso, simplemente devolverá un valor booleano que indica que se otorgaron los permisos.

Una vez que un administrador otorga el consentimiento, la autenticación se puede realizar normalmente.

Credenciales del Cliente¶

Las credenciales del cliente hacen referencia a un flujo en OAuth en el que no se lleva a cabo una autenticación directa del usuario. En cambio, las credenciales se crean solo para la aplicación en sí. Todas las tareas realizadas por la aplicación se realizan sin un contexto de usuario predeterminado. Esto hace que el flujo de autenticación sea un poco diferente al estándar.

Flujo de OAuth del Cliente¶

Todos los permisos relacionados con el flujo de autenticación del cliente requieren el consentimiento del administrador. Esto significa que la aplicación integrada con Jitterbit Connector para Azure Data Catalog no se puede usar en el flujo de autenticación del cliente. Debe crear su propia aplicación OAuth para usar las credenciales del cliente. Consulte Crear una aplicación OAuth personalizada para más detalles.

En su Registro de aplicaciones en portal.azure.com, vaya a Permisos de API y seleccione los permisos de Microsoft Graph. Hay dos conjuntos distintos de permisos: permisos delegados y de aplicación. Los permisos utilizados durante la autenticación de credenciales del cliente se encuentran en Permisos de la aplicación. Seleccione los permisos aplicables que necesita para su integración.

Está listo para conectarse después de configurar uno de los siguientes grupos de propiedades de conexión según el tipo de autenticación.

1. Authenticating using a Client Secret
   • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
   • AzureTenant: Configure esto para el arrendatario al que desea conectarse.
   • OAuthGrantType: Establézcalo en CLIENTE.
   • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
   • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.
2. Authenticating using a Certificate
   • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
   • AzureTenant: Configure esto para el arrendatario al que desea conectarse.
   • OAuthGrantType: Establézcalo en CLIENTE.
   • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
   • OAuthJWTCert: establezca esto en el almacén de certificados JWT.
   • OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.

La autenticación con las credenciales del cliente se realizará automáticamente como cualquier otra conexión, excepto que no se abrirá ninguna ventana que pregunte al usuario. Debido a que no hay un contexto de usuario, no hay necesidad de una ventana emergente en el navegador. Las conexiones se llevarán a cabo y se manejarán internamente.

Uso de la Autenticación Principal de Servicio de Azure¶

La autenticación como entidad principal de servicio de Azure se gestiona a través del flujo de credenciales de cliente de OAuth y no implica la autenticación directa del usuario. En cambio, las credenciales se crean solo para la aplicación en sí. Todas las tareas realizadas por la aplicación se realizan sin un contexto de usuario predeterminado, pero en función de los roles asignados. El acceso de la aplicación a los recursos se controla a través de los permisos de los roles asignados.

Credenciales Personalizadas¶

Deberá registrar una aplicación de OAuth para obtener los valores de propiedad de OAuth antes de conectarse al origen de datos de Azure Data Catalog. Puede comprobar las Credenciales personalizadas guía sobre cómo configurar las propiedades de OAuth.

Creación de una Aplicación OAuth Personalizada¶

Consulte Crear una aplicación OAuth personalizada para un procedimiento.

Creación de una Aplicación OAuth Personalizada¶

Es necesario crear una aplicación de OAuth personalizada y una entidad de servicio que pueda acceder a los recursos necesarios cuando se autentica mediante una entidad de servicio de Azure.

Siga los pasos a continuación para crear una aplicación OAuth personalizada y obtener las propiedades de conexión para la autenticación de la entidad de servicio de Azure.

Pasos para Crear una Aplicación OAuth Personalizada¶

Siga los pasos a continuación para obtener los valores de OAuth para su aplicación.

1. Inicie sesión en <https://portal.azure.com>.
2. En el panel de navegación de la izquierda, seleccione Azure Active Directory, luego Registros de aplicaciones y haga clic en el botón Nuevo registro.
3. Ingrese un nombre de aplicación y configure el botón de opción para "Cualquier directorio de Azure AD - Multiusuario". Luego configure la URL de redireccionamiento a algo como http://localhost:33333, el valor predeterminado del conector.
4. Copie el valor de ID de la aplicación (cliente) que se muestra en la sección Descripción general después de crear la aplicación, ya que este valor se usa como OAuthClientId
5. Defina el tipo de autenticación de la aplicación en la sección Certificados y secretos. Hay dos tipos de autenticación disponibles: usando un secreto de cliente y usando un certificado. El método de autenticación recomendado es a través de un certificado, pero también puede crear un secreto de aplicación.
   • Option 1 - Upload a certificate: En la sección Certificados y secretos, seleccione Cargar certificado y seleccione el certificado para cargar desde su máquina local.
   • Option 2 - Create a new application secret: En la sección Certificados y secretos, seleccione Nuevo secreto de cliente para la aplicación y seleccione su duración. Después de guardar el secreto del cliente, se muestra el valor de la clave. Copie este valor ya que se muestra solo una vez y se usa como OAuthClientSecret.
6. En la pestaña Autenticación, asegúrese de marcar la opción: Tokens de acceso (utilizados para flujos implícitos).
7. Abra la página Suscripciones buscando y seleccionando el servicio Suscripciones en la barra de búsqueda.
8. Seleccione la suscripción particular para asignar la aplicación, luego abra la sección Control de acceso (IAM) y haga clic en el botón Agregar asignación de rol.
9. Seleccione Propietario como el rol para asignar a su aplicación OAuth creada.

Credenciales Personalizadas¶

Siga los pasos a continuación para autenticarse con las credenciales de una aplicación OAuth personalizada. Consulte Crear una aplicación OAuth personalizada.

Autenticación con Su Aplicación OAuth¶

Hay dos tipos de autenticación de aplicaciones disponibles: usar un secreto de cliente y usar un certificado. Puede usar cualquiera de ellos dependiendo de la autenticación de la aplicación configurada.

Obtenga un Token de Acceso OAuth¶

Está listo para conectarse después de configurar uno de los siguientes grupos de propiedades de conexión según el tipo de autenticación.

1. Authenticating using a Client Secret
   • AuthScheme: establezca esto en "AzureServicePrincipal" en la configuración de su aplicación.
   • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
   • AzureTenant: Configure esto para el arrendatario al que desea conectarse.
   • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
   • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.
2. Authenticating using a Certificate
   • AuthScheme: establezca esto en "AzureServicePrincipal" en la configuración de su aplicación.
   • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
   • AzureTenant: Configure esto para el arrendatario al que desea conectarse.
   • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
   • OAuthJWTCert: establezca esto en el almacén de certificados JWT.
   • OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.

Características Avanzadas¶

Esta sección detalla una selección de características avanzadas del conector de Azure Data Catalog.

Vistas definidas por el usuario

El conector le permite definir tablas virtuales, llamadas vistas definidas por el usuario, cuyo contenido se decide mediante una consultar preconfigurada. Estas vistas son útiles cuando no puede controlar directamente las consultas que se envían a los controladores. Consulte Vistas definidas por el usuario para obtener una descripción general de la creación y configuración de vistas personalizadas.

Configuración SSL

Usar Configuración SSL para ajustar cómo el conector maneja las negociaciones de certificados TLS/SSL. Puede elegir entre varios formatos de certificado; ver el SSLServerCert propiedad en "Opciones de cadena de conexión" para obtener más información.

Apoderado

Para configurar el conector mediante Configuración de proxy de Agente Privado, Selecciona el Use Proxy Settings casilla de verificación en la pantalla de configuración de la conexión.

Vistas Definidas por el Usuario¶

Jitterbit Connector for Azure Data Catalog le permite definir una tabla virtual cuyo contenido se decide mediante una consultar preconfigurada. Estas se denominan Vistas definidas por el usuario, que son útiles en situaciones en las que no puede controlar directamente la consultar que se envía al controlador, por ejemplo, cuando se utiliza el controlador de Jitterbit. Las vistas definidas por el usuario se pueden utilizar para definir predicados que siempre se aplican. Si especifica predicados adicionales en la consultar a la vista, se combinan con la consultar ya definida como parte de la vista.

Hay dos formas de crear vistas definidas por el usuario:

• Cree un archivo de configuración con formato JSON que defina las vistas que desea.
• Declaraciones DDL.

Definición de Vistas Utilizando un Archivo de Configuración¶

Las vistas definidas por el usuario se definen en un archivo de configuración con formato JSON llamado UserDefinedViews.json. El conector detecta automáticamente las vistas especificadas en este archivo.

También puede tener múltiples definiciones de vista y controlarlas usando UserDefinedViews propiedad de conexión. Cuando utiliza esta propiedad, el conector solo ve las vistas especificadas.

Este archivo de configuración de vista definida por el usuario tiene el siguiente formato:

• Cada elemento raíz define el nombre de una vista.
• Cada elemento raíz contiene un elemento hijo, llamado query, que contiene la consultar SQL personalizada para la vista.

Por ejemplo:

{
    "MyView": {
        "query": "SELECT * FROM Tables WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Utilizar el UserDefinedViews propiedad de conexión para especificar la ubicación de su archivo de configuración JSON. Por ejemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Vistas Definidas por el Usuario¶

Las vistas definidas por el usuario se exponen en UserViews esquema por defecto. Esto se hace para evitar que el nombre de la vista entre en conflicto con una entidad real en el modelo de datos. Puede cambiar el nombre del esquema utilizado para UserViews configurando UserViewsSchemaName propiedad.

Trabajar con Vistas Definidas por el Usuario¶

Por ejemplo, una instrucción SQL con una vista definida por el usuario llamada UserViews.RCustomers solo enumera clientes en Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Un ejemplo de una consultar al controlador:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Dando como resultado la consultar efectiva a la fuente:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Ese es un ejemplo muy simple de una consultar a una vista definida por el usuario que es efectivamente una combinación de la consultar de vista y la definición de vista. Es posible componer estas consultas en patrones mucho más complejos. Todas las operaciones de SQL están permitidas en ambas consultas y se combinan cuando corresponde.

Configuración SSL¶

Personalización de la Configuración SSL¶

De forma predeterminada, el conector intenta negociar SSL/TLS comparando el certificado del servidor con el almacén de certificados de confianza del sistema.

Para especificar otro certificado, consulte SSLServerCert propiedad de los formatos disponibles para hacerlo.

Modelo de Datos¶

Descripción general

Esta sección muestra los objetos de API disponibles y proporciona más información sobre cómo ejecutar SQL en las APIs de Azure Data Catalog.

Características clave

• El conector modela entidades de Azure Data Catalog como orígenes de datos personalizados, activos de datos y anotaciones de activos de datos como vistas relacionales, lo que le permite escribir SQL para consultar datos de Azure Data Catalog.
• La conectividad en vivo a estos objetos significa que cualquier cambio en su cuenta de Azure Data Catalog se refleja inmediatamente cuando se usa el conector.

Puntos de vista

Puntos de vista describe las vistas disponibles. Las vistas se definen estáticamente para modelar fuentes de datos personalizadas, activos de datos, anotaciones de activos de datos y más.

Procesamiento colaborativo de consultas

El conector descarga la mayor parte posible del procesamiento de instrucciones SELECT en Azure Data Catalog y luego procesa el resto de la consultar en la memoria. Las limitaciones y los requisitos de la API también se documentan en esta sección.

Ver SupportEnhancedSQL para obtener más información sobre cómo el conector elude las limitaciones de la API con el procesamiento del lado del cliente en memoria.

Puntos de Vista¶

Las vistas se componen de columnas y pseudocolumnas. Las vistas son similares a las tablas en la forma en que se representan los datos; sin embargo, las vistas no admiten actualizaciones. Las entidades que se representan como vistas suelen ser entidades de solo lectura. A menudo, un procedimiento almacenado* está disponible para actualizar los datos si dicha funcionalidad es aplicable a la fuente de datos.

Las consultas se pueden ejecutar contra una vista como si fuera una tabla normal, y los datos que regresan son similares en ese sentido. Para obtener más información sobre las tablas y los procedimientos almacenados, vaya a sus entradas correspondientes en este documento de ayuda.

Conector Jitterbit para Vistas de Azure Data Catalog¶

ColumnDataProfilesColumnDataProfiles¶

Obtenga una lista de perfiles de datos de columna.

Información Específica de la Tabla¶

Seleccionar¶

El conector usará la API de Azure Data Catalog para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El resto del filtro se ejecuta del lado del cliente dentro del conector.
Nota: Se requiere ItemId para consultar ColumnDataProfiles.

• ItemId apoya el = operador.

Por ejemplo:

SELECT * FROM ColumnDataProfiles WHERE ItemId = '8a2b7305-b474-45d6-9fba-562454045070'

Columnas¶

Propiedades de Origen de Datos Personalizados¶

Obtenga las propiedades de identidad de las fuentes de datos personalizadas.

Información Específica de la Tabla¶

Seleccionar¶

No se admiten filtros del lado del servidor para esta tabla. Todos los criterios se manejarán del lado del cliente dentro del conector.

Columnas¶

Fuentes de Datos Personalizadas¶

Recupera la lista de orígenes de datos personalizados, que están registrados en el catálogo.

Información Específica de la Tabla¶

Seleccionar¶

No se admiten filtros del lado del servidor para esta tabla. Todos los criterios se manejarán del lado del cliente dentro del conector.

Columnas¶

Bases de Datos¶

Obtener lista de bases de datos.

Información Específica de la Tabla¶

Seleccionar¶

El conector usará la API de Azure Data Catalog para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Name admite los operadores '=, !=, <>, CONTAINS'.
• Timestamp admite los operadores '=, <, <=, >, >=, CONTAINS'.
• LastRegisteredTime admite los operadores '=, CONTAINS'.
• ObjectType apoya el = operador.
• SourceType apoya el = operador.
• FriendlyName admite los operadores '=, CONTAINS'.
• Experts admite los operadores '=, CONTAINS'.
• Description admite los operadores '=, CONTAINS'.
• Tags admite los operadores '=, !=, <>, CONTAINS'.
• HasTags apoya el = operador.
• HasPreviews apoya el = operador.
• HasDocumentation apoya el = operador.
• HasTableDataProfiles apoya el = operador.
• HasColumnsDataProfiles apoya el = operador.
• HasDescription apoya el = operador.
• View apoya el = operador.
• Facets apoya el = operador.

Por ejemplo:

SELECT * FROM Databases WHERE HasDocumentation=false AND HasDescription = false AND HasTags = true;

SELECT * FROM Databases WHERE Timestamp > '2019-09-19T04:39:54.0083651Z'

SELECT * FROM Databases WHERE Tags = 'sales' OR Name = 'FactProductInventory'

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Descripciones¶

Obtenga una lista de descripciones de bases de datos, tablas y objetos.

Información Específica de la Tabla¶

Seleccionar¶

El conector usará la API de Azure Data Catalog para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Name admite los operadores '=, !=, <>, CONTAINS'.
• Timestamp admite los operadores '=, <, <=, >, >=, CONTAINS'.
• LastRegisteredTime admite los operadores '=, CONTAINS'.
• ObjectType apoya el = operador.
• SourceType apoya el = operador.
• FriendlyName admite los operadores '=, CONTAINS'.
• Experts admite los operadores '=, CONTAINS'.
• Description admite los operadores '=, CONTAINS'.
• Tags admite los operadores '=, !=, <>, CONTAINS'.
• HasTags apoya el = operador.
• HasPreviews apoya el = operador.
• HasDocumentation apoya el = operador.
• HasTableDataProfiles apoya el = operador.
• HasColumnsDataProfiles apoya el = operador.
• HasDescription apoya el = operador.
• View apoya el = operador.
• Facets apoya el = operador.

Por ejemplo:

SELECT * FROM Descriptions WHERE CONTAINS(Description,'sakila') AND ObjectType = table;

SELECT * FROM Descriptions WHERE CONTAINS(Name,'customer') AND HasTags = true;

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Expertos¶

Obtenga una lista de expertos en bases de datos, tablas y objetos.

Información Específica de la Tabla¶

Seleccionar¶

El conector usará la API de Azure Data Catalog para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Name admite los operadores '=, !=, <>, CONTAINS'.
• Timestamp admite los operadores '=, <, <=, >, >=, CONTAINS'.
• LastRegisteredTime admite los operadores '=, CONTAINS'.
• ObjectType apoya el = operador.
• SourceType apoya el = operador.
• FriendlyName admite los operadores '=, CONTAINS'.
• Experts admite los operadores '=, CONTAINS'.
• Description admite los operadores '=, CONTAINS'.
• Tags admite los operadores '=, !=, <>, CONTAINS'.
• HasTags apoya el = operador.
• HasPreviews apoya el = operador.
• HasDocumentation apoya el = operador.
• HasTableDataProfiles apoya el = operador.
• HasColumnsDataProfiles apoya el = operador.
• HasDescription apoya el = operador.
• View apoya el = operador.
• Facets apoya el = operador.

Por ejemplo:

SELECT * FROM Experts WHERE ObjectType = 'table' AND CONTAINS(Experts,'support')

SELECT * FROM Experts WHERE Tags = 'orders' OR Name = 'orders' AND ObjectType = 'table';

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Objetos¶

Obtenga las propiedades de la fuente de datos de la lista.

Información Específica de la Tabla¶

Seleccionar¶

El conector usará la API de Azure Data Catalog para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Name admite los operadores '=, !=, <>, CONTAINS'.
• Timestamp admite los operadores '=, <, <=, >, >=, CONTAINS'.
• LastRegisteredTime admite los operadores '=, CONTAINS'.
• ObjectType apoya el = operador.
• SourceType apoya el = operador.
• FriendlyName admite los operadores '=, CONTAINS'.
• Experts admite los operadores '=, CONTAINS'.
• Description admite los operadores '=, CONTAINS'.
• Tags admite los operadores '=, !=, <>, CONTAINS'.
• HasTags apoya el = operador.
• HasPreviews apoya el = operador.
• HasDocumentation apoya el = operador.
• HasTableDataProfiles apoya el = operador.
• HasColumnsDataProfiles apoya el = operador.
• HasDescription apoya el = operador.
• View apoya el = operador.
• Facets apoya el = operador.

Por ejemplo:

SELECT * FROM Objects WHERE Tags <> 'sales';

SELECT * FROM Objects WHERE Name = 'sales' AND HasTags = true;

SELECT * FROM Objects WHERE CONTAINS(Tags,'sales') AND CONTAINS(Tags,'customer');

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

TablaColumnas¶

Obtenga detalles del esquema de la tabla.

Información Específica de la Tabla¶

Seleccionar¶

El conector usará la API de Azure Data Catalog para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• ItemId apoya el = operador.

Por ejemplo:

SELECT * FROM TableColumns WHERE ItemId = '8a2b7305-b474-45d6-9fba-57e954565070'

Columnas¶

TableDataProfiles¶

Obtenga una lista de los perfiles de datos de la tabla.

Información Específica de la Tabla¶

Seleccionar¶

El conector usará la API de Azure Data Catalog para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Name admite los operadores '=, !=, <>, CONTAINS'.
• Timestamp admite los operadores '=, <, <=, >, >=, CONTAINS'.
• LastRegisteredTime admite los operadores '=, CONTAINS'.
• ObjectType apoya el = operador.
• SourceType apoya el = operador.
• FriendlyName admite los operadores '=, CONTAINS'.
• Experts admite los operadores '=, CONTAINS'.
• Description admite los operadores '=, CONTAINS'.
• Tags admite los operadores '=, !=, <>, CONTAINS'.
• HasTags apoya el = operador.
• HasPreviews apoya el = operador.
• HasDocumentation apoya el = operador.
• HasTableDataProfiles apoya el = operador.
• HasColumnsDataProfiles apoya el = operador.
• HasDescription apoya el = operador.
• View apoya el = operador.
• Facets apoya el = operador.

Por ejemplo:

SELECT * FROM TableDataProfiles WHERE NOT Tags = 'FactProductInventory'

SELECT * FROM TableDataProfiles WHERE Timestamp > '2019-09-20T04:39:54.0083651Z';

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Mesas¶

Obtenga una lista de tablas en el recurso de datos.

Información Específica de la Tabla¶

Seleccionar¶

El conector usará la API de Azure Data Catalog para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Name admite los operadores '=, !=, <>, CONTAINS'.
• Timestamp admite los operadores '=, <, <=, >, >=, CONTAINS'.
• LastRegisteredTime admite los operadores '=, CONTAINS'.
• ObjectType apoya el = operador.
• SourceType apoya el = operador.
• FriendlyName admite los operadores '=, CONTAINS'.
• Experts admite los operadores '=, CONTAINS'.
• Description admite los operadores '=, CONTAINS'.
• Tags admite los operadores '=, !=, <>, CONTAINS'.
• HasTags apoya el = operador.
• HasPreviews apoya el = operador.
• HasDocumentation apoya el = operador.
• HasTableDataProfiles apoya el = operador.
• HasColumnsDataProfiles apoya el = operador.
• HasDescription apoya el = operador.
• View apoya el = operador.
• Facets apoya el = operador.

Por ejemplo:

SELECT * FROM Tables WHERE Tags = 'sales' OR Name = 'FactProductInventory';

SELECT * FROM Tables WHERE Tags != 'FactProductInventory' AND NOT Tags = 'sales';

SELECT * FROM Tables WHERE NOT Tags = 'FactProductInventory';

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Etiquetas¶

Obtenga una lista de etiquetas de bases de datos, tablas y objetos.

Información Específica de la Tabla¶

Seleccionar¶

El conector usará la API de Azure Data Catalog para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Name admite los operadores '=, !=, <>, CONTAINS'.
• Timestamp admite los operadores '=, <, <=, >, >=, CONTAINS'.
• LastRegisteredTime admite los operadores '=, CONTAINS'.
• ObjectType apoya el = operador.
• SourceType apoya el = operador.
• FriendlyName admite los operadores '=, CONTAINS'.
• Experts admite los operadores '=, CONTAINS'.
• Description admite los operadores '=, CONTAINS'.
• Tags admite los operadores '=, !=, <>, CONTAINS'.
• HasTags apoya el = operador.
• HasPreviews apoya el = operador.
• HasDocumentation apoya el = operador.
• HasTableDataProfiles apoya el = operador.
• HasColumnsDataProfiles apoya el = operador.
• HasDescription apoya el = operador.
• View apoya el = operador.
• Facets apoya el = operador.

Por ejemplo:

SELECT * FROM Tags WHERE HasTags = 'true' AND CONTAINS(Name,'sales')

SELECT * FROM Tags WHERE FriendlyName <> 'sales';

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Procedimientos Almacenados¶

Procedimientos almacenados* están disponibles para complementar los datos disponibles del Modelo de datos. Puede ser necesario actualizar los datos disponibles desde una vista usando un procedimiento almacenado* porque los datos no proporcionan actualizaciones bidireccionales directas, similares a tablas. En estas situaciones, la recuperación de los datos se realiza utilizando la vista o tabla adecuada, mientras que la actualización se realiza llamando a un procedimiento almacenado. Procedimientos almacenados* toman una lista de parámetros y devuelven un conjunto de datos que contiene la colección de tuplas que constituyen la respuesta.

Jitterbit Connector para Procedimientos Almacenados de Azure Data Catalog¶

GetAdminConsentURL¶

Obtiene la URL de consentimiento del administrador que un administrador de un dominio determinado debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita cuando se usan credenciales de OAuth personalizadas.

Aporte¶

Columnas del Conjunto de Resultados¶

Obtener Token de Acceso de OAuth¶

Obtiene un token de autenticación de AzureDataCatalog.

Aporte¶

Columnas del Conjunto de Resultados¶

Obtener URL de Autorización de OAuth¶

Obtiene la URL de autorización que el usuario debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita al desarrollar aplicaciones web. Solicitará el OAuthAccessToken desde esta URL.

Aporte¶

Columnas del Conjunto de Resultados¶

RefreshOAuthAccessToken¶

Actualiza el token de acceso de OAuth que se usa para la autenticación con AzureDataCatalog.

Aporte¶

Columnas del Conjunto de Resultados¶

Tablas del Sistema¶

Puede consultar las tablas del sistema que se describen en esta sección para acceder a la información del esquema, la información sobre la funcionalidad del origen de datos y las estadísticas de operación lote.

Tablas de Esquema¶

Las siguientes tablas devuelven metadatos de base de datos para Azure Data Catalog:

• sys_catalogs: enumera las bases de datos disponibles.
• sys_schemas: enumera los esquemas disponibles.
• sys_tablas: enumera las tablas y vistas disponibles.
• sys_tablecolumns: Describe las columnas de las tablas y vistas disponibles.
• procedimientos_sys: describe los procedimientos almacenados disponibles.
• parámetros_procedimiento_sys: Describe procedimiento almacenado* parámetros.
• sys_keycolumns: describe las claves principal y externa.
• índices_sys: Describe los índices disponibles.

Tablas de Fuentes de Datos¶

Las siguientes tablas devuelven información sobre cómo conectarse y consultar la fuente de datos:

• sys_connection_props: Devuelve información sobre las propiedades de conexión disponibles.
• sys_sqlinfo: describe las consultas SELECT que el conector puede descargar al origen de datos.

Tablas de Información de Consulta¶

La siguiente tabla devuelve estadísticas de consultar para consultas de modificación de datos:

• identidad_sys: devuelve información sobre operaciones lote o actualizaciones individuales.

Sys_catalogs¶

Enumera las bases de datos disponibles.

La siguiente consultar recupera todas las bases de datos determinadas por la cadena de conexión:

SELECT * FROM sys_catalogs

Columnas¶

Sys_schemas¶

Enumera los esquemas disponibles.

La siguiente consultar recupera todos los esquemas disponibles:

SELECT * FROM sys_schemas

Columnas¶

Sys_tables¶

Enumera las tablas disponibles.

La siguiente consultar recupera las tablas y vistas disponibles:

SELECT * FROM sys_tables

Columnas¶

Sys_tablecolumns¶

Describe las columnas de las tablas y vistas disponibles.

La siguiente consultar devuelve las columnas y los tipos de datos de la tabla Tablas:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Tables' 

Columnas¶

Sys_procedimientos¶

Enumera los procedimientos almacenados disponibles.

La siguiente consultar recupera los procedimientos almacenados disponibles:

SELECT * FROM sys_procedures

Columnas¶

Sys_procedureparameters¶

Describe procedimiento almacenado* parámetros.

La siguiente consultar devuelve información sobre todos los parámetros de entrada para el procedimiento almacenado SelectEntries:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columnas¶

Sys_keycolumns¶

Describe las claves primarias y foráneas. La siguiente consultar recupera la clave principal de la tabla Tables:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Tables'

Columnas¶

Sys_foreignkeys¶

Describe las claves foráneas. La siguiente consultar recupera todas las claves foráneas que hacen referencia a otras tablas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columnas¶

Sys_indexes¶

Describe los índices disponibles. Al filtrar en los índices, puede escribir consultas más selectivas con tiempos de respuesta de consultar más rápidos.

La siguiente consultar recupera todos los índices que no son claves principales:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columnas¶

Sys_connection_props¶

Devuelve información sobre las propiedades de conexión disponibles y las establecidas en la cadena de conexión.

Al consultar esta tabla, se debe usar la cadena de conexión de configuración:

jdbc:cdata:azuredatacatalog:config:

Esta cadena de conexión le permite consultar esta tabla sin una conexión válida.

La siguiente consultar recupera todas las propiedades de conexión que se han establecido en la cadena de conexión o se han establecido a través de un valor predeterminado:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columnas¶

Sys_sqlinfo¶

Describe el procesamiento de consultar SELECT que el conector puede descargar al origen de datos.

Procesamiento Colaborativo de Consultas¶

Al trabajar con fuentes de datos que no admiten SQL-92, puede consultar la vista sys_sqlinfo para determinar las capacidades de consultar de las APIs subyacentes, expresadas en sintaxis SQL. El conector descarga la mayor cantidad posible del procesamiento de sentencias SELECT al servidor y luego procesa el resto de la consultar en la memoria.

Descubrimiento de las Capacidades SELECT de la Fuente de Datos¶

A continuación se muestra un conjunto de datos de ejemplo de las capacidades de SQL. El siguiente conjunto de resultados indica la funcionalidad SELECT que el conector puede descargar en el origen de datos o en el lado del cliente del proceso. Su fuente de datos puede admitir sintaxis SQL adicional. Algunos aspectos de la funcionalidad SELECT se devuelven en una lista separada por comas si es compatible; de lo contrario, la columna contiene NO.

La siguiente consultar recupera los operadores que se pueden usar en la cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Tenga en cuenta que las tablas individuales pueden tener diferentes limitaciones o requisitos en la cláusula WHERE; consulte el Modelo de datos para obtener más información.

Columnas¶

Sys_identidad¶

Devuelve información sobre los intentos de modificación.

La siguiente consultar recupera los Id. de las filas modificadas en una operación lote:

SELECT * FROM sys_identity

Columnas¶

Propiedades de Configuraciones Avanzadas¶

Las propiedades de configuraciones avanzadas son las diversas opciones que se pueden utilizar para establecer una conexión. Esta sección proporciona una lista completa de las opciones que puede configurar. Haga clic en los enlaces para obtener más detalles.

Autenticación

Autenticación de Azure

OAuth

JWT OAuth

SSL

Esquema

Misceláneas

Autenticación¶

Esta sección proporciona una lista completa de las propiedades de autenticación que puede configurar.

AuthScheme¶

El tipo de autenticación que se usará al conectarse a Azure Data Catalog.

Valores Posibles¶

AzureAD, AzureMSI, AzureServicePrincipal

Tipo de Datos¶

string

Valor por Defecto¶

"AzureAD"

Observaciones¶

• AzureAD: configure esto para realizar la autenticación OAuth de Azure Active Directory.
• AzureMSI: configure esto para obtener automáticamente las credenciales de identidad de servicio administrado cuando se ejecuta en una máquina virtual de Azure.
• AzureServicePrincipal: configure esto para autenticarse como una entidad de servicio de Azure.

CatalogName¶

El nombre del catálogo al que conectarse.

Tipo de Datos¶

string

Valor por Defecto¶

"defaultcatalog"

Observaciones¶

Si se deja en blanco, se utilizará el catálogo predeterminado. Para obtener un nombre de catálogo determinado, navegue hasta Azure Portal home page -> Data Catalog -> Catalog Name.

Autenticación de Azure¶

Esta sección proporciona una lista completa de las propiedades de autenticación de Azure que puede configurar.

AzureInquilino¶

El inquilino de Microsoft Online que se usa para acceder a los datos. Si no se especifica, se utilizará su tentant predeterminado.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El inquilino de Microsoft Online que se usa para acceder a los datos. Por ejemplo, contoso.onmicrosoft.com. Como alternativa, especifique el Id. de arrendatario. Este valor es el ID de directorio en Azure Portal > Active Directory de Azure > Propiedades.

Por lo general, no es necesario especificar el Arrendatario. Microsoft puede determinar esto automáticamente cuando se utiliza el OAuthGrantType establecido en CÓDIGO (predeterminado). Sin embargo, puede fallar en el caso de que el usuario pertenezca a varios inquilinos. Por ejemplo, si un administrador del dominio A invita a un usuario del dominio B a ser un usuario invitado. El usuario ahora pertenecerá a ambos inquilinos. Es una buena práctica especificar el Tenant, aunque en general las cosas normalmente deberían funcionar sin tener que especificarlo.

El AzureTenant es necesario cuando se configura OAuthGrantType al CLIENTE. Cuando se usan credenciales de cliente, no hay contexto de usuario. Las credenciales se toman del contexto de la propia aplicación. Si bien Microsoft todavía permite obtener las credenciales de los clientes sin especificar qué arrendatario, tiene una probabilidad mucho menor de elegir el arrendatario específico con el que desea trabajar. Por esta razón, requerimos AzureTenant debe indicarse explícitamente para todas las conexiones de credenciales de clientes para garantizar que obtenga las credenciales que se aplican al dominio al que desea conectarse.

AzureAmbiente¶

El ambiente de Azure que se usará al establecer una conexión.

Valores Posibles¶

GLOBAL, CHINA, GERMANY, USGOVT, USGOVTDOD

Tipo de Datos¶

string

Valor por Defecto¶

"GLOBAL"

Observaciones¶

En la mayoría de los casos, funcionará dejar el ambiente establecido en global. Sin embargo, si su cuenta de Azure se ha agregado a un ambiente diferente, el AzureEnvironment se puede utilizar para especificar qué ambiente. Los valores disponibles son GLOBAL, CHINA, GERMANY, USGOVT y USGOVTDOD.

OAuth¶

Esta sección proporciona una lista completa de las propiedades de OAuth que puede configurar.

Iniciar OAuth¶

Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.

Valores Posibles¶

OFF, GETANDREFRESH, REFRESH

Tipo de Datos¶

string

Valor por Defecto¶

"OFF"

Observaciones¶

Las siguientes opciones están disponibles:

1. OFF: Indica que el flujo de OAuth será manejado en su totalidad por el usuario. Se requerirá un OAuthAccessToken para la autenticación.
2. GETANDREFRESH: indica que el conector manejará todo el flujo de OAuth. Si actualmente no existe ningún token, se obtendrá solicitándolo al usuario a través del navegador. Si existe un token, se actualizará cuando corresponda.
3. REFRESH: indica que el conector solo manejará la actualización de OAuthAccessToken. El conector nunca le pedirá al usuario que se autentique a través del navegador. El usuario debe manejar la obtención de OAuthAccessToken y OAuthRefreshToken inicialmente.

OAuthClientId¶

El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId valor, a veces también llamado clave de consumidor, y un secreto de cliente, el OAuthClientSecret.

OAuthClientSecretOAuthClientSecret¶

El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId, también denominada clave de consumidor. También recibirá un secreto de cliente, también llamado secreto de consumidor. Establezca el secreto del cliente en OAuthClientSecret propiedad.

Token de Acceso de OAuth¶

El token de acceso para conectarse mediante OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El OAuthAccessToken la propiedad se usa para conectarse usando OAuth. El OAuthAccessToken se recupera del servidor OAuth como parte del proceso de autenticación. Tiene un tiempo de espera dependiente del servidor y se puede reutilizar entre solicitudes.

El token de acceso se utiliza en lugar de su nombre de usuario y contraseña. El token de acceso protege sus credenciales manteniéndolas en el servidor.

URL de Devolución de Llamada¶

La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Durante el proceso de autenticación, el servidor de autorización de OAuth redirige al usuario a esta URL. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

OAuthVerifier¶

El código verificador devuelto desde la URL de autorización de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El código verificador devuelto desde la URL de autorización de OAuth. Esto se puede usar en sistemas en los que no se puede iniciar un navegador, como los sistemas sin cabeza.

Autenticación en Máquinas Sin Cabeza¶

Ver para obtener el OAuthVerifier valor.

Establezca OAuthSettingsLocation junto con OAuthVerifier. Cuando se conecta, el conector intercambia el OAuthVerifier para los tokens de autenticación de OAuth y los guarda, encriptados, en el archivo especificado. Establecer Iniciar OAuth para GETANDREFRESH automatizar el intercambio.

Una vez que se haya generado el archivo de configuración de OAuth, puede eliminar OAuthVerifier desde las propiedades de conexión y conéctese con OAuthSettingsLocation colocar.

Para actualizar automáticamente los valores del token de OAuth, establezca OAuthSettingsLocation y además configure InitiateOAuth refrescar.

OAuthRefreshToken¶

El token de actualización de OAuth para el token de acceso de OAuth correspondiente.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El OAuthRefreshToken la propiedad se usa para actualizar el OAuthAccessToken al usar la autenticación OAuth.

OAuthExpiresIn¶

La vida útil en segundos del AccessToken de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Empareje con OAuthTokenTimestamp para determinar cuándo caducará el AccessToken.

OAuthTokenTimestamp¶

La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Emparéjese con OAuthExpiresIn para determinar cuándo expirará AccessToken.

JWT OAuth¶

Esta sección proporciona una lista completa de las propiedades de JWT OAuth que puede configurar.

OAuthJWTCert¶

El almacén de certificados JWT.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El nombre del almacén de certificados para el certificado de cliente.

El OAuthJWTCertType especifica el tipo de almacén de certificados especificado por OAuthJWTCert. Si la tienda está protegida con contraseña, especifique la contraseña en OAuthJWTCertPassword.

OAuthJWTCert se usa junto con OAuthJWTCertSubject para especificar certificados de cliente. Si OAuthJWTCert tiene un valor y OAuthJWTCertSubject, se inicia una búsqueda de un certificado. Consulte OAuthJWTCertSubject campo para más detalles.

Las designaciones de los almacenes de certificados dependen de la plataforma.

Las siguientes son designaciones de los almacenes de certificados de usuario y máquina más comunes en Windows:

En Java, el almacén de certificados normalmente es un archivo que contiene certificados y claves privadas opcionales.

Cuando el tipo de almacén de certificados es PFXFile, esta propiedad debe establecerse en el nombre del archivo. Cuando el tipo es PFXBlob, la propiedad debe establecerse en el contenido binario de un archivo PFX (es decir, almacén de certificados PKCS12).

OAuthJWTCertType¶

El tipo de almacén de claves que contiene el certificado JWT.

Valores Posibles¶

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Tipo de Datos¶

string

Valor por Defecto¶

"USER"

Observaciones¶

Esta propiedad puede tomar uno de los siguientes valores:

OAuthJWTCertPassword¶

La contraseña para el certificado OAuth JWT.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Si el almacén de certificados es de un tipo que requiere una contraseña, esta propiedad se usa para especificar esa contraseña para abrir el almacén de certificados.

OAuthJWTCertSubject¶

El asunto del certificado OAuth JWT.

Tipo de Datos¶

string

Valor por Defecto¶

"\*"

Observaciones¶

Al cargar un certificado, el asunto se utiliza para ubicar el certificado en el almacén.

Si no se encuentra una coincidencia exacta, se busca en la tienda temas que contengan el valor de la propiedad.

Si aún no se encuentra una coincidencia, la propiedad se establece en una cadena vacía y no se selecciona ningún certificado.

El valor especial "*" selecciona el primer certificado en el almacén de certificados.

El asunto del certificado es una lista separada por comas de valores y campos de nombre distinguido. Por ejemplo, "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Los campos comunes y sus significados se muestran a continuación.

Si un valor de campo contiene una coma, debe estar entre comillas.

OAuthJWTIssuer¶

El emisor del token web de Java.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El emisor del token web de Java. Suele ser el ID del cliente o la dirección de Correo de la aplicación OAuth.

OAuthJWTAsunto¶

El sujeto de usuario para el que la aplicación solicita acceso delegado.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El sujeto de usuario para el que la aplicación solicita acceso delegado. Por lo general, el nombre de la cuenta de usuario o la dirección de correo.

SSL¶

Esta sección proporciona una lista completa de las propiedades SSL que puede configurar.

SSLServerCert¶

El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Si usa una conexión TLS/SSL, esta propiedad se puede usar para especificar el certificado TLS/SSL que se aceptará del servidor. Se rechaza cualquier otro certificado que no sea de confianza para la máquina.

Esta propiedad puede tomar las siguientes formas:

Si no se especifica, se acepta cualquier certificado en el que confíe la máquina.

La máquina valida los certificados como confiables según el almacén de confianza del sistema. El almacén de confianza utilizado es el valor 'javax.net.ssl.trustStore' especificado para el sistema. Si no se especifica ningún valor para esta propiedad, se utiliza el almacén de confianza predeterminado de Java (por ejemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar que acepta todos los certificados. Tenga en cuenta que esto no se recomienda debido a problemas de seguridad.

Esquema¶

Esta sección proporciona una lista completa de propiedades de esquema que puede configurar.

Ubicación¶

Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.

Tipo de Datos¶

string

Valor por Defecto¶

"%APPDATA%\\\AzureDataCatalog Data Provider\\Schema"

Observaciones¶

La ruta a un directorio que contiene los archivos de esquema para el conector (archivos .rsd para tablas y vistas, archivos .rsb para procedimientos almacenados). La ubicación de la carpeta puede ser una ruta relativa desde la ubicación del ejecutable. El Location La propiedad solo es necesaria si desea personalizar las definiciones (por ejemplo, cambiar el nombre de una columna, ignorar una columna, etc.) o ampliar el modelo de datos con nuevas tablas, vistas o procedimientos almacenados.

Si no se especifica, la ubicación predeterminada es "%APPDATA%\\AzureDataCatalog Data Provider\Schema" con %APPDATA% estando configurado en el directorio de configuración del usuario:

Esquemas Navegables¶

Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Enumerar los esquemas de las bases de datos puede resultar costoso. Proporcionar una lista de esquemas en la cadena de conexión mejora el rendimiento.

Mesas¶

Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA,TablaB,TablaC.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Listar las tablas de algunas bases de datos puede resultar costoso. Proporcionar una lista de tablas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las tablas que desea en una lista separada por comas. Cada tabla debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Puntos de Vista¶

Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA,VistaB,VistaC.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Listar las vistas de algunas bases de datos puede ser costoso. Proporcionar una lista de vistas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las vistas que desee en una lista separada por comas. Cada vista debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Misceláneas¶

Esta sección proporciona una lista completa de propiedades misceláneas que puede configurar.

Filas Máximas¶

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Tipo de Datos¶

int

Valor por Defecto¶

-1

Observaciones¶

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Otro¶

Estas propiedades ocultas se usan solo en casos de uso específicos.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Las propiedades enumeradas a continuación están disponibles para casos de uso específicos. Los casos de uso y la funcionalidad normales del controlador no deberían requerir estas propiedades.

Especifique varias propiedades en una lista separada por punto y coma.

Integración y Formateo¶

Tamaño de Página¶

El número máximo de resultados que se devolverán por página desde Azure Data Catalog.

Tipo de Datos¶

int

Valor por Defecto¶

100

Observaciones¶

El Pagesize la propiedad afecta al número máximo de resultados que se devolverán por página desde Azure Data Catalog. Establecer un valor más alto puede resultar en un mejor rendimiento a costa de memoria adicional asignada por página consumida.

Pseudocolumnas¶

Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Esta configuración es particularmente útil en Entity Framework, que no le permite establecer un valor para una pseudocolumna a menos que sea una columna de tabla. El valor de esta configuración de conexión tiene el formato "Tabla1=Columna1, Tabla1=Columna2, Tabla2=Columna3". Puede usar el carácter "*" para incluir todas las tablas y todas las columnas; por ejemplo, "*=*".

Se Acabó el Tiempo¶

El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

Tipo de Datos¶

int

Valor por Defecto¶

60

Observaciones¶

Si Timeout = 0, las operaciones no expiran. Las operaciones se ejecutan hasta que se completan correctamente o hasta que encuentran una condición de error.

Si Timeout caduca y la operación aún no se ha completado, el conector genera una excepción.