Controladores JDBC sin empaquetar

robots: noindex

Configura Looker para usar controladores JDBC sin empaquetar

Para algunos de los dialectos compatibles con Looker, el controlador de JDBC no se puede empaquetar en el archivo JAR de Looker por motivos relacionados con las licencias. En estos casos, debes instalar el controlador de JDBC en tu servidor de Looker y, luego, configurar Looker para registrar el controlador sin empaquetar como se describe en esta página.

En la siguiente tabla, se muestran los dialectos que requieren instalaciones de controladores JDBC sin empaquetar:

Requisitos previos

Para conectar Looker a una base de datos que requiera un controlador JDBC sin empaquetar, necesitarás lo siguiente:

  • Acceso mediante línea de comandos a tu servidor de Looker.
  • El controlador JDBC como archivo JAR La documentación específica del dialecto puede tener instrucciones sobre dónde descargar este archivo; de lo contrario, suponemos que tienes acceso al archivo JAR necesario.
  • El símbolo del conductor para el dialecto. Un símbolo de controlador es un valor de string que Looker usa internamente para hacer coincidir el dialecto con el controlador. En los ejemplos de esta página, se usa el valor genérico driver_symbol. Consulta la lista de símbolos de controlador en esta página para conocer los símbolos que usa Looker a fin de registrar los controladores de JDBC en dialectos.
  • La entrada del controlador YAML para que tu dialecto se agregue al archivo de configuración custom_jdbc_config.yml Consulta la sección Entradas del controlador en el archivo de configuración YAML en esta página para obtener más información.

Entradas del controlador en el archivo de configuración YAML

A continuación, se muestra un ejemplo de una entrada del controlador en el archivo custom_jdbc_config.yml:

  - name: driver_symbol
    dir_name: driver_symbol
    module_path: com.dialect.jdbc.DialectDriver
    override_jdbc_url_subprotocol: driver_subprotocol  # optional

Cuando escribas la entrada del controlador para tu dialecto, haz lo siguiente:

  • El archivo custom_jdbc_config.yml se basa en YAML, lo que significa que las sangrías y el espaciado son importantes.
  • Los atributos name y dir_name deben ser el símbolo del controlador que Looker espera para ti en el dialecto cuando registre los controladores de JDBC.
  • Es posible usar el atributo file_name en lugar de dir_name, que contiene la ruta relativa de custom_jdbc_drivers al archivo JAR del controlador de JDBC. Se recomienda dir_name porque promueve mantener múltiples controladores aislados en sus propios directorios y reduce la posibilidad de colisión de las clases de Java.
  • La propiedad module_path dependerá del controlador JDBC específico. Debe ser la ruta completamente calificada a la clase del controlador de Java. En este ejemplo, se usa un valor genérico, pero para encontrar el module_path específico que usa el controlador, consulta su documentación sobre cómo registrar la clase de controlador.
  • El override_jdbc_url_subprotocol es un argumento opcional que se usa para anular el subprotocolo utilizado en la string de JDBC que Looker envía a la base de datos. Una string de JDBC típica se verá de la siguiente manera:
jdbc:mysql://localhost:3306/database_name[?propertyName1][=propertyValue1]

En el que mysql es el subprotocolo de JDBC que se usa.

Si especificas override_jdbc_url_subprotocol: driver_subprotocol, esta string de JDBC pasará a ser lo siguiente:

jdbc:driver_subprotocol://localhost:3306/database_name[?propertyName1][=propertyValue1]

Esta opción es obligatoria si necesitas usar un controlador JDBC sin empaquetar que requiere un subprotocolo de URL que no sea el predeterminado de URL de Looker. En la mayoría de los casos, esto no es necesario a menos que en la documentación del dialecto se indique explícitamente que es necesario. MongoBI es un ejemplo de un dialecto que requiere esta opción.

Instala controladores de JDBC sin empaquetar

  1. Cambia al directorio base de la aplicación de Looker. En este documento, supondremos que es looker.

    cd looker
    
  2. Crea un directorio llamado custom_jdbc_drivers. Este es el directorio de nivel superior para todas las instalaciones de controladores de JDBC sin empaquetar. La ruta a este directorio debe ser looker/custom_jdbc_drivers

    mkdir custom_jdbc_drivers
    
  3. En el directorio custom_jdbc_drivers, crea un subdirectorio con el símbolo del controlador de tu dialecto. En este ejemplo, se usa el valor genérico driver_symbol. La ruta resultante al directorio se verá como looker/custom_jdbc_drivers/driver_symbol.

    cd custom_jdbc_drivers
    mkdir driver_symbol
    

  4. Coloca los archivos del controlador de JDBC para tu dialecto en este directorio. El método para hacerlo depende de dónde se pueda encontrar y subir el controlador de tu dialecto en el servidor, pero asegúrate de que los archivos JAR relevantes estén dentro del directorio driver_symbol: looker/custom_jdbc_drivers/driver_symbol/
    Por ejemplo: looker/custom_jdbc_drivers/driver_symbol/DialectDriver.jar

    Mover los archivos necesarios al servidor de Looker variará según la ubicación en la que obtengas los archivos del controlador y tu preferencia para la transferencia de archivos. Algunos ejemplos de comandos para transferir archivos a este directorio son wget, scp, curl, etcétera.

  5. Vuelve al directorio de la aplicación de Looker y crea un archivo de configuración llamado custom_jdbc_config.yml. La ruta a este archivo debe ser looker/custom_jdbc_config.yml. Este archivo contendrá la información que Looker necesita para ubicar y registrar el controlador JDBC personalizado.

    cd looker
    vim custom_jdbc_config.yml
    
  6. Agrega una entrada nueva para tu dialecto al archivo de configuración custom_jdbc_config.yml. Consulta la sección Entradas del controlador en el archivo de configuración YAML en esta página para obtener información sobre las entradas del controlador.

    - name: driver_symbol
      dir_name: driver_symbol
      module_path: com.dialect.jdbc.DialectDriver
    
  7. Crea o actualiza el archivo lookerstart.cfg para que la aplicación de Looker se inicie con la configuración del controlador de JDBC sin empaquetar. La ruta a este archivo debe ser looker/lookerstart.cfg. Agrega la opción --use-custom-jdbc-config. Si hay otras opciones, agrega lo siguiente al final de las opciones de inicio de Looker:

    LOOKERARGS="--use-custom-jdbc-config"
    

    Si configuraste LOOKERARGS en un lugar distinto de lookerstart.cfg, como en una variable de entorno, puedes agregar esta marca de inicio allí. También puedes configurar LOOKERARGS="${LOOKERARGS} --use-custom-jdbc-config" para que los valores existentes se expandan en este archivo.

  8. Reinicia la aplicación de Looker. En este comando, usa el nombre de la secuencia de comandos de inicio de Looker, como ./looker o ./looker.sh.

    ./looker restart
    

    o none ./looker stop ./looker start

Varios controladores JDBC sin empaquetar

Si necesitas configurar más de un dialecto para usar controladores de JDBC sin empaquetar, el proceso anterior se aplica de todas formas. El directorio custom_jdbc_drivers tendrá varios subdirectorios dialect con sus propios JAR de controladores, y el archivo custom_jdbc_config.yml tendrá varias entradas:

ls looker/custom_jdbc_drivers

driver_symbol_1 driver_symbol_2
ls looker/custom_jdbc_drivers/driver_symbol_1

Dialect1Driver.jar
- name: driver_symbol_1
  dir_name: driver_symbol_1
  module_path: com.dialect.jdbc.Dialect1Driver

- name: driver_symbol_2
  dir_name: driver_symbol_2
  module_path: com.dialect.jdbc.Dialect2Driver