Metadados do banco de dados
O ZPA analisa arquivos-fonte, então por padrão só conhece os objetos declarados neles. Tabelas, views, sinônimos, tipos objeto e muitos packages normalmente existem apenas no banco de dados. Quando o ZPA consegue se conectar a um banco Oracle, ele lê as definições desses objetos antes da análise e as usa para resolver nomes que os arquivos-fonte sozinhos não respondem:
- âncoras
%TYPEe%ROWTYPEsobre tabelas e views recebem os tipos das colunas do dicionário; - nomes alcançados por sinônimos privados e públicos são seguidos até os seus destinos;
- chamadas a packages, subprogramas avulsos e métodos de tipos objeto do banco se ligam às suas assinaturas, e os seus resultados recebem o tipo declarado;
- regras que precisam de detalhes das colunas podem verificá-los, como a NullTestOnNotNullColumn, que precisa saber quais colunas nunca podem ser nulas;
- a versão do banco é usada na compilação condicional quando você não a informa.
Sem conexão, a análise funciona como antes; as referências a objetos do banco apenas ficam sem resolução. Tabelas e
sinônimos criados por comandos CREATE TABLE e CREATE SYNONYM nos arquivos analisados são lidos da mesma forma, com
ou sem conexão.
O que o ZPA lê
O ZPA lê o dicionário de dados uma vez por análise, antes de analisar qualquer arquivo, em uma transação somente
leitura. Ele consulta apenas views ALL_*, então o usuário só enxerga os objetos dos quais é dono ou sobre os quais tem
privilégios. Um usuário com acesso de leitura aos schemas analisados basta; ele nunca precisa alterar nada.
Você escolhe o que ler:
- Schemas: todas as tabelas, views, colunas, sinônimos, tipos objeto e assinaturas de subprogramas de cada schema listado.
- Relações: apenas as tabelas e views listadas, como
SCHEMA.RELACAO, para quando ler um schema inteiro é demais. - Sinônimos públicos: lidos por padrão. Sem eles, um nome que poderia ser resolvido por um sinônimo público fica sem resolução.
| Informação | Views do dicionário |
|---|---|
| Tabelas, views e colunas | ALL_ALL_TABLES, ALL_VIEWS, ALL_TAB_COLS |
| Objetos e sinônimos | ALL_OBJECTS, ALL_SYNONYMS |
| Tipos objeto, com os seus supertipos | ALL_TYPES, ALL_TYPE_ATTRS, ALL_TYPE_METHODS, ALL_METHOD_PARAMS, ALL_METHOD_RESULTS |
| Parâmetros e resultados de subprogramas de packages e avulsos | ALL_ARGUMENTS |
O Oracle Database 11.2 e mais recentes são suportados. Cada consulta ao dicionário tem tempo limite de 60 segundos.
Configure a conexão
O ZPA não inclui o driver JDBC da Oracle. Baixe o ojdbc17.jar na
página de downloads JDBC da Oracle, que também
mostra as versões de banco suportadas por cada driver, e indique-o ao ZPA. A senha
nunca é escrita na configuração: o ZPA a lê de uma variável de ambiente, ZPA_ORACLE_PASSWORD por padrão, e rejeita uma
URL que contenha credenciais.
- Plugin para SonarQube
- ZPA CLI
Defina a conexão como parâmetros de análise, no sonar-project.properties ou com -D na linha de comando do scanner.
Eles não são configurações do servidor, então não aparecem nas páginas de administração do SonarQube.
sonar.zpa.oracle.url=jdbc:oracle:thin:@//db.example.com:1521/ORCLPDB1
sonar.zpa.oracle.user=ZPA_READER
sonar.zpa.oracle.schemas=HR,SALES
sonar.zpa.oracle.driverPath=drivers/ojdbc17.jar
export ZPA_ORACLE_PASSWORD=...
sonar-scanner
| Parâmetro | Descrição | Padrão |
|---|---|---|
sonar.zpa.oracle.url | URL JDBC do banco. Ativa a leitura dos metadados. | |
sonar.zpa.oracle.user | Usuário do banco. | |
sonar.zpa.oracle.passwordEnv | Nome da variável de ambiente que contém a senha. | ZPA_ORACLE_PASSWORD |
sonar.zpa.oracle.schemas | Schemas a ler por completo, separados por vírgula. | |
sonar.zpa.oracle.relations | Tabelas e views SCHEMA.RELACAO a ler individualmente, separadas por vírgula. | |
sonar.zpa.oracle.publicSynonyms | Lê todos os sinônimos públicos: true ou false. | true |
sonar.zpa.oracle.driverPath | Caminho do JAR do driver JDBC, relativo ao diretório base do projeto. |
Copie o ojdbc17.jar para a pasta drivers da distribuição do ZPA CLI e passe as opções de conexão:
export ZPA_ORACLE_PASSWORD=...
zpa-cli --sources src \
--oracle-url jdbc:oracle:thin:@//db.example.com:1521/ORCLPDB1 \
--oracle-user ZPA_READER \
--oracle-schemas HR,SALES
| Opção | Descrição | Padrão |
|---|---|---|
--oracle-url | URL JDBC do banco. Ativa a leitura dos metadados. | |
--oracle-user | Usuário do banco. | |
--oracle-password-env | Nome da variável de ambiente que contém a senha. | ZPA_ORACLE_PASSWORD |
--oracle-schemas | Schemas a ler por completo, separados por vírgula. | |
--oracle-relations | Tabelas e views SCHEMA.RELACAO a ler individualmente, separadas por vírgula. | |
--oracle-public-synonyms | Lê todos os sinônimos públicos: true ou false. | true |
As opções de conexão não podem ser combinadas com --syntax-only.
A URL exige o usuário e pelo menos um schema ou relação. Sem a URL, nada se conecta, e informar qualquer outro parâmetro de conexão é um erro.
Os nomes de schemas e relações, aqui e no schema de compilação, são lidos como o Oracle lê
identificadores: HR e hr nomeiam o schema HR; escreva entre aspas duplas um nome guardado em minúsculas ("hr").
Um erro de configuração, a falta do driver, uma falha de conexão ou uma consulta ao dicionário que falha interrompem a análise; o ZPA nunca continua com metadados parciais. As mensagens de erro e os logs nunca mostram a URL nem a senha. O ZPA CLI termina com código 2 em erros de configuração e 3 em falhas de conexão e de leitura do dicionário.
Schema de compilação
O Oracle resolve um nome não qualificado no schema em que a unidade é compilada. Informe ao ZPA qual é esse schema, para
que um nome como employees encontre HR.EMPLOYEES e para que uma unidade criada sem dono possa ser alcançada por um
nome qualificado com esse schema. Essas configurações também funcionam sem conexão com o banco.
- Plugin para SonarQube
- ZPA CLI
# Schema de todas as unidades criadas sem dono
sonar.zpa.oracle.compilationSchema=HR
# Ou um schema por pasta: pares glob=SCHEMA, relativos ao diretório base do projeto; vale o primeiro que casar
sonar.zpa.schemaPaths=src/hr/**=HR,src/sales/**=SALES
# Schema de todas as unidades criadas sem dono
zpa-cli --sources src --compilation-schema HR
# Ou um schema por pasta: pares glob=SCHEMA, relativos a --sources; vale o primeiro que casar
zpa-cli --sources src --schema-paths "hr/**=HR,sales/**=SALES"
--schema-paths não pode ser combinado com --syntax-only.
Os arquivos que não casam com nenhum padrão usam o schema de compilação.