Pilotes JDBC non empaquetés

Les instructions de cette page ne s'appliquent qu'aux déploiements de Looker hébergés par un client. Pour les déploiements hébergés par Looker, votre instance Looker doit être préconfigurée pour vous. Si vous rencontrez des problèmes, contactez votre analyste Looker.

Ces instructions sont destinées à être utilisées uniquement avec les dialectes spécifiés dans le tableau suivant. Ils ne sont pas destinés à être utilisés pour installer d'autres pilotes JDBC non compatibles dans Looker afin de se connecter à d'autres bases de données. Les tentatives d'installation de pilotes JDBC autres que les pilotes listés risquent de ne pas fonctionner et de ne pas bénéficier de l'assistance technique de Looker.

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 ou version ultérieure	Oui
Apache Druid 0.18 et versions ultérieures	Oui
Apache Hive 2.3 ou version ultérieure	Oui
Apache Hive 3.1.2 ou version ultérieure	Oui
Apache Spark 3 ou version ultérieure	Oui
ClickHouse	Oui
Cloudera Impala 3.1 ou version ultérieure	Oui
Cloudera Impala 3.1 ou version ultérieure avec pilote natif	Non
Cloudera Impala avec Native Driver	Non
DataVirtuality	Non
Databricks	Oui
Denodo 7	Oui
Denodo 8	Oui
Dremio	Oui
Dremio 11 ou version ultérieure	Oui
Exasol	Oui
Feu	Oui
Google BigQuery Legacy SQL	Oui
SQL standard de Google BigQuery	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
Base de données Microsoft Azure SQL	Oui
Microsoft Azure Synapse Analytics	Oui
Microsoft SQL Server 2008 ou version ultérieure	Oui
Microsoft SQL Server 2012 ou version ultérieure	Oui
Microsoft SQL Server 2016	Oui
Microsoft SQL Server 2017 et versions ultérieures	Oui
MongoBI	Non
MySQL	Oui
MySQL 8.0.12 et versions ultérieures	Oui
Oracle	Oui
Oracle ADWC	Oui
PostgreSQL 9.5 ou version ultérieure	Oui
PostgreSQL version antérieure à 9.5	Oui
PrestoDB	Oui
PrestoSQL	Oui
SAP HANA 2 ou version ultérieure	Oui
SingleStore	Oui
SingleStore 7 et versions ultérieures	Oui
Snowflake	Oui
Teradata	Non
Trino	Oui
Vecteur	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 de Looker pour connaître les symboles utilisés par Looker pour enregistrer les pilotes JDBC dans les dialectes.
• L'entrée de pilote YAML pour votre dialecte à ajouter au fichier de configuration custom_jdbc_config.yml 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 écrivez l'entrée du pilote pour votre dialecte:

• Le fichier custom_jdbc_config.yml est basé sur YAML, ce qui signifie que les retraits et les espaces 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 à la classe de pilote Java. Cet exemple utilise une valeur générique, mais pour trouver la classe module_path spécifique utilisée par le conducteur, consultez sa documentation expliquant comment enregistrer la classe de 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 typique 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 se présentera comme suit:

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 indique explicitement que c'est le cas. MongoBI est un exemple de dialecte qui nécessite cette option.

Installer des pilotes JDBC non empaquetés

1. Passez 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 du pilote JDBC de votre dialecte dans ce répertoire. La méthode dépend de l'emplacement où le pilote de votre dialecte peut être trouvé et importé sur le serveur, mais assurez-vous que le ou les fichiers JAR pertinents 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 manière dont vous déplacez les fichiers nécessaires sur le serveur Looker dépend de l'emplacement où vous obtenez les fichiers pilotes et de vos préférences 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. Passez au répertoire de l'application Looker et 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 pour que l'application Looker démarre avec la configuration du pilote JDBC décompressé. Le chemin d'accès à ce fichier doit être looker/lookerstart.cfg. Ajoutez l'option --use-custom-jdbc-config. S'il existe d'autres options, ajoutez ceci à la fin des options de démarrage de Looker:

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

   Si LOOKERARGS n'est pas défini sur 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, tel que ./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 les pilotes JDBC décompressé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