Pilotes JDBC non empaquetés

robots: noindex

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

**Ces instructions ne doivent être utilisées qu'avec les dialectes spécifiés ci-dessous. Il ne doit pas servir à installer d'autres pilotes JDBC non compatibles avec Looker pour la connexion à d'autres bases de données.** Les tentatives d'installation de pilotes JDBC autres que les pilotes répertoriés peuvent ne pas fonctionner et ne peuvent pas bénéficier de l'assistance technique de Looker.

Configurer Looker pour utiliser les pilotes JDBC non empaquetés

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

Le tableau suivant présente les dialectes qui nécessitent des installations de pilote JDBC non empaquetées:

Prérequis

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

• Accès en ligne de commande à votre serveur Looker.
• Pilote JDBC en tant que fichier JAR. La documentation spécifique du dialecte peut contenir des instructions pour télécharger ce fichier. Sinon, nous supposons que vous avez accès au fichier JAR nécessaire.
• Le 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 conducteur. Les exemples de cette page utilisent la valeur générique driver_symbol. Consultez la liste des symboles de pilote sur cette page pour connaître les symboles utilisés par Looker pour enregistrer les pilotes JDBC sur les dialectes.
• L'entrée du pilote YAML pour votre dialecte à ajouter au fichier de configuration custom_jdbc_config.yml. Pour en savoir plus, consultez la section Entrées du pilote dans le fichier de configuration YAML de cette page.

Entrées du pilote dans le fichier de configuration YAML

Voici un exemple d'entrée de conducteur 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 être le symbole de pilote que Looker attend pour votre dialecte lors de l'enregistrement des pilotes JDBC.
• Il est possible d'utiliser l'attribut file_name au lieu de dir_name contenant le chemin d'accès relatif de custom_jdbc_drivers vers le fichier JAR du pilote JDBC. dir_name est recommandé, car cela permet d'isoler plusieurs pilotes dans leurs propres répertoires, et de réduire 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. Toutefois, pour trouver le module_path spécifique que le conducteur utilise, consultez sa documentation sur l'enregistrement de la classe de conducteur.
• override_jdbc_url_subprotocol est un argument facultatif utilisé pour remplacer le sous-protocole utilisé dans la chaîne JDBC que Looker envoie à la base de données. Voici à quoi ressemble une chaîne JDBC type:

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 nécessaire 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, cela n'est pas nécessaire, sauf si la documentation du dialecte indique explicitement que c'est nécessaire. 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. Pour ce document, nous supposons que la valeur est looker.

   cd looker
   

2. Créez un répertoire appelé custom_jdbc_drivers. Il s'agit du répertoire de premier niveau pour toutes les installations de pilotes JDBC non empaquetées. 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 nommé avec 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 ressemblera à 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 à utiliser dépend de l'emplacement du pilote de votre dialecte et de son importation sur le serveur. Assurez-vous toutefois 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

   Le déplacement des fichiers nécessaires sur le serveur Looker varie en fonction de l'emplacement des fichiers de pilote et de votre préférence de transfert de fichiers. Exemples de commandes de transfert de fichiers dans ce répertoire : wget, scp, curl, etc.

5. Revenez 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 contiendra les informations dont Looker a besoin pour localiser et enregistrer le pilote JDBC personnalisé.

   cd looker
   vim custom_jdbc_config.yml
   

6. Ajoutez une nouvelle entrée pour votre dialecte dans le fichier de configuration custom_jdbc_config.yml. Pour en savoir plus, consultez la section Entrées du pilote dans le fichier de configuration YAML de 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 le code suivant à la fin des options de démarrage de Looker:

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

   Si vous avez défini LOOKERARGS autre que lookerstart.cfg, par exemple dans une variable d'environnement, vous pouvez ajouter cette option de démarrage. Vous pouvez également définir LOOKERARGS="${LOOKERARGS} --use-custom-jdbc-config" afin 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 afin d'utiliser des pilotes JDBC non empaquetés, la procédure ci-dessus s'applique toujours. Le répertoire custom_jdbc_drivers comporte plusieurs sous-répertoires dialect avec leurs propres fichiers JAR de pilote. Le fichier custom_jdbc_config.yml comporte 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