Drivers JDBC desempacotados

As instruções nesta página se aplicam apenas a implantações do Looker hospedadas pelo cliente. Para implantações hospedadas pelo Looker, a instância do Looker precisa estar pré-configurada. Se você encontrar algum problema, entre em contato com seu analista do Looker.

Estas instruções devem ser usadas apenas com os dialetos especificados na tabela a seguir. Eles não devem ser usados para instalar outros drivers JDBC não compatíveis no Looker para se conectar a outros bancos de dados. As tentativas de instalar drivers JDBC diferentes dos listados podem não funcionar e não estão qualificadas para receber suporte técnico do Looker.

Configurar o Looker para usar drivers JDBC não empacotados

Em alguns dos dialetos compatíveis do Looker, o driver JDBC não pode ser empacotado no arquivo JAR do Looker por motivos relacionados ao licenciamento. Nesses casos, instale o driver JDBC no servidor do Looker e configure o Looker para registrar o driver não empacotado, conforme descrito nesta página.

Todos os dialetos com o valor "Não" em "Compatível?" exigem instalações de driver JDBC não empacotadas:

Dialeto	Compatível?
Actian Avalanche	Não
Amazon Athena	Sim
Amazon Aurora MySQL	Sim
Amazon Redshift	Sim
Amazon Redshift 2.1+	Sim
Amazon Redshift Serverless 2.1+	Sim
Apache Druid	Sim
Apache Druid 0.13+	Sim
Apache Druid 0.18+	Sim
Apache Hive 2.3+	Sim
Apache Hive 3.1.2+	Sim
Apache Spark 3+	Sim
ClickHouse	Sim
Cloudera Impala 3.1+	Sim
Cloudera Impala 3.1+ with Native Driver	Não
Cloudera Impala with Native Driver	Não
DataVirtuality	Não
Databricks	Sim
Denodo 7	Sim
Denodo 8 & 9	Sim
Dremio	Sim
Dremio 11+	Sim
Exasol	Sim
Google BigQuery Legacy SQL	Sim
Google BigQuery Standard SQL	Sim
Google Cloud PostgreSQL	Sim
Google Cloud SQL	Sim
Google Spanner	Sim
Greenplum	Sim
HyperSQL	Sim
IBM Netezza	Sim
MariaDB	Sim
Microsoft Azure PostgreSQL	Sim
Microsoft Azure SQL Database	Sim
Microsoft Azure Synapse Analytics	Sim
Microsoft SQL Server 2008+	Sim
Microsoft SQL Server 2012+	Sim
Microsoft SQL Server 2016	Sim
Microsoft SQL Server 2017+	Sim
MongoBI	Não
MySQL	Sim
MySQL 8.0.12+	Sim
Oracle	Sim
Oracle ADWC	Sim
PostgreSQL 9.5+	Sim
PostgreSQL pre-9.5	Sim
PrestoDB	Sim
PrestoSQL	Sim
SAP HANA	Sim
SAP HANA 2+	Sim
SingleStore	Sim
SingleStore 7+	Sim
Snowflake	Sim
Teradata	Não
Trino	Sim
Vector	Não
Vertica	Sim

Pré-requisitos

Para conectar o Looker a um banco de dados que exige um driver JDBC não empacotado, você vai precisar do seguinte:

• Acesso à linha de comando do seu servidor do Looker.
• O driver JDBC como um arquivo JAR. A documentação específica do dialeto pode ter instruções sobre onde baixar esse arquivo. Caso contrário, presume-se que você tenha acesso ao arquivo JAR necessário.
• O símbolo do driver para seu dialeto. Um símbolo de driver é um valor de string que o Looker usa internamente para corresponder o dialeto ao driver. Os exemplos nesta página usam o valor genérico driver_symbol. Consulte a documentação do Looker para cada dialeto e confira os símbolos que o Looker usa para registrar drivers JDBC em dialetos.
• A entrada de driver YAML do seu dialeto a ser adicionada ao arquivo de configuração custom_jdbc_config.yml. Consulte a seção Entradas de driver no arquivo de configuração YAML nesta página para mais informações.

Entradas de driver no arquivo de configuração YAML

Confira um exemplo de entrada de driver no arquivo custom_jdbc_config.yml:

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

Ao escrever a entrada do driver para seu dialeto:

