Pilotes JDBC non empaquetés

Configurer Looker pour utiliser des pilotes JDBC non empaquetés

Pour certains des dialectes compatibles avec Looker, le pilote JDBC ne peut pas être empaqueté dans le fichier JAR de Looker pour des raisons liées aux licences. Dans ce cas, vous devez installer le pilote JDBC sur votre serveur Looker, puis configurer Looker pour qu'il enregistre le pilote non empaqueté, comme décrit sur cette page.

Tous les dialectes dont la valeur est "Non" sous "Compatible ?" nécessitent une installation de pilotes JDBC non empaquetés:

Dialecte Compatibilité
Actian Avalanche
Non
Amazon Athena
Oui
Amazon Aurora MySQL
Oui
Amazon Redshift
Oui
Apache Druid
Oui
Apache Druid 0.13+
Oui
Apache Druid 0.18+
Oui
Apache Hive 2.3+
Oui
Apache Hive 3.1.2+
Oui
Apache Spark 3+
Oui
ClickHouse
Oui
Cloudera Impala 3.1+
Oui
Cloudera Impala 3.1+ with Native Driver
Non
Cloudera Impala with Native Driver
Non
DataVirtuality
Non
Databricks
Oui
Denodo 7
Oui
Denodo 8
Oui
Dremio
Oui
Dremio 11+
Oui
Exasol
Oui
Firebolt
Oui
Google BigQuery Legacy SQL
Oui
Google BigQuery Standard SQL
Oui
Google Cloud PostgreSQL
Oui
Google Cloud SQL
Oui
Google Spanner
Oui
Greenplum
Oui
HyperSQL
Oui
IBM Netezza
Oui
MariaDB
Oui
Microsoft Azure PostgreSQL
Oui
Microsoft Azure SQL Database
Oui
Microsoft Azure Synapse Analytics
Oui
Microsoft SQL Server 2008+
Oui
Microsoft SQL Server 2012+
Oui
Microsoft SQL Server 2016
Oui
Microsoft SQL Server 2017+
Oui
MongoBI
Non
MySQL
Oui
MySQL 8.0.12+
Oui
Oracle
Oui
Oracle ADWC
Oui
PostgreSQL 9.5+
Oui
PostgreSQL pre-9.5
Oui
PrestoDB
Oui
PrestoSQL
Oui
SAP HANA
Oui
SAP HANA 2+
Oui
SingleStore
Oui
SingleStore 7+
Oui
Snowflake
Oui
Teradata
Non
Trino
Oui
Vector
Non
Vertica
Oui

Prérequis

Pour connecter Looker à une base de données qui nécessite un pilote JDBC non empaqueté, vous avez besoin des éléments suivants:

  • Accès en ligne de commande à votre serveur Looker.
  • Pilote JDBC sous forme de fichier JAR. La documentation spécifique du dialecte peut contenir des instructions sur l'emplacement où télécharger ce fichier. Sinon, on suppose que vous avez accès au fichier JAR nécessaire.
  • Symbole du conducteur pour votre dialecte. Un symbole de pilote est une valeur de chaîne que Looker utilise en interne pour faire correspondre le dialecte au pilote. Les exemples de cette page utilisent la valeur générique driver_symbol. Consultez la documentation Looker pour chaque dialecte afin de connaître les symboles utilisés par Looker pour enregistrer les pilotes JDBC dans les dialectes.
  • Entrée de pilote YAML à ajouter au fichier de configuration custom_jdbc_config.yml pour votre dialecte. Pour en savoir plus, consultez la section Enregistrements de pilotes dans le fichier de configuration YAML de cette page.

Entrées de pilote dans le fichier de configuration YAML

Voici un exemple d'entrée de pilote dans le fichier custom_jdbc_config.yml:

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

Lorsque vous rédigez l'entrée du pilote pour votre dialecte:

  • Le fichier custom_jdbc_config.yml est basé sur YAML, ce qui signifie que la mise en retrait et l'espacement sont importants.
  • Les attributs name et dir_name doivent correspondre au symbole de pilote que Looker utilise pour votre dialecte lors de l'enregistrement des pilotes JDBC.
  • Vous pouvez utiliser l'attribut file_name au lieu de dir_name contenant le chemin d'accès relatif de custom_jdbc_drivers au fichier JAR du pilote JDBC. dir_name est recommandé, car il permet de maintenir plusieurs pilotes isolés dans leurs propres répertoires et réduit le risque de collision entre les classes Java.
  • La propriété module_path dépend du pilote JDBC spécifique. Il doit s'agir du chemin d'accès complet de la classe de pilote Java. Cet exemple utilise une valeur générique, mais pour trouver le module_path spécifique utilisé par le pilote, consultez sa documentation sur l'enregistrement de la classe du pilote.
  • override_jdbc_url_subprotocol est un argument facultatif qui permet de remplacer le sous-protocole utilisé dans la chaîne JDBC que Looker envoie à la base de données. Une chaîne JDBC type se présente comme suit:
jdbc:mysql://localhost:3306/database_name[?propertyName1][=propertyValue1]

où mysql est le sous-protocole JDBC utilisé.

Si vous spécifiez override_jdbc_url_subprotocol: driver_subprotocol, cette chaîne JDBC devient:

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

Cette option est obligatoire si vous devez utiliser un pilote JDBC non empaqueté qui nécessite un sous-protocole d'URL autre que le sous-protocole d'URL par défaut de Looker. Dans la plupart des cas, ce n'est pas nécessaire, sauf si la documentation du dialecte l'indique explicitement. MongoBI est un exemple de dialecte qui nécessite cette option.

Installer des pilotes JDBC non empaquetés

  1. Accédez au répertoire de base de l'application Looker. Cet exemple utilise looker comme répertoire de base.

    cd looker

  2. Créez un répertoire appelé custom_jdbc_drivers. Il s'agit du répertoire de premier niveau de toutes les installations de pilotes JDBC non empaquetés. Le chemin d'accès à ce répertoire doit être looker/custom_jdbc_drivers.

    mkdir custom_jdbc_drivers

  3. Dans le répertoire custom_jdbc_drivers, créez un sous-répertoire portant le symbole du pilote de votre dialecte. Cet exemple utilise la valeur générique driver_symbol. Le chemin d'accès au répertoire obtenu se présente comme suit : looker/custom_jdbc_drivers/driver_symbol

    cd custom_jdbc_drivers
mkdir driver_symbol

  4. Placez les fichiers de pilote JDBC pour votre dialecte dans ce répertoire. La méthode à suivre dépend de l'emplacement du pilote de votre dialecte et de son importation sur le serveur. Toutefois, assurez-vous que le ou les fichiers JAR concernés se trouvent dans le répertoire driver_symbol: looker/custom_jdbc_drivers/driver_symbol/

    Par exemple : looker/custom_jdbc_drivers/driver_symbol/DialectDriver.jar

    La méthode de transfert des fichiers nécessaires vers le serveur Looker varie en fonction de l'emplacement où vous obtenez les fichiers de pilote et de votre préférence pour le transfert de fichiers. wget, scp et curl sont des exemples de commandes permettant de transférer des fichiers dans ce répertoire.

  5. Accédez au répertoire de l'application Looker, puis créez un fichier de configuration nommé custom_jdbc_config.yml. Le chemin d'accès à ce fichier doit être looker/custom_jdbc_config.yml. Ce fichier contient les informations dont Looker a besoin pour localiser et enregistrer le pilote JDBC personnalisé.

    cd looker
vim custom_jdbc_config.yml

  6. Ajoutez une entrée pour votre dialecte dans le fichier de configuration custom_jdbc_config.yml. Pour en savoir plus sur les entrées de pilote, consultez la section Entrées de pilote dans le fichier de configuration YAML sur cette page.

    - name: driver_symbol
  dir_name: driver_symbol
  module_path: com.dialect.jdbc.DialectDriver

  7. Créez ou mettez à jour le fichier lookerstart.cfg afin que l'application Looker démarre avec la configuration du pilote JDBC non empaquetée. Le chemin d'accès à ce fichier doit être looker/lookerstart.cfg. Ajoutez l'option --use-custom-jdbc-config. Si d'autres options sont disponibles, ajoutez-les à la fin des options de démarrage de Looker:

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

    Si vous avez défini LOOKERARGS ailleurs que dans lookerstart.cfg, comme dans une variable d'environnement, vous pouvez y ajouter cet indicateur de démarrage. Vous pouvez également définir LOOKERARGS="${LOOKERARGS} --use-custom-jdbc-config" pour que les valeurs existantes soient développées dans ce fichier.

  8. Redémarrez l'application Looker. Dans cette commande, utilisez le nom de votre script de démarrage Looker, par exemple ./looker ou ./looker.sh.

    ./looker restart

    ou none ./looker stop ./looker start

Plusieurs pilotes JDBC non empaquetés

Si vous devez configurer plusieurs dialectes pour utiliser des pilotes JDBC non empaquetés, la procédure décrite dans la section Installer des pilotes JDBC non empaquetés s'applique toujours. Le répertoire custom_jdbc_drivers contient plusieurs sous-répertoires dialect avec leurs propres fichiers JAR de pilotes, et le fichier custom_jdbc_config.yml contient plusieurs entrées:

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