Detalhes de Conexão do Google Spanner

Introdução

Versão do conector

Esta documentação é baseada na versão 21.0.8383 do conector.

Começando

Suporte à versão do Google Spanner

O Jitterbit Connector for Google Spanner se conecta com a API de serviços da Web do GoogleSpanner.

Estabelecendo uma Conexão

Conectando-se ao Google Spanner

Forneça as seguintes propriedades de conexão antes de adicionar as propriedades de autenticação.

• InstanceId: O ID da instância do Google Spanner à qual você está se conectando.
• Database: O nome do banco de dados do Google Spanner ao qual se conectar.
• ProjectId: o ID do projeto em que sua instância do Google Spanner reside.

Autenticação no Google Spanner

Todas as conexões com o Google Spanner são autenticadas usando OAuth. O conector oferece suporte ao uso de contas de usuário, contas de serviço e contas de instância do GCP para autenticação.

Autenticar com uma Conta de Usuário

AuthScheme deve ser definido como OAuth em todos os fluxos da conta do usuário. Para aplicativos de desktop, o aplicativo padrão do conector é a maneira mais simples de autenticação. O único requisito adicional é definir InitiateOAuth para GETANDREFRESH.

Quando o driver iniciar, ele abrirá um navegador e o Google Spanner solicitará suas informações de login. O conector usará as credenciais que você fornecer para acessar seus dados do Google Spanner. Essas credenciais serão salvas e atualizadas automaticamente conforme necessário.

Consulte Usando autenticação OAuth para obter um guia de autenticação que abrange todos os métodos suportados em detalhes.

Autenticar com uma Conta de Serviço

Para autenticar usando uma conta de serviço, você deve criar uma nova conta de serviço e ter uma cópia do certificado de contas.

Para um arquivo JSON, você precisará definir estas propriedades:

• AuthScheme: Obrigatório. Defina isso como OAuthJWT.
• InitiateOAuth: Obrigatório. Defina isso como GETANDREFRESH.
• OAuthJWTCertType: Obrigatório. Defina isso como GOOGLEJSON.
• OAuthJWTCert: Obrigatório. Defina isso como o caminho para o arquivo .json fornecido pelo Google.
• OAuthJWTSubject: Opcional. Defina esse valor apenas se a conta de serviço fizer parte de um domínio G Suite e você quiser habilitar a delegação. O valor desta propriedade deve ser o endereço e-mail do usuário cujos dados você deseja acessar.

Para um arquivo PFX, você precisará definir estas propriedades:

• AuthScheme: Obrigatório. Defina isso como OAuthJWT.
• InitiateOAuth: Obrigatório. Defina isso como GETANDREFRESH.
• OAuthJWTCertType: Obrigatório. Defina isso como PFXFILE.
• OAuthJWTCert: Obrigatório. Defina isso como o caminho para o arquivo .pfx fornecido pelo Google.
• OAuthJWTCertPassword: Opcional. Defina isso como a senha do arquivo .pfx. Na maioria dos casos, isso precisará ser fornecido, pois o Google criptografa os certificados PFX.
• OAuthJWTCertSubject: Opcional. Defina isso apenas se você estiver usando um OAuthJWTCertType que armazena vários certificados. Não deve ser definido para certificados PFX gerados pelo Google.
• OAuthJWTIssuer: Obrigatório. Defina isso como o endereço e-mail da conta de serviço. Este endereço geralmente incluirá o domínio iam.gserviceaccount.com.
• OAuthJWTSubject: Opcional. Defina esse valor apenas se a conta de serviço fizer parte de um domínio G Suite e você quiser habilitar a delegação. O valor desta propriedade deve ser o endereço e-mail do usuário cujos dados você deseja acessar.

Se você ainda não tiver uma conta de serviço, poderá criar uma seguindo o procedimento em Criando um aplicativo OAuth personalizado.

Autenticar com uma Conta de Instância do GCP

Ao executar em uma máquina virtual GCP, o conector pode autenticar usando uma conta de serviço vinculada à máquina virtual. Para usar este modo, defina AuthScheme para GCPInstanceAccount.

Usando Autenticação OAuth

OAuth requer que o usuário autenticado interaja com o Google Spanner usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.

Credenciais Incorporadas

Consulte Credenciais incorporadas para se conectar com as credenciais incorporadas do conector e pule a criação de um aplicativo OAuth personalizado.

Credenciais Personalizadas

Em vez de se conectar com as credenciais incorporadas do conector, você pode registrar um aplicativo para obter o OAuthClientId e OAuthClientSecret.

Quando Criar um Aplicativo OAuth Personalizado

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Google Spanner e você pode se conectar com suas credenciais incorporadas. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no endpoint OAuth do Google Spanner para conceder permissões ao conector.

Criando um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Usando uma Conta de Serviço para Se Conectar a Dados de Todo o Domínio

Você pode usar uma conta de serviço neste fluxo OAuth para acessar as APIs do Google em nome dos usuários em um domínio. Um administrador de domínio pode delegar acesso em todo o domínio à conta de serviço.

Para concluir o fluxo da conta de serviço, gere uma chave privada no Console de APIs do Google. No fluxo da conta de serviço, o conector troca um JSON Web token (JWT) pelo OAuthAccessToken. O OAuthAccessToken autentica que o conector tem as mesmas permissões concedidas à conta de serviço. A chave privada é necessária para assinar o JWT.

Gerar uma Chave Privada

Siga as etapas abaixo para obter as credenciais para sua inscrição:

1. Faça login no Console de API do Google.
2. Clique em Criar projeto ou selecione um projeto existente.
3. No API Manager, clique em Credenciais -> Criar credenciais -> Chave da conta de serviço. No menu Conta de serviço, selecione Nova conta de serviço ou selecione uma conta de serviço existente. Na seção Tipo de chave, selecione o tipo de chave P12.
4. Clique em Criar para fazer download do par de chaves. A senha da chave privada é exibida: Defina isso em OAuthJWTCertPassword.
5. Na seção Chaves de conta de serviço na página Credenciais, clique em Gerenciar contas de serviço e defina OAuthJWTIssuer para o endereço e-mail exibido no campo Service Account ID.
6. Clique em Biblioteca -> API do Spanner -> Ativar API.

Autenticar com uma Conta de Serviço

Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:

• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar a geração manual do OAuthAccessToken propriedade da conexão e repetição da troca OAuth.
• OAuthJWTCertType: Defina como "PFXFILE".
• OAuthJWTCertPassword: Defina isso como a senha do arquivo .p12.
• OAuthJWTCertSubject: Defina como "*" para escolher o primeiro certificado no armazenamento de certificados.
• OAuthJWTIssuer: Defina isso para o endereço e-mail da conta de serviço.
• OAuthJWTCert: Defina como o caminho para o arquivo .p12.
• OAuthJWTSubject: Defina como o endereço e-mail do usuário para quem o aplicativo está solicitando acesso delegado.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina para o ID do projeto ao qual você deseja se conectar.

Quando você conecta, o conector conclui o fluxo OAuth para uma conta de serviço:

1. Cria e assina o JWT com o conjunto de declarações exigido pelo conector.
2. Troca o JWT pelo token de acesso.
3. Envia o JWT para um novo token de acesso quando o token expira.

Credenciais Incorporadas

Autenticar Usando as Credenciais OAuth Incorporadas

Autenticação de Desktop com o Aplicativo OAuth Integrado

Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário. Depois de definir o seguinte, você está pronto para se conectar:

• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina isso para o ID do projeto ao qual você deseja se conectar.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth.

1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
2. Obtém um novo token de acesso quando o antigo expira.
3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Credenciais Personalizadas

Quando Usar um Aplicativo OAuth Personalizado

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Google Spanner e você pode se conectar com suas credenciais incorporadas.

Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no Google Spanner para conceder permissões ao conector.

Autenticação de Desktop com um Aplicativo OAuth Personalizado

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.

Obtenha e Atualize o Token de Acesso OAuth

Depois de definir o seguinte, você está pronto para se conectar:

• OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina isso para o ID do projeto ao qual você deseja se conectar.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth:

1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
2. Atualiza o token de acesso quando ele expira.
3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Máquinas Sem Cabeça

Usando OAuth em uma Máquina Sem Cabeça

Para criar fontes de dados do Google Spanner em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa se autenticar em outra máquina. A autenticação é um processo de duas etapas.

1. Ao invés de instalar o conector em outra máquina, você pode seguir os passos abaixo para obter o OAuthVerifier valor. Ou você pode instalar o conector em outra máquina e transferir os valores de autenticação OAuth, depois de autenticar por meio do fluxo normal baseado em navegador.
2. Em seguida, você pode configurar o conector para atualizar automaticamente o token de acesso da máquina sem periféricos.

Você pode seguir o fluxo de autenticação OAuth headless usando as credenciais OAuth incorporadas do conector ou usando as credenciais OAuth para seu aplicativo OAuth personalizado.

Usando as Credenciais OAuth Incorporadas

Obtenha um código verificador

Siga as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade da conexão:

1. Clique no link a seguir para abrir o endpoint OAuth do Google Spanner em seu navegador.
2. Efetue login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
3. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth.

• OAuthVerifier: Defina isso para o código do verificador.
• InitiateOAuth: Configure para ATUALIZAR.
• OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina para o ID do projeto ao qual você deseja se conectar.

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

• OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.
• InitiateOAuth: Configure para ATUALIZAR.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina para o ID do projeto ao qual você deseja se conectar.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:

• OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
• InitiateOAuth: Defina como GETANDREFRESH.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina isso para o ID do projeto ao qual você deseja se conectar.

Teste a conexão para autenticar no navegador. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

• InitiateOAuth: Configure para ATUALIZAR.
• OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina para o ID do projeto ao qual você deseja se conectar.

Usando as Credenciais para um Aplicativo OAuth Personalizado

Crie um aplicativo OAuth personalizado

A criação de um aplicativo OAuth customizado é opcional no fluxo OAuth headless; você pode ignorar a criação de um aplicativo conectando-se com as credenciais OAuth incorporadas do conector. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no Google Spanner para conceder permissões ao conector.

Consulte Criando um aplicativo OAuth personalizado para um procedimento. Você pode seguir os procedimentos abaixo para autenticar e conectar-se aos dados.

Obtenha um código verificador

Defina as seguintes propriedades na máquina sem periféricos:

• InitiateOAuth: Defina como DESLIGADO.
• OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina para o ID do projeto ao qual você deseja se conectar.

Você pode seguir as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade de conexão.

1. Chame o GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nas configurações do aplicativo.
2. Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
3. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:

• OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
• OAuthVerifier: Defina isso para o código do verificador.
• OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
• InitiateOAuth: Configure para ATUALIZAR.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina para o ID do projeto ao qual você deseja se conectar.

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

• OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
• OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.
• InitiateOAuth: Configure para ATUALIZAR.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina para o ID do projeto ao qual você deseja se conectar.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:

• OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
• InitiateOAuth: Defina como GETANDREFRESH.
• OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina para o ID do projeto ao qual você deseja se conectar.

Teste a conexão para autenticar. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

• InitiateOAuth: Defina como REFRESH.
• OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
• OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.
• InstanceId: Defina isso como o ID da instância à qual você deseja se conectar.
• Database: Defina com o nome do banco de dados ao qual deseja se conectar.
• ProjectId: Defina para o ID do projeto ao qual você deseja se conectar.

Criando um Aplicativo OAuth Personalizado

Registrando Seu Aplicativo

O fluxo de consentimento do usuário OAuth envolve a interação do usuário autenticado com o Google usando o navegador. Para facilitar isso, o conector já está registrado como um aplicativo OAuth, mas pode ser necessário configurar valores específicos para seu aplicativo ou organização. Você também pode exibir suas próprias informações em vez das do aplicativo quando os usuários fizerem login para conceder permissões.

1. Faça login no Console de API do Google.

2. Clique em Criar projeto ou selecione um projeto existente.

3. Abra o API Manager no menu principal e clique em Credenciais -> Criar credenciais -> ID do cliente OAuth.

4. Se estiver se conectando a partir de um aplicativo de desktop, selecione Outro.

   Se você estiver se conectando a partir de um aplicativo da Web, selecione Aplicativo da Web. Na caixa Authorized Redirect URIs, insira a URL que você deseja que seja usada como uma URL de redirecionamento confiável, onde o usuário retornará com o token que verifica se ele concedeu acesso ao seu aplicativo.

5. Clique em Criar. O OAuthClientId e OAuthClientSecret Estão exibidas.

6. Clique em Biblioteca -> API do Spanner -> Ativar API.

Quando Criar um Aplicativo OAuth Personalizado

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Google Spanner e você pode se conectar com suas credenciais incorporadas.

Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no endpoint OAuth do Google Spanner para conceder permissões ao conector.

Siga as etapas abaixo para criar um aplicativo OAuth personalizado e obter as propriedades de conexão em um fluxo de autenticação OAuth específico.

Crie um Aplicativo OAuth Personalizado: Área de Trabalho

Registre seu aplicativo Google Spanner em https://console.cloud.google.com/apis/credentials para obter as seguintes propriedades de conexão:

• OAuthClientId
• OAuthClientSecret

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector do Google Spanner.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Visualizações Definidas pelo Usuário

O Jitterbit Connector for Google Spanner permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

• Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
• declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

• Cada elemento raiz define o nome de uma exibição.
• Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a visualização.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM [].[GoogleSpanner].Customer WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Exibições Definidas pelo Usuário

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resultando na consultar efetiva à fonte:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL

Personalizando a Configuração SSL

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados

O Jitterbit Connector for Google Spanner modela os dados conforme definido no Google Spanner para o projeto e a instância configurados.

Procedimentos Armazenados

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Conector Jitterbit para Procedimentos Armazenados do Google Spanner

GetOAuthAccessToken

Obtém o token de acesso OAuth para ser usado para autenticação com vários serviços do Google.

Entrada

Colunas do Conjunto de Resultados

GetOAuthAuthorizationURL

Obtém o URL de autorização OAuth usado para autenticação com vários serviços do Google.

Entrada

Colunas do Conjunto de Resultados

RefreshOAuthAccessToken

Obtém o token de acesso OAuth para ser usado para autenticação com vários serviços do Google.

Entrada

Colunas do Conjunto de Resultados

Tabelas do Sistema

Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.

Tabelas de Esquema

As tabelas a seguir retornam metadados de banco de dados para o Google Spanner:

• sys_catalogs: Lista os bancos de dados disponíveis.
• sys_schemas: Lista os esquemas disponíveis.
• sys_tables: Lista as tabelas e exibições disponíveis.
• sys_tablecolumns: Descreve as colunas das tabelas e exibições disponíveis.
• sys_procedures: Descreve os procedimentos armazenados disponíveis.
• sys_procedureparameters: Descreve procedimento armazenado* parâmetros.
• sys_keycolumns: Descreve as chaves primárias e estrangeiras.
• sys_indexes: Descreve os índices disponíveis.

Tabelas de Fonte de Dados

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

• sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
• sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar Tabelas de Informações

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados, incluindo operações em lote:

• sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

Sys_catalogs

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs

Colunas

Sys_schemas

Lista os esquemas disponíveis.

A consultar a seguir recupera todos os esquemas disponíveis:

SELECT * FROM sys_schemas

Colunas

Sys_tables

Lista as tabelas disponíveis.

A consultar a seguir recupera as tabelas e exibições disponíveis:

SELECT * FROM sys_tables

Colunas

Sys_tablecolumns

Descreve as colunas das tabelas e exibições disponíveis.

A consultar a seguir retorna as colunas e os tipos de dados da tabela [].[GoogleSpanner].Customer:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Customer' AND CatalogName='' AND SchemaName='GoogleSpanner'

Colunas

Sys_procedures

Lista os procedimentos armazenados disponíveis.

A consultar a seguir recupera os procedimentos armazenados disponíveis:

SELECT * FROM sys_procedures

Colunas

Sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado SelectEntries:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Colunas

Sys_keycolumns

Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela [].[GoogleSpanner].Customer:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Customer' AND CatalogName='' AND SchemaName='GoogleSpanner'

Colunas

Sys_foreignkeys

Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Colunas

Sys_indexes

Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.

A consultar a seguir recupera todos os índices que não são chaves primárias:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Colunas

Sys_connection_props

Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.

Ao consultar esta tabela, a string de conexão de configuração deve ser usada:

jdbc:cdata:googlespanner:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''

Colunas

Sys_sqlinfo

Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.

Processamento de Consultas Colaborativas

Ao trabalhar com fontes de dados que não suportam SQL-92, você pode consultar a exibição sys_sqlinfo para determinar os recursos de consultar das APIs subjacentes, expressas na sintaxe SQL.

Descobrindo os Recursos SELECT da Fonte de Dados

Abaixo está um exemplo de conjunto de dados de recursos SQL. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.

A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.

Colunas

Sys_identity

Retorna informações sobre tentativas de modificação.

A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:

SELECT * FROM sys_identity

Colunas

Propriedades de Configurações Avançadas

As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.

Autenticação

OAuth

JWT OAuth

SSL

Esquema

Diversos

Autenticação

Esta seção fornece uma lista completa de propriedades de autenticação que você pode configurar.

AuthScheme

O tipo de autenticação a ser usado ao se conectar ao Google Spanner.

Valores Possíveis

Auto, OAuth, OAuthJWT, GCPInstanceAccount

Tipo de Dados

string

Valor Padrão

"Auto"

Observações

• Auto: permite que o driver decida automaticamente com base nas outras propriedades de conexão que você definiu.
• OAuth: Defina para executar a autenticação OAuth usando uma conta de usuário padrão.
• OAuthJWT: defina para executar a autenticação OAuth usando uma conta de serviço OAuth.
• GCPInstanceAccount: defina para obter o token de acesso da instância do Google Cloud Platform.

InstanceId

O ID da instância do Google Spanner à qual você está se conectando.

Tipo de Dados

string

Valor Padrão

""

Observações

O endereço da instância do Google Spanner à qual você está se conectando. Você pode encontrar esse valor na visão geral da instância. As instâncias serão listadas assim que você selecionar Spanner no menu do Console do Google Cloud.

Base de Dados

O nome do banco de dados do Google Spanner ao qual se conectar.

Tipo de Dados

string

Valor Padrão

""

Observações

O nome do banco de dados do Google Spanner ao qual se conectar.

ProjectId

O ID do projeto em que sua instância do Google Spanner reside.

Tipo de Dados

string

Valor Padrão

""

Observações

O ID do projeto em que sua instância do Google Spanner reside. Você pode encontrar esse valor acessando o Google Cloud Console e clicando no nome do projeto na parte superior esquerda da tela. O ProjectId é exibido na coluna ID do projeto correspondente.

UseGrpcEndpoint

Se deve usar o endpoint Grpc ou não.

Tipo de Dados

bool

Valor Padrão

true

Observações

Esta propriedade determina se o endpoint Grpc será usado ou não. A maioria dos proxies não funcionará com o endpoint Grpc. Se definido como falso, o endpoint protobuf será usado. O último tem problemas com valores NULL, mas os proxies funcionarão nele.

OAuth

Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.

InitiateOAuth

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis

OFF, GETANDREFRESH, REFRESH

Tipo de Dados

string

Valor Padrão

"OFF"

Observações

As seguintes opções estão disponíveis:

1. OFF: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.
2. GETANDREFRESH: Indica que todo o fluxo OAuth será tratado pelo conector. Se nenhum token existir atualmente, ele será obtido solicitando ao usuário por meio do navegador. Se existir um token, ele será atualizado quando aplicável.
3. REFRESH: Indica que o conector tratará apenas da atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve manipular a obtenção do OAuthAccessToken e OAuthRefreshToken inicialmente.

OAuthClientId

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, às vezes também chamado de chave do consumidor, e um segredo do cliente, o OAuthClientSecret.

OAuthClientSecret

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId, também chamada de chave do consumidor. Você também receberá um segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente no OAuthClientSecret propriedade.

OAuthAccessToken

O token de acesso para conexão usando OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthAccessToken propriedade é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre as solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais, mantendo-as no servidor.

OAuthVerifier

O código do verificador retornado da URL de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas em que um navegador não pode ser iniciado, como sistemas headless.

Autenticação em Máquinas Sem Cabeça

Consulte para obter o OAuthVerifier valor.

Defina OAuthSettingsLocation juntamente com OAuthVerifier. Quando você conecta, o conector troca o OAuthVerifier para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Definir InitiateOAuth para GETANDREFRESH automatizar a troca.

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.

OAuthRefreshToken

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthRefreshToken a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

JWT OAuth

Esta seção fornece uma lista completa das propriedades JWT OAuth que você pode configurar.

OAuthJWTCert

A loja de certificados JWT.

Tipo de Dados

string

Valor Padrão

""

Observações

O nome do armazenamento de certificados para o certificado do cliente.

O OAuthJWTCertType campo especifica o tipo de armazenamento de certificado especificado por OAuthJWTCert. Se o armazenamento estiver protegido por senha, especifique a senha em OAuthJWTCertPassword.

OAuthJWTCert é usado em conjunto com o OAuthJWTCertSubject para especificar os certificados do cliente. Se OAuthJWTCert tem um valor e OAuthJWTCertSubject for definido, uma pesquisa por um certificado será iniciada. Consulte OAuthJWTCertSubject para obter detalhes.

As designações de armazenamentos de certificados dependem da plataforma.

A seguir estão as designações dos armazenamentos de certificados de Usuário e Máquina mais comuns no Windows:

Em Java, o armazenamento de certificados normalmente é um arquivo contendo certificados e chaves privadas opcionais.

Quando o tipo de armazenamento de certificado for PFXFile, essa propriedade deverá ser configurada para o nome do arquivo. Quando o tipo é PFXBlob, a propriedade deve ser configurada para o conteúdo binário de um arquivo PFX (ou seja, armazenamento de certificados PKCS12).

OAuthJWTCertType

O tipo de armazenamento de chaves que contém o certificado JWT.

Valores Possíveis

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB, GOOGLEJSON, GOOGLEJSONBLOB

Tipo de Dados

string

Valor Padrão

"USER"

Observações

Esta propriedade pode assumir um dos seguintes valores:

OAuthJWTCertPassword

A senha para o certificado OAuth JWT.

Tipo de Dados

string

Valor Padrão

""

Observações

Se o armazenamento de certificados for de um tipo que requer uma senha, essa propriedade será usada para especificar essa senha para abrir o armazenamento de certificados.

Isso não é necessário ao usar o GOOGLEJSON OAuthJWTCertType. As chaves JSON do Google não são criptografadas.

OAuthJWTCertSubject

O assunto do certificado OAuth JWT.

Tipo de Dados

string

Valor Padrão

"\*"

Observações

Ao carregar um certificado, o assunto é usado para localizar o certificado na loja.

Se uma correspondência exata não for encontrada, a loja é pesquisada em busca de assuntos que contenham o valor da propriedade.

Se uma correspondência ainda não for encontrada, a propriedade será definida como uma string vazia e nenhum certificado será selecionado.

O valor especial "*" seleciona o primeiro certificado no armazenamento de certificados.

O assunto do certificado é uma lista separada por vírgulas de campos e valores de nomes distintos. Por exemplo, "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Os campos comuns e seus significados são exibidos abaixo.

Se um valor de campo contiver uma vírgula, ela deverá ser colocada entre aspas.

OAuthJWTIssuer

O emissor do Java Web Token.

Tipo de Dados

string

Valor Padrão

""

Observações

O emissor do Java Web Token. Normalmente, é o ID do cliente ou o endereço E-mail do aplicativo OAuth.

Isso não é necessário ao usar o GOOGLEJSON OAuthJWTCertType. As chaves JSON do Google contêm uma cópia da conta do emissor.

OAuthJWTSubject

O assunto do usuário para o qual o aplicativo está solicitando acesso delegado.

Tipo de Dados

string

Valor Padrão

""

Observações

O assunto do usuário para o qual o aplicativo está solicitando acesso delegado. Normalmente, o nome da conta do usuário ou endereço de e-mail.

SSL

Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.

SSLServerCert

O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Tipo de Dados

string

Valor Padrão

""

Observações

Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.

Esta propriedade pode assumir as seguintes formas:

Se não for especificado, qualquer certificado confiável pela máquina será aceito.

Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.

Esquema

Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.

Localização

Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.

Tipo de Dados

string

Valor Padrão

"%APPDATA%\\\GoogleSpanner Data Provider\\Schema"

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

Se não for especificado, o local padrão é "%APPDATA%\\GoogleSpanner Data Provider\Schema" com %APPDATA% sendo definido para o diretório de configuração do usuário:

Esquemas Navegáveis

Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações

Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Esquema

O esquema que será usado por padrão.

Tipo de Dados

string

Valor Padrão

""

Observações

O esquema que será usado por padrão.

Diversos

Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.

MaxRows

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de Dados

int

Valor Padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de Dados

string

Valor Padrão

""

Observações

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Os casos de uso e a funcionalidade normais do driver não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Integração e Formatação

Pseudocolunas

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de Dados

string

Valor Padrão

""

Observações

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

QueryPassthrough

Essa opção passa a consultar para o servidor do Google Spanner como está.

Tipo de Dados

bool

Valor Padrão

false

Observações

Quando isso é definido, as consultas são passadas diretamente para o Google Spanner.

Tempo Esgotado

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de Dados

int

Valor Padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

Se Timeout expira e a operação ainda não está concluída, o conector lança uma exceção.