• O arquivo custom_jdbc_config.yml é baseado em YAML, o que significa que o recuo e o espaçamento são importantes.
• Os atributos name e dir_name precisam ser o símbolo do driver que o Looker usa para seu dialeto ao registrar drivers JDBC.
• É possível usar o atributo file_name em vez de dir_name, que contém o caminho relativo de custom_jdbc_drivers para o arquivo JAR do driver JDBC. O dir_name é recomendado porque promove a manutenção de vários drivers isolados nos próprios diretórios e reduz a chance de conflito entre classes Java.
• A propriedade module_path depende do driver JDBC específico. Ele precisa ser o caminho totalmente qualificado para a classe de driver do Java. Este exemplo usa um valor genérico, mas para encontrar o module_path específico usado pelo driver, consulte a documentação sobre como registrar a classe do driver.
• O override_jdbc_url_subprotocol é um argumento opcional usado para substituir o subprotocolo usado na string JDBC que o Looker envia ao banco de dados. Uma string JDBC típica é assim:

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

em que mysql é o subprotocolo JDBC usado.

Se você especificar override_jdbc_url_subprotocol: driver_subprotocol, a string JDBC será:

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

Essa opção é obrigatória se você precisar usar um driver JDBC não empacotado que exija um subprotocolo de URL diferente do padrão do Looker. Na maioria dos casos, isso não é necessário, a menos que a documentação do dialeto diga explicitamente que é. MongoBI é um exemplo de dialeto que exige essa opção.

Como instalar drivers JDBC não empacotados

1. Mude para o diretório base do aplicativo Looker. Neste exemplo, usamos looker como o diretório base.

   cd looker
   

2. Crie um diretório chamado custom_jdbc_drivers. Este é o diretório de nível superior para todas as instalações de drivers JDBC não empacotados. O caminho para esse diretório precisa ser looker/custom_jdbc_drivers

   mkdir custom_jdbc_drivers
   

3. No diretório custom_jdbc_drivers, crie um subdiretório com o símbolo do driver do seu dialeto. Este exemplo usa o valor genérico driver_symbol. O caminho resultante para o diretório será semelhante a looker/custom_jdbc_drivers/driver_symbol

   cd custom_jdbc_drivers
   mkdir driver_symbol
   

4. Coloque os arquivos do driver JDBC para seu dialeto nesse diretório. O método para isso depende de onde o driver do seu dialeto pode ser encontrado e enviado para o servidor. No entanto, verifique se os arquivos JAR relevantes estão no diretório driver_symbol: looker/custom_jdbc_drivers/driver_symbol/

   Por exemplo: looker/custom_jdbc_drivers/driver_symbol/DialectDriver.jar

   A forma de mover os arquivos necessários para o servidor do Looker varia de acordo com a origem dos arquivos de driver e sua preferência de transferência de arquivos. Exemplos de comandos para transferir arquivos para esse diretório incluem wget, scp e curl.

5. Mude o diretório para o diretório do aplicativo Looker e crie um arquivo de configuração chamado custom_jdbc_config.yml. O caminho para esse arquivo precisa ser looker/custom_jdbc_config.yml. Esse arquivo vai conter as informações necessárias para o Looker localizar e registrar o driver JDBC personalizado.

   cd looker
   vim custom_jdbc_config.yml
   

6. Adicione uma nova entrada para seu dialeto no arquivo de configuração custom_jdbc_config.yml. Consulte a seção Entradas de driver no arquivo de configuração YAML nesta página para informações sobre entradas de driver.

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

7. Crie ou atualize o arquivo lookerstart.cfg para que o aplicativo Looker seja iniciado com a configuração do driver JDBC não empacotado. O caminho para esse arquivo precisa ser looker/lookerstart.cfg. Adicione a opção --use-custom-jdbc-config. Se houver outras opções, adicione isso ao final das opções de inicialização do Looker:

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

   Se você tiver LOOKERARGS definido em outro lugar que não seja lookerstart.cfg, como em uma variável de ambiente, adicione essa flag de inicialização lá. Como alternativa, defina LOOKERARGS="${LOOKERARGS} --use-custom-jdbc-config" para que os valores atuais sejam expandidos nesse arquivo.

8. Reinicie o aplicativo Looker. Nesse comando, use o nome do seu script de inicialização do Looker, como ./looker ou ./looker.sh.

   ./looker restart
   

   ou none ./looker stop ./looker start

Vários drivers JDBC não empacotados

Se você precisar configurar mais de um dialeto para usar drivers JDBC não empacotados, o processo descrito na seção Instalar drivers JDBC não empacotados ainda será válido. O diretório custom_jdbc_drivers terá vários subdiretórios dialect com os próprios JARs de driver, e o arquivo custom_jdbc_config.yml terá várias 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