Detalhes da Conexão do Microsoft Excel
Introdução
Versão do conector
Esta documentação é baseada na versão 21.0.8257 do conector.
Começando
Suporte à versão do Excel
O conector oferece suporte às planilhas Office Open XML usadas pelo Excel 2007 e posterior.
Visualizando Metadados Remotos do Excel
O Jitterbit Connector for Excel foi projetado apenas para streaming do Excel.
Esse conteúdo de arquivo transmitido não inclui todos os metadados associados a arquivos do Excel armazenados remotamente, como nome de arquivo e pasta.
Se for necessário acessar os metadados do arquivo e o conteúdo real do arquivo, o Jitterbit Connector for Excel deve ser usado em conjunto com o(s) driver(s) do sistema de arquivos associado(s) para o serviço em que os arquivos do Excel são armazenados remotamente.
Os seguintes drivers de sistema de arquivos estão disponíveis:
- AmazonS3
- Box
- Dropbox
- FTP
- GoogleCloudStorage
- IBLCloudObjectStorage
- OneDrive
- SFTP
Consulte a documentação do driver do sistema de arquivos relevante para obter um guia de configuração para conectar-se a metadados de arquivo do Excel armazenados.
Estabelecendo uma Conexão
Conectando-se a Fontes de Dados do Excel
O Jitterbit Connector for Excel permite conectar-se a recursos locais e remotos do Excel. Colocou o URI
para o local do recurso do Excel, além de quaisquer outras propriedades necessárias para se conectar à sua fonte de dados.
Prestador de Serviços | Formatos URI | InitiateOAuth | OAuthClientId | OAuthClientSecret | OAuthAccessToken | OAuthAccessTokenSecret | Usuário | Senha | Esquema de Autenticação | AzureStorageAccount | AzureAccessKey | AWSAccessKey | AWSSecretKey | Região da AWS | AccessKey | Chave Secreta | Região | OracleNamespace | ProjectId |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Local | Caminho de arquivo único (uma tabela) file://localPath/file.xlsx Caminho do diretório (uma tabela por arquivo) file://localPath | ||||||||||||||||||
HTTP ou HTTPS | http://remoteStream https://remoteStream | OPCIONAL | OPCIONAL | OPCIONAL | |||||||||||||||
Amazon S3 | Caminho de arquivo único (uma tabela) s3://remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) s3://remotePath | NECESSÁRIO (seu AccessKey) | NECESSÁRIO (seu SecretKey) | OPCIONAL | |||||||||||||||
Armazenamento de Blobs do Azure | azureblob://mycontainer/myblob/ | OBRIGATÓRIO | OPCIONAL | OPCIONAL | OPCIONAL | NECESSÁRIO (para OAuth) | OBRIGATÓRIO | NECESSÁRIO (seu AccessKey) | |||||||||||
Azure Data Lake Store Gen1 | adl://remotePath adl://Account.azuredatalakestore.net@remotePath | OBRIGATÓRIO | OPCIONAL | OPCIONAL | OPCIONAL | OBRIGATÓRIO | OBRIGATÓRIO | ||||||||||||
Azure Data Lake Store Gen2 | abfs://myfilesystem/remotePath | OBRIGATÓRIO | NECESSÁRIO (seu AccessKey) | ||||||||||||||||
Azure Data Lake Store Gen2 com SSL | abfss://myfilesystem/remotePath | OBRIGATÓRIO | OPCIONAL | OPCIONAL | OPCIONAL | NECESSÁRIO (para OAuth) | OBRIGATÓRIO | NECESSÁRIO (seu AccessKey) | |||||||||||
Google Drive | Caminho de arquivo único (uma tabela) gdrive://remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) gdrive://remotePath | OBRIGATÓRIO | OPCIONAL | OPCIONAL | OPCIONAL | OPCIONAL | OBRIGATÓRIO | ||||||||||||
OneDrive | Caminho de arquivo único (uma tabela) onedrive://remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) onedrive://remotePath | OBRIGATÓRIO | OPCIONAL | OPCIONAL | OPCIONAL | OPCIONAL | OBRIGATÓRIO | ||||||||||||
Box | Caminho de arquivo único (uma tabela) box://remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) box://remotePath | OBRIGATÓRIO | OPCIONAL | OPCIONAL | OPCIONAL | OPCIONAL | OBRIGATÓRIO | ||||||||||||
caixa de depósito | Caminho de arquivo único (uma tabela) dropbox://remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) dropbox://remotePath | OBRIGATÓRIO | OPCIONAL | OPCIONAL | OPCIONAL | OPCIONAL | OBRIGATÓRIO | ||||||||||||
SOAP do SharePoint Online | Caminho de arquivo único (uma tabela) sp://remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) sp://remotePath | OBRIGATÓRIO | OBRIGATÓRIO | ||||||||||||||||
SharePoint Online REST | Caminho de arquivo único (uma tabela) sprest://remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) sprest://remotePath | OBRIGATÓRIO | OPCIONAL | OPCIONAL | OPCIONAL | OBRIGATÓRIO | |||||||||||||
FTP ou FTPS | Caminho de arquivo único (uma tabela) ftp://server:port/remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) ftp://server:port/remotePath | OBRIGATÓRIO | OBRIGATÓRIO | ||||||||||||||||
SFTP | Caminho de arquivo único (uma tabela) sftp://server:port/remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) sftp://server:port/remotePath | OPCIONAL | OPCIONAL | ||||||||||||||||
Wasabi | Caminho de arquivo único (uma tabela) wasabi://bucket1/remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) wasabi://bucket1/remotePath | NECESSÁRIO (seu AccessKey) | NECESSÁRIO (seu SecretKey) | OPCIONAL | |||||||||||||||
Google Cloud Storage | Caminho de arquivo único (uma tabela) gs://bucket/remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) gs://bucket/remotePath | OBRIGATÓRIO | OPCIONAL | OPCIONAL | OPCIONAL | OPCIONAL | OBRIGATÓRIO | OBRIGATÓRIO | |||||||||||
Armazenamento em Nuvem Oracle | Caminho de arquivo único (uma tabela) os://bucket/remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) os://bucket/remotePath | NECESSÁRIO (seu AccessKey) | NECESSÁRIO (seu SecretKey) | OPCIONAL | OBRIGATÓRIO | ||||||||||||||
Arquivo Azure | Caminho de arquivo único (uma tabela) azurefile://fileShare/remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) azurefile://fileShare/remotePath | OBRIGATÓRIO | OPCIONAL | ||||||||||||||||
Fonte de armazenamento de objetos IBM | Caminho de arquivo único (uma tabela) ibmobjectstorage://bucket1/remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) ibmobjectstorage://bucket1/remotePath | OBRIGATÓRIO | OPCIONAL | OBRIGATÓRIO | NECESSÁRIO (seu AccessKey) | NECESSÁRIO (seu SecretKey) | OBRIGATÓRIO | ||||||||||||
Sistema de Arquivos Distribuídos Hadoop | Caminho de arquivo único (uma tabela) webhdfs://host:port/remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) webhdfs://host:port/remotePath | ||||||||||||||||||
Sistema de Arquivos Distribuídos Hadoop Seguro | Caminho de arquivo único (uma tabela) webhdfss://host:port/remotePath/file.xlsx Caminho do diretório (uma tabela por arquivo) webhdfss://host:port/remotePath |
Conectando-se a Arquivos em Nuvem
Embora o conector seja capaz de extrair dados de arquivos do Excel hospedados em vários armazenamentos de dados na nuvem, INSERT, UPDATE e DELETE are not supported
fora dos arquivos locais neste conector.
Se você precisar de arquivos de nuvem INSERT/UPDATE/DELETE, você pode baixar o conector correspondente para esse hospedar de nuvem (suportado por procedimentos armazenados), fazer alterações com o conector correspondente do arquivo local e, em seguida, carregar o arquivo usando os procedimentos armazenados da fonte de nuvem.
Por exemplo, se você quiser atualizar um arquivo CSV armazenado no SharePoint, poderá usar o procedimento DownloadDocument do conector do SharePoint para baixar o arquivo CSV, atualizar o arquivo CSV local com o conector CSV e usar o procedimento UploadDocument do conector do SharePoint para carregar o arquivo alterado para SharePoint.
Conectando a uma Pasta de Trabalho
O URI
, na seção Conexão, deve ser definido como um arquivo Excel válido (incluindo o caminho do arquivo). O conector suporta o formato Office Open XML usado pelo Excel 2007 e posterior.
Consultando uma Pasta de Trabalho
Você pode então executar instruções SELECT, INSERT, UPDATE e DELETE para planilhas e intervalos na pasta de trabalho. Consulte Operações do Excel para obter detalhes sobre como consultar dados de planilhas como tabelas.
Conectando-se ao Amazon S3
Colocou o URI
para um arquivo do Excel em um balde. Além disso, defina as seguintes propriedades para autenticação:
AWSAccessKey
: Defina como uma chave de acesso do Amazon Web Services (um nome de usuário).AWSSecretKey
: Defina como uma chave secreta do Amazon Web Services.
Por exemplo:
URI=s3://bucket1/folder1/file.xlsx; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegion=OHIO;
Opcionalmente, especifique AWSRegion
além disso.
Nota: Também é possível conectar-se a serviços compatíveis com S3 especificando sua base StorageBaseURL
. Por exemplo, se StorageBaseURL
conn prp é definido como http://s3.%region%.myservice.com
e Region
é região-1, então vamos gerar URLs de solicitação como https://s3.region-1.myservice.com/bucket/..
. (ou como https://bucket.s3.region-1.myservice.com/...
, se o UseVirtualHosting
a propriedade é verdadeira).
Conectando-se ao Oracle Cloud Object Storage
Colocou o URI
para um arquivo do Excel em um balde. Além disso, defina as seguintes propriedades para autenticação:
AccessKey
: Defina isso como uma chave de acesso à nuvem Oracle.SecretKey
: Defina isso como uma chave secreta da nuvem Oracle.OracleNamespace
: Defina isso para um namespace de nuvem Oracle.
Por exemplo:
URI=os://bucket/remotePath/; AccessKey=token1; SecretKey=secret1; OracleNamespace=myNamespace; Region=us-ashburn-1;
Opcionalmente, especifique Region
além disso.
Conectando-se ao Wasabi
Colocou o URI
para um arquivo do Excel em um balde. Além disso, defina as seguintes propriedades para autenticação:
AccessKey
: Defina isso como uma chave de acesso Wasabi (um nome de usuário)SecretKey
: Defina como uma chave secreta Wasabi.
Opcionalmente, especifique Region
além disso.
Por exemplo:
URI=wasabi://bucket1/folder1/file.xlsx; AccessKey=token1; SecretKey=secret1; Region=OHIO;
Conectar-se ao Armazenamento de Blobs do Azure
Colocou o URI
ao nome do seu contêiner e ao nome do blob. Além disso, defina as seguintes propriedades para autenticação:
AzureStorageAccount
: Defina isso para a conta associada ao blob do Azure.AzureAccessKey
: Defina isso como a chave de acesso associada ao blob do Azure.
Por exemplo:
URI=azureblob://mycontainer/myblob/; AzureStorageAccount=myAccount; AzureAccessKey=myKey;
Você também pode usar a autenticação OAuth para se conectar ao Armazenamento de Blobs do Azure. Por exemplo:
URI=azureblob://mycontainer/myblob/; AzureStorageAccount=myAccount; AuthScheme=AzureAD; InitiateOAuth=GETANDREFRESH;
Se você estiver se conectando de uma VM do Azure com permissões para armazenamento de Blob do Azure, basta usar o AzureMSI AuthScheme
Por exemplo:
URI=azureblob://mycontainer/myblob/; AzureStorageAccount=myAccount; AuthScheme=AzureMSI;
Se você deseja autenticar com uma entidade de serviço em vez de um segredo do cliente, também é possível autenticar com um certificado de cliente.
InitiateOAuth
: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente oOAuthAccessToken
.AzureTenant
: Defina isso para o inquilino ao qual você deseja se conectar.OAuthGrantType
: Defina como CLIENTE.OAuthClientId
: Defina isso como o ID do cliente nas configurações do aplicativo.OAuthJWTCert
: Defina isso para o armazenamento de certificados JWT.OAuthJWTCertType
: Defina isso para o tipo de armazenamento de certificado especificado porOAuthJWTCert
.
Por exemplo:
AuthScheme=AzureServicePrincipal;InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;;AzureTenant=MyAzureTenant;OAuthJWTCert=MyOAuthJWTCert;OAuthJWTCertType=PFXFile
Conectar-se ao Azure Data Lake Store Gen 2
Colocou o URI
ao nome do sistema de arquivos, o nome da pasta que contata seus arquivos Excel e o nome de um arquivo Excel. Além disso, defina as seguintes propriedades para autenticação:
AzureStorageAccount
: Defina isso para a conta associada ao armazenamento do data lake do Azure.AzureAccessKey
: Defina isso como a chave de acesso associada ao armazenamento do data lake do Azure.
Por exemplo:
URI=abfs://myfilesystem/folder1/file.xlsx; AzureStorageAccount=myAccount; AzureAccessKey=myKey;
URI=abfss://myfilesystem/folder1/file.xlsx; AzureStorageAccount=myAccount; AzureAccessKey=myKey;
Você também pode usar a autenticação OAuth para se conectar com o Azure Data Lake Store Gen 2. Por exemplo:
URI=abfss://myfilesystem/folder1; AzureStorageAccount=myAccount; AuthScheme=AzureAD; InitiateOAuth=GETANDREFRESH;
Se você estiver se conectando de uma VM do Azure com permissões para se conectar ao Azure Data Lake Store Gen 2, basta definir AuthScheme como AzureMSI. Por exemplo:
URI=abfss://myfilesystem/folder1; AzureStorageAccount=myAccount; AuthScheme=AzureMSI;
Se você deseja autenticar com uma entidade de serviço em vez de um segredo do cliente, também é possível autenticar com um certificado de cliente.
InitiateOAuth
: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente oOAuthAccessToken
.AzureTenant
: Defina isso para o inquilino ao qual você deseja se conectar.OAuthGrantType
: Defina como CLIENTE.OAuthClientId
: Defina isso como o ID do cliente nas configurações do aplicativo.OAuthJWTCert
: Defina isso para o armazenamento de certificados JWT.OAuthJWTCertType
: Defina isso para o tipo de armazenamento de certificado especificado porOAuthJWTCert
.
Por exemplo:
AuthScheme=AzureServicePrincipal;InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;;AzureTenant=MyAzureTenant;OAuthJWTCert=MyOAuthJWTCert;OAuthJWTCertType=PFXFile
Conectar-se ao Armazenamento de Arquivos do Azure
Colocou o URI
ao nome do seu compartilhamento de arquivos do Azure e ao nome do recurso. Além disso, defina as seguintes propriedades para autenticação:
AzureStorageAccount
(obrigatório): defina isso para a conta associada ao arquivo do Azure.AzureAccessKey
: Defina isso para a chave de acesso associada ao arquivo Azure.AzureSharedAccessSignature
: Defina isso para a assinatura de acesso compartilhado associada ao arquivo Azure.
Por exemplo:
URI=azurefile://fileShare/remotePath/file.xlsx; AzureStorageAccount=myAccount; AzureAccessKey=myAccessKey;
URI=azurefile://fileShare/remotePath/file.xlsx; AzureStorageAccount=myAccount; AzureSharedAccessSignature=mySharedSignature;
Conectando à Box
Colocou o URI
ao caminho para um arquivo do Excel. Para autenticar no Box, use o padrão de autenticação OAuth. Consulte Conectando à Box para obter um guia de autenticação.
Por exemplo:
URI=box://folder1/file.xlsx; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;
Conectando ao Dropbox
Colocou o URI
ao caminho para um arquivo do Excel. Para autenticar no Dropbox, use o padrão de autenticação OAuth. Consulte Conectando-se ao Dropbox para obter um guia de autenticação. Você pode autenticar com uma conta de usuário ou uma conta de serviço. No fluxo da conta do usuário, você não precisa definir nenhuma propriedade de conexão para suas credenciais de usuário, conforme mostrado na string de conexão abaixo:
URI=dropbox://folder1/file.xlsx; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;
Conectando ao Google Drive
Colocou o URI
ao caminho para o nome do sistema de arquivos, o nome da pasta que contata seus arquivos Excel e o nome de um arquivo Excel. Para acessar arquivos compartilhados, defina SharedWithMe como o nome da pasta que contém seus arquivos do Excel. Por exemplo URI=gdrive://SharedWithMe/remotePath
. Para autenticar nas APIs do Google, use o padrão de autenticação OAuth.
Você pode autorizar o conector a se conectar às APIs do Google em nome de usuários individuais ou em nome de um domínio. Consulte Conectando-se ao Google Drive para um guia.
Por exemplo:
URI=gdrive://folder1/file.xlsx;InitiateOAuth=GETANDREFRESH;
Conectando-se à Origem do IBM Object Storage
Colocou o URI
para um arquivo do Excel em um balde. Além disso, defina as seguintes propriedades para autenticação:
AccessKey
: Defina isso como uma chave de acesso IBM (um nome de usuário).SecretKey
: Defina isso como uma chave secreta IBM.
Por exemplo:
URI=ibmobjectstorage://bucket1/folder1; AccessKey=token1; SecretKey=secret1; Region=eu-gb;
Opcionalmente, especifique Region
além disso.
Também é possível autenticar em sua instância do IBM Object Storage usando OAuth AuthScheme
:
AuthScheme
: Defina como OAuth.ApiKey
: Defina isso para sua chave de API IBM.Region
: Configure esta propriedade para sua região de instância IBM.
Por exemplo:
URI=ibmobjectstorage://bucket1/folder1; ApiKey=key1; Region=eu-gb; AuthScheme=OAuth; InitiateOAuth=GETANDREFRESH;
Conectando ao HDFS
Existem dois métodos de autenticação disponíveis para conexão com a fonte de dados HDFS, Autenticação Anônima e Autenticação por Negociação (Kerberos).
Autenticação Anônima
Em algumas situações, você pode se conectar ao HDFS sem nenhuma propriedade de conexão de autenticação. Para isso, defina o AuthScheme
propriedade para None (padrão).
Autenticar usando Kerberos
Quando as credenciais de autenticação são necessárias, você pode usar o Kerberos para autenticação. Consulte Usando Kerberos para obter detalhes sobre como autenticar com Kerberos.
Conectando-se ao SOAP do SharePoint Online
Colocou o URI
para uma biblioteca de documentos contendo arquivos Excel. Para autenticar, defina User
e Password
e StorageBaseURL
.
Por exemplo:
URI=sp://Documents/folder1; User=user1; Password=password1; StorageBaseURL=https://subdomain.sharepoint.com;
Observe que este método de conexão pode não funcionar se o StorageBaseURL
termina com "-my.sharepoint.com". Você deve usar o onedrive://
esquema ao conectar-se a esses sites porque eles não suportam os componentes do SharePoint que o conector precisa para baixar arquivos.
Conectando-se ao REST do SharePoint Online
Colocou o URI
para uma biblioteca de documentos contendo arquivos Excel. StorageBaseURL
é opcional. Se não for fornecido, o driver funcionará com a unidade raiz. Para autenticar, use o padrão de autenticação OAuth.
Por exemplo:
URI=sp://Documents/folder1; InitiateOAuth=GETANDREFRESH; StorageBaseURL=https://subdomain.sharepoint.com;
Observe que este método de conexão pode não funcionar se o StorageBaseURL
termina com "-my.sharepoint.com". Você deve usar o onedrive://
esquema ao conectar-se a esses sites porque eles não suportam os componentes do SharePoint que o conector precisa para baixar arquivos.
Conectando ao FTP
Colocou o URI
para o endereço do servidor seguido do caminho para o arquivo Excel. Para autenticar, defina User
e Password
.
Por exemplo:
URI=ftps://localhost:990/folder1/file.xlsx; User=user1; Password=password1;
Conectando-se ao Google Cloud Storage
Colocou o URI
ao caminho para o nome do sistema de arquivos, o nome da pasta que contém seus arquivos Excel e o nome de um arquivo Excel. Para autenticar nas APIs do Google, forneça um ProjectId
.
Por exemplo:
URI=gs://bucket/remotePath/; ProjectId=PROJECT_ID;
Conectando ao Google Drive
O conector facilita os seguintes fluxos de autenticação OAuth:
- O fluxo de consentimento do usuário permite que usuários individuais se conectem aos seus próprios dados.
- O fluxo da conta de serviço permite o acesso a dados de todo o domínio.
Usando uma Conta de Usuário para Se Conectar ao Google
Esse fluxo OAuth requer que o usuário autenticado interaja com o Google usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.
Autenticar no Google
Depois de definir InitiateOAuth
para GETANDREFRESH, você está pronto para se conectar. Você pode usar InitiateOAuth
para evitar repetir a troca OAuth e definir manualmente o OAuthAccessToken
propriedade de conexão. 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:
- Extrai o token de acesso da URL de retorno de chamada e autentica as solicitações.
- Atualiza o token de acesso quando ele expira.
- Salva os valores OAuth para serem mantidos nas conexões. Este arquivo pode ser configurado em
OAuthSettingsLocation
.
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
. A chave privada é necessária para assinar o JWT. O OAuthAccessToken
autentica que o conector tem as mesmas permissões concedidas à conta de serviço.
Gerar uma Chave Privada
Siga as etapas abaixo para gerar uma chave privada e obter as credenciais para seu aplicativo:
- Faça login no Console de API do Google.
- Clique em Criar projeto ou selecione um projeto existente.
- 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.
- Clique em Criar para fazer download do par de chaves. A senha da chave privada é exibida: Defina isso em
OAuthJWTCertPassword
. - 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 ID da conta de serviço. - Clique em Biblioteca -> API do Google Drive -> Ativar API.
- Se estiver usando a delegação em todo o domínio, você precisará adicionar os seguintes escopos ao ID do cliente da conta de serviço no Google Admin Console. No Admin Console, vá para Segurança -> Controles de API -> Delegação em todo o domínio -> Gerencie a delegação em todo o domínio. Adicione o ID da conta de serviço e insira os seguintes escopos:
https://www.googleapis.com/auth/drive
,https://www.googleapis.com/auth/devstorage.read_write
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 usarInitiateOAuth
para evitar repetir a troca OAuth e definir manualmente oOAuthAccessToken
propriedade de conexão.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.
Quando você conecta, o conector conclui o fluxo OAuth para uma conta de serviço:
- Cria e assina o JWT com o conjunto de declarações exigido pelo conector.
- Troca o JWT pelo token de acesso.
- Envia o JWT para um novo token de acesso quando o token expira.
Conectando à Box
Use o padrão de autenticação OAuth para se conectar ao Excel. Você pode se conectar com sua conta de usuário ou pode usar uma conta de serviço. O conector facilita esses fluxos OAuth conforme descrito abaixo.
Autenticar com uma Conta de Usuário
O fluxo da conta do usuário exige que o usuário autenticado interaja com o Excel por meio do navegador.
Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário. Depois de definir InitiateOAuth
para GETANDREFRESH, você está pronto para se conectar. Quando você se 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.
- Extrai o token de acesso da URL de retorno de chamada e autentica as solicitações.
- Obtém um novo token de acesso quando o antigo expira.
- Salva valores OAuth em
OAuthSettingsLocation
para ser persistido nas conexões.
Observação: o conector já está registrado no Excel como um aplicativo OAuth e usará automaticamente suas credenciais OAuth incorporadas para se conectar.
Autenticar com uma Conta de Serviço
As contas de serviço têm autenticação silenciosa, sem autenticação do usuário no navegador. Você precisa criar um aplicativo OAuth neste fluxo. Você pode se conectar aos dados do Excel que a conta de serviço tem permissão para acessar.
Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:
InitiateOAuth
: Defina como GETANDREFRESH.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.OAuthJWTCertType
: Defina isso como "PEMKEY_FILE".OAuthJWTCert
: Defina isso como o caminho para o arquivo .pem que você gerou.OAuthJWTCertPassword
: Defina isso como a senha do arquivo .pem.OAuthJWTCertSubject
: Defina como "*" para escolher o primeiro certificado no armazenamento de certificados.OAuthJWTSubjectType
: Defina como "corporativo" ou "usuário" dependendo do tipo de token que deseja solicitar. Você também precisa definir o valor de Acesso ao aplicativo nas configurações do aplicativo para o tipo de assunto correspondente. O valor padrão dessa propriedade de conexão é "enterprise".OAuthJWTSubject
: Defina isso para sua ID corporativa se seu tipo de entidade estiver definido como "corporativo" ou sua ID de usuário do aplicativo se seu tipo de entidade estiver definido como "usuário".OAuthJWTPublicKeyId
: Defina isso como o ID da sua chave pública nas configurações do aplicativo.
Quando você conecta, o conector conclui o fluxo OAuth para uma conta de serviço.
- Cria e assina o JWT com o conjunto de declarações exigido pelo conector.
- Troca o JWT pelo token de acesso.
- Salva valores OAuth em
OAuthSettingsLocation
para ser persistido nas conexões. - Envia o JWT para um novo token de acesso quando o token expira.
Conectando ao Dropbox
OAuth requer que o usuário autenticado interaja com o Excel usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.
Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário. Depois de definir InitiateOAuth
para GETANDREFRESH, você está pronto para se conectar. Quando você se 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.
- Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
- Obtém um novo token de acesso quando o antigo expira.
- Salva valores OAuth em
OAuthSettingsLocation
para ser persistido nas conexões.
Observação: o conector já está registrado no Excel como um aplicativo OAuth e usará automaticamente suas credenciais OAuth incorporadas para se conectar. Se você quiser usar seu próprio aplicativo OAuth personalizado, consulte Criando um aplicativo OAuth personalizado.
Conexões SSO
Autenticação com SSO
Prestador de Serviços | Okta | OneLogin | ADFS | AzureAD |
---|---|---|---|---|
Amazon S3 | Y | Y | Y | |
Armazenamento de Blobs do Azure | ||||
Azure Data Lake Store Gen1 | ||||
Azure Data Lake Store Gen2 | ||||
Azure Data Lake Store Gen2 com SSL | ||||
Google Drive | ||||
OneDrive | ||||
Box | ||||
caixa de depósito | ||||
SOAP do SharePoint Online | Y | Y | Y | |
SharePoint Online REST | ||||
Wasabi | ||||
Google Cloud Storage | ||||
Armazenamento em Nuvem Oracle | ||||
Arquivo Azure |
Azure AD
Configuração do Azure AD
O tema principal por trás dessa configuração é o fluxo OAuth 2.0 On-Behalf-Of. Requer dois aplicativos do Azure AD:
- Um aplicativo usado para o processo de logon único para um provedor de serviços específico.
-
Amazon S3:
Siga este link para obter instruções detalhadas sobre como criar este aplicativo. Certifique-se de testar a conexão e conseguir fazer login no console da AWS a partir do Azure AD.Salve a etapa "Atribuir o usuário de teste do Azure AD" até o provisionamento para poder selecionar as funções da AWS ao atribuir o usuário. 2. Um aplicativo "conector" com permissão user_impersonation no aplicativo SSO criado na etapa anterior. Vá para Azure Active Directory --> Registros de aplicativos e registrar um novo aplicativo. Depois de registrar este aplicativo, você precisa permitir que ele faça chamadas de API para o aplicativo SSO. Vá para a seção de permissões de API do aplicativo que você registrou e clique na caixa "Adicionar uma permissão". Selecione a API do seu aplicativo SSO especificando o nome da API ou ID do aplicativo e adicione a permissão user_impersonation.
-
Propriedades Comuns do Driver
A seguir SSOProperties
são necessários para autenticação no Azure Active Directory e devem ser especificados para cada provedor de serviços.
- Recurso: o URI do ID do aplicativo SSO, listado na seção Visão geral do registro do aplicativo.
- Locatário: a ID do locatário do Azure AD em que os aplicativos estão registrados. Você pode encontrar esse valor usando as instruções encontradas aqui.
Recuperamos a resposta SSO SAML de um fluxo OAuth 2.0 On-Behalf-Of, portanto, as seguintes propriedades de conexão OAuth devem ser especificadas:
OAuthClientId
: O ID do aplicativo do conector, listado na seção Visão geral do registro do aplicativo.OAuthClientSecret
: O valor do segredo do cliente do aplicativo conector. O Azure AD exibe isso quando você cria um novo segredo do cliente (seção Certificados e segredos).
Amazon S3
Além das propriedades comuns, as seguintes propriedades devem ser especificadas ao se conectar ao provedor de serviços Amazon S3:
AuthScheme
: Colocou oAuthScheme
para Microsoft Entra ID.AWSRoleARN
: O ARN da papel IAM. Encontre-o na página Resumo da papel IAM.AWSPrincipalARN
: O ARN do provedor de identidade. Encontre-o na página de resumo do provedor de identidade.
Veja a seguir um exemplo de string de conexão:
AuthScheme=AzureAD;InitiateOAuth=GETANDREFRESH;OAuthClientId=d593a1d-ad89-4457-872d-8d7443aaa655;OauthClientSecret=g9-oy5D_rl9YEKfN-45~3Wm8FgVa2F;SSOProperties='Tenant=94be7-edb4-4fda-ab12-95bfc22b232f;Resource=https://signin.aws.amazon.com/saml;';AWSRoleARN=arn:aws:iam:2153385180:role/AWS_AzureAD;AWSPrincipalARN=arn:aws:iam:215515180:saml-provider/AzureAD;
OneLogin
Configuração OneLogin
Você deve criar um aplicativo usado para o processo de logon único para um provedor específico.
Sharepoint SOAP:
Siga este link para obter instruções detalhadas sobre como criar este aplicativo. Certifique-se de testar a conexão e conseguir fazer login no Office 365 a partir do OneLogin.Make sure you have enabled WS-TRUST in your application otherwise the driver will not be able to connect.
SOAP Sharepoint
As seguintes propriedades devem ser especificadas ao se conectar ao provedor de serviços Sharepoint SOAP:
AuthScheme
: Colocou oAuthScheme
para OneLogin.User
: O nome de usuário da conta OneLogin.Password
: A senha da conta OneLogin.SSOProperties
:- Domínio (opcional): Pode ser necessário definir se o domínio configurado no domínio SSO for diferente do domínio do
User
.
- Domínio (opcional): Pode ser necessário definir se o domínio configurado no domínio SSO for diferente do domínio do
Veja a seguir um exemplo de string de conexão:
AuthScheme='OneLogin';User=test;Password=test;SSOProperties='Domain=test.cdata;';
Okta
Configuração Okta
Você deve criar um aplicativo usado para o processo de logon único para um provedor específico.
Sharepoint SOAP:
Siga este link para obter instruções detalhadas sobre como criar este aplicativo e configurar SSO. Certifique-se de testar a conexão e conseguir fazer login no Office 365 a partir do Okta.Make sure you have configured SSO using WS-Federation in your application otherwise the driver will not be able to connect.
Amazon S3:
Siga este link para obter instruções detalhadas sobre como criar este aplicativo e configurar SSO. Certifique-se de testar a conexão e conseguir fazer login na AWS a partir do Okta.Make sure you have configured SSO with SAML 2.0 in your application otherwise the driver will not be able to connect.
Certifique-se de que a papel AWS atribuída no aplicativo OKTA tenha acesso ao bucket S3 que você deseja conectar.
SOAP Sharepoint
As seguintes propriedades devem ser especificadas ao se conectar ao provedor de serviços Sharepoint SOAP:
AuthScheme
: Colocou oAuthScheme
para Okta.User
: O nome de usuário da conta Okta.Password
: A senha da conta Okta.SSOProperties
:- Domínio (opcional): Pode ser necessário definir se o domínio configurado no domínio SSO for diferente do domínio do
User
.
- Domínio (opcional): Pode ser necessário definir se o domínio configurado no domínio SSO for diferente do domínio do
Veja a seguir um exemplo de string de conexão:
AuthScheme='Okta';User=test;Password=test;SSOProperties='Domain=test.cdata;';
Amazon S3
As seguintes propriedades devem ser especificadas ao se conectar ao provedor de serviços Amazon S3:
AuthScheme
: Colocou oAuthScheme
para Okta.User
: O nome de usuário da conta Okta.Password
: A senha da conta Okta.SSOLoginURL
: Defina isso para o URL incorporado de seu aplicativo AWS OKTA SSO.AWSRoleARN
(opcional): o ARN da papel IAM. Encontre-o na página Resumo da papel IAM.AWSPrincipalARN
(opcional): O ARN do provedor de identidade. Encontre-o na página de resumo do provedor de identidade.SSOProperties
:- APIToken (opcional): Defina como o API Token que o cliente criou a partir da organização Okta. Ele deve ser usado ao autenticar um usuário por meio de um aplicativo ou proxy confiável que substitui o contexto de solicitação do cliente OKTA.
Veja a seguir um exemplo de string de conexão:
AuthScheme=Okta;User=OktaUser;Password=OktaPassword;SSOLoginURL='https://{subdomain}.okta.com/home/amazon_aws/0oan2hZLgQiy5d6/272';
ADFS
Configuração ADFS
Você deve criar um aplicativo usado para o processo de logon único para um provedor específico.
Sharepoint SOAP:
Siga este link para obter instruções detalhadas sobre como configurar o ADFS para Office 365 para Single Sign-On. Certifique-se de testar a conexão e conseguir fazer login no Office 365 a partir do ADFS.Amazon S3:
Siga este link para obter instruções detalhadas sobre como configurar o ADFS para AWS Single Sign-On. Certifique-se de testar a conexão e conseguir fazer login na AWS a partir do ADFS.
SOAP Sharepoint
As seguintes propriedades devem ser especificadas ao se conectar ao provedor de serviços SOAP do Sharepoint:
AuthScheme
: Colocou oAuthScheme
para ADFS.User
: O nome de usuário da conta ADFS.Password
: A senha da conta ADFS.SSOProperties
:- Domínio (opcional): Pode ser necessário definir se o domínio configurado no domínio SSO for diferente do domínio do
User
.
- Domínio (opcional): Pode ser necessário definir se o domínio configurado no domínio SSO for diferente do domínio do
Veja a seguir um exemplo de string de conexão:
AuthScheme='ADFS';User=test;Password=test;SSOProperties='Domain=test.cdata;';
Amazon S3
As seguintes propriedades devem ser especificadas ao se conectar ao provedor de serviços SOAP do Sharepoint:
AuthScheme
: Colocou oAuthScheme
para ADFS.SSOLoginURL
: Defina isso para a URL da sua instância do ADFS.User
: O nome de usuário da conta ADFS.Password
: A senha da conta ADFS.AWSRoleARN
(opcional): o ARN da papel IAM. Encontre-o na página Resumo da papel IAM.AWSPrincipalARN
(opcional): O ARN do provedor de identidade. Encontre-o na página de resumo do provedor de identidade.
Veja a seguir um exemplo de string de conexão:
AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';
ADFS integrado
O fluxo integrado do ADFS indica que você está se conectando com o currently logged in Windows user credentials
. Para usar o fluxo integrado do ADFS, simplesmente não especifique o User
e Password
, mas siga as mesmas etapas no guia ADFS acima.
Acesso a Dados de Ajuste Fino
Configurações Avançadas de Modelagem de Dados
Use as propriedades a seguir para controlar as tabelas que o conector descobre, valores de retorno e outros aspectos do acesso a dados.
Descoberta de Esquema
-
Orientation
: Tabelas de modelo que correspondam à orientação de sua planilha: Defina como Horizontal ou Vertical. -
DefineTables
: Especifique explicitamente os intervalos que deseja acessar como tabelas, usando o formato de intervalo padrão do Excel : [Nome da tabela]=[Nome da planilha]![Intervalo]. Especifique várias tabelas em uma lista separada por ponto e vírgula:DefineTables="Table1=Sheet1!A1:N25,Table2=Sheet2!C3:M53"
Observe que o conector detecta automaticamente os intervalos nomeados em uma planilha e os relata como tabelas. Você também pode especificar um intervalo na cláusula FROM:
SELECT * FROM Excel_Sheet#A5:F*
Descoberta de Coluna
Header
: Detecta os nomes das colunas da primeira linha, se verdadeiro. Caso contrário, serão usados os nomes das pseudocolunas A, B, C, etc.TypeDetectionScheme
: Determina como o conector detecta os tipos de dados das colunas.RowScanDepth
: Ao usar o esquema de detecção de tipo de varredura de linha, defina esta propriedade para o número de linhas a serem varridas para determinar os tipos de dados da coluna.
Integração Avançada do Excel
Fórmulas
AllowFormula
: Se deseja inserir ou atualizar o resultado da fórmula ou a expressão da fórmula.Recalculate
: Recalcula as fórmulas quando os dados são alterados.IgnoreCalcError
: Ignora erros que ocorreram quando as fórmulas são calculadas.HasCrossSheetReferences
: Recalcula fórmulas em todas as planilhas quando os dados são alterados; o conector seguirá referências de folha cruzada, mas há um custo de desempenho.
Diversos
EmptyValueMode
: Configure como lidar com as células que estão vazias. Uma célula vazia é uma célula que contém uma string vazia (por exemplo, =""). Você pode retornar uma célula vazia como uma string vazia ou uma string nula (padrão: retornar uma string vazia).NullValueMode
: Configure como tratar as células que não foram configuradas. Uma célula não definida é diferente de uma célula vazia. As células não definidas contêm uma string nula. Você pode retornar uma célula não definida como uma string vazia ou nula (padrão: return NULL).BufferChanges
: Indica se as alterações nos dados devem ser mantidas na memória até que a conexão seja encerrada.
Usando Kerberos
Esta seção mostra como usar o conector para autenticar no Excel usando Kerberos.
Autenticação com Kerberos
Para autenticar no Excel usando Kerberos, defina as seguintes propriedades:
AuthScheme
: Defina paraNEGOTIATE
.KerberosKDC
: Defina isso comohost name or IP Address
de sua máquina Kerberos KDC.KerberosRealm
: Defina parathe realm of the Excel Kerberos principal
. Este será o valor após o símbolo '@' (por exemplo, EXAMPLE.COM) doprincipal value
(por exemplo, ServiceName/MyHost@EXAMPLE.COM).KerberosSPN
: Defina isso comoservice and host of the Excel Kerberos Principal
. Este será o valor anterior ao símbolo '@' (por exemplo, ServiceName/MyHost) doprincipal value
(por exemplo, ServiceName/MyHost@EXAMPLE.COM).
Recupere o Tíquete Kerberos
Você pode usar uma das opções a seguir para recuperar o tíquete Kerberos necessário.
Arquivo de Cache de Credenciais do MIT Kerberos
Esta opção permite que você use o MIT Kerberos Ticket Manager ou o comando kinit para obter tickets. Observe que você não precisa definir o User
ou Password
propriedades de conexão com esta opção.
- Certifique-se de ter criado uma variável de ambiente chamada
KRB5CCNAME
. - Defina o
KRB5CCNAME
variável de ambiente para um caminho apontando para o seucredential cache file
(por exemplo, C:\krb_cache\krb5cc_0 ou /tmp/krb5cc_0). Este arquivo será criado ao gerar seu ticket com o MIT Kerberos Ticket Manager. - Para obter um ticket, abra o aplicativo MIT Kerberos Ticket Manager, clique em
Get Ticket, enter your principal name and password, then click OK
. Se for bem-sucedido, as informações do tíquete aparecerão no Kerberos Ticket Manager e agora serão armazenadas no arquivo de cache de credenciais. - Agora que o arquivo de cache de credencial foi criado, o conector usará o arquivo de cache para obter o tíquete Kerberos para se conectar ao Excel.
Como alternativa para definir o KRB5CCNAME
variável de ambiente, você pode definir diretamente o caminho do arquivo usando KerberosTicketCache
propriedade. Quando definido, o conector usará o arquivo de cache especificado para obter o tíquete Kerberos para conectar-se ao Excel.
Arquivo Keytab
Se a variável de ambiente KRB5CCNAME
não foi definida, você pode recuperar um tíquete Kerberos usando um Keytab File
. Para fazer isso, defina o User
propriedade para o nome de usuário desejado e defina o KerberosKeytabFile
para um caminho de arquivo apontando para o arquivo keytab associado ao usuário.
Usuário e Senha
Se a variável de ambiente KRB5CCNAME
e a propriedade KerberosKeytabFile
não tiverem sido definidas, você pode recuperar um ticket usando um User and Password combination
. Para fazer isso, defina o User
e Password
propriedades para a combinação de usuário/senha que você usa para autenticar com o Excel.
Autenticação Cross-Realm
Ambientes Kerberos mais complexos podem exigir autenticação cross-realm em que vários realms e servidores KDC são usados (por exemplo, onde um realm/KDC é usado para autenticação do usuário e outro realm/KDC usado para obter o tíquete de serviço).
Em tal ambiente, o KerberosRealm
e KerberosKDC
as propriedades podem ser definidas com os valores necessários para autenticação do usuário. O KerberosServiceRealm
e KerberosServiceKDC
as propriedades podem ser definidas com os valores necessários para obter o ticket de serviço.
Anotações Importantes
Procedimentos Armazenados
- Os recursos de procedimentos armazenados descritos nesta documentação não são suportados no momento.
- Como os procedimentos armazenados não são suportados atualmente, qualquer recurso dependente de procedimentos armazenados também não é suportado atualmente.
Arquivos de Configuração e Seus Caminhos
- Todas as referências para adicionar arquivos de configuração e seus caminhos referem-se a arquivos e locais no Harmony Agente onde o conector está instalado. Esses caminhos devem ser ajustados conforme apropriado, dependendo do agente e do sistema operacional. Se vários agentes forem usados em um grupo de agentes, arquivos idênticos serão necessários em cada agente.
Operações do Excel
O Jitterbit Connector for Excel permite que você manipule arquivos do Excel de várias maneiras. O conector oferece suporte à leitura de dados vertical e horizontal, bem como de intervalos definidos pelo usuário e intervalos nomeados. Consulte Selecionar dados e Modificando dados para obter exemplos de diferentes formas de consultar e modificar dados de planilhas.
Selecionando Dados
As planilhas do Excel podem ser organizadas de diferentes maneiras. O conector oferece configurações para selecionar dados com base em vários métodos organizacionais.
Com Células de Cabeçalho
Se uma planilha tiver cabeçalhos de coluna, o conector poderá usá-los para representar os nomes das colunas da tabela da planilha. Para usar células de cabeçalho, defina o Header
propriedade para True. Então você pode consultar assim:
SELECT RowId, Name, Item, Quantity, Amount FROM Sheet1 WHERE Amount > '50'
A consultar acima assume que a primeira linha da planilha tem os nomes de coluna RowId, Name, Quantity e Amount. A planilha pode ter mais colunas do que as selecionadas e elas podem estar em qualquer ordem.
Sem Células de Cabeçalho
Se uma planilha não tiver colunas de cabeçalho ou se você quiser ignorar as colunas de cabeçalho, defina o Header
propriedade para false. Neste caso, cada coluna é representada pelo nome da coluna no Excel; ou seja, A, B, C, ...
SELECT A, B, C, D FROM Sheet1 WHERE D > '50'
Orientação
Se uma planilha for disposta horizontalmente (ou seja, os nomes das colunas são organizados verticalmente na primeira coluna), então você pode definir o Orientation
propriedade para Horizontal para ler cada coluna como uma linha na tabela. O Orientation
imóvel pode ser usado em conjunto com o Header
propriedade de conexão e a sintaxe de intervalo descrita abaixo.
Se as colunas de cabeçalho não forem definidas e a orientação for horizontal, os nomes das colunas serão R1, R2, R3, ...
SELECT R1, R2, R3 FROM Sheet1 WHERE R2 > '50'
Faixa
Você pode usar o recurso de intervalo para selecionar dados de uma parte específica da planilha; por exemplo, se você tiver uma planilha esparsa que não esteja alinhada no canto superior esquerdo ou se os dados de interesse estiverem em algum lugar no meio da planilha. O intervalo é especificado como parte do nome da tabela. Por exemplo, o seguinte comando selecionará o intervalo de células entre A1 e E5:
SELECT * FROM Excel_Sheet#A1:E5
Caso o nome da planilha contenha aspas, se você quiser selecionar apenas um intervalo, a sintaxe correta do Excel envolve usar uma aspa extra como caractere de escape e colocar o nome completo da planilha entre aspas. Por exemplo, o comando a seguir selecionará o intervalo de células entre A1 e E5 para a planilha denominada Excel'Planilha:
SELECT * FROM ['Excel''Sheet'#A1:E5]
Você também pode usar curingas (*
) na célula final do intervalo. Intervalos semelhantes a '#A5:F*'
, '#A5:*20'
, e '#A5:**'
são suportados. Por exemplo, o comando a seguir selecionará o intervalo de células entre A5 e a coluna F, até a última linha da planilha:
SELECT * FROM Excel_Sheet#A5:F*
Intervalo Nomeado
Se uma planilha tiver um intervalo nomeado definido nela, você poderá consultar esse intervalo como se fosse uma tabela. Você pode emitir a seguinte consultar para selecionar dados do intervalo nomeado SALES.
SELECT * FROM SALES
Modificando Dados
O Conector Jitterbit para Excel suporta INSERT, UPDATE e DELETE; mais detalhes estão abaixo.
Atualizar e Excluir
Atualizações e exclusões exigem que você identifique exclusivamente uma única linha especificando a coluna RowId.
Veja Usando Fórmulas para inserir fórmulas.
Inserir
Você pode inserir novas linhas em qualquer lugar da planilha, inclusive inserir em intervalos nomeados.
Adicionar uma Linha
Você pode adicionar novas linhas à sua planilha usando a instrução INSERT. Se o Header
estiver definida como True, então você pode inserir com base nos cabeçalhos das colunas. Se o Header
for false, então você deve usar os nomes das células (A, B, C, etc.) para inserir uma linha. Quando você insere uma linha, ela é anexada ao final da folha. Essa nova linha receberá um RowId com base em sua localização na planilha do Excel.
Também é possível inserir uma linha no final de um intervalo de células. Para fazer isso, basta usar o intervalo no nome da tabela ao inserir uma linha.
INSERT INTO Sheet1#C1:D5 (A, B) VALUES ('Brian', '30')
O código acima adicionará Brian e 30 ao final do intervalo; ou seja, as células C6 e D6.
Inserir uma Linha
Às vezes, você pode querer inserir uma linha no meio de uma planilha do Excel. O conector suporta isso usando o comando INSERT com o RowId, que identifica o número da linha. Se RowId for especificado com a consultar INSERT, o conector adicionará a linha no número de linha especificado. Todas as linhas em e abaixo do número de linha especificado serão movidas uma linha para baixo e seu RowId será incrementado em um. Por exemplo:
INSERT INTO Sheet1 (RowId, A, B) VALUES (5, 'Brian', '30')
O código acima irá inserir os valores Brian e 30 nas células A5 e B5. Os dados existentes na linha 5 e abaixo serão movidos uma linha para baixo.
Adicionar uma Linha a um Intervalo Nomeado
Também é possível inserir uma linha no final do intervalo nomeado. Para isso, basta inserir uma linha sem o RowId na tabela com o nome do intervalo. O código abaixo anexará uma nova linha ao final do intervalo nomeado SALES. A definição do intervalo nomeado será expandida para incluir a linha que acabou de ser inserida.
INSERT INTO SALES (Year, Category, Total) VALUES (1997, 'Beverage', 30000)
Usando Fórmulas
As fórmulas do Excel são recalculadas quando a planilha é aberta. O conector inclui um mecanismo de fórmula que pode calcular nativamente a maioria das fórmulas do Excel comumente usadas. O conector armazena o estado de um cálculo anterior na planilha e o utiliza para fazer escolhas eficientes de quando o recálculo é necessário.
Recalculando Fórmulas
O Recalculate
propriedade permite que você controle se as fórmulas devem ser calculadas. Você deve definir Recalculate
para True quando você pretende ler dados de uma planilha que contém fórmulas e sabe que os resultados da fórmula podem não estar atualizados. Depois que um valor é calculado para uma célula, ele também é atualizado na planilha. Isso pode ajudar a evitar recálculos.
O cálculo de células de fórmula pode aumentar o tempo de processamento. Se uma planilha não foi modificada desde o último recálculo, você pode optar por omitir o cálculo e simplesmente ler o valor calculado anteriormente na célula da fórmula. Para pular o recálculo, defina Recalculate
para Falso. Você também pode omitir o cálculo da fórmula ao abrir uma planilha apenas para inserir ou atualizar células e não ler nada dela.
Inserindo Fórmulas
O conector permite inserir fórmulas nas células. Se o AllowFormula
propriedade da cadeia de conexão for definida como verdadeira, então qualquer coisa que você inserir começando com um sinal de igual ('=') será tratado como uma fórmula. Por exemplo, o seguinte irá inserir uma fórmula na coluna B que irá somar as células B1:B5:
INSERT INTO Excel_Sheet (A, B) VALUES ('Bill', '=SUM(B1:B5)')
Características Avançadas
Esta seção detalha uma seleção de recursos avançados do conector do Excel.
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 Excel 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 visualização.
- Cada elemento raiz contém um elemento filho, chamado
query
, que contém a consultar SQL personalizada para a exibição.
Por exemplo:
{
"MyView": {
"query": "SELECT * FROM Sheet 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.
Certificados SSL do Cliente
O conector do Excel também oferece suporte à configuração de certificados de cliente. Defina o seguinte para se conectar usando um certificado de cliente.
SSLClientCert
: O nome do armazenamento de certificados para o certificado do cliente.SSLClientCertType
: O tipo de armazenamento de chaves que contém o certificado de cliente TLS/SSL.SSLClientCertPassword
: A senha para o certificado do cliente TLS/SSL.SSLClientCertSubject
: O assunto do certificado de cliente TLS/SSL.
Modelo de Dados
O Jitterbit Connector for Excel modela pastas de trabalho do Excel como bancos de dados relacionais. Planilhas e intervalos compõem as tabelas.
Executando SQL para Planilhas
Operações do Excel mostra várias maneiras de trabalhar com dados de planilhas.
Modelagem de dados avançada
Você pode ajustar o modelo de dados para corresponder à organização de sua pasta de trabalho. O conector oferece suporte à leitura de dados orientados vertical ou horizontalmente, bem como planilhas esparsas organizadas em intervalos definidos pelo usuário e intervalos nomeados.
Consulte Ajuste fino de acesso a dados para configurar a string de conexão para controlar as tabelas que o conector descobre, valores de retorno e outros aspectos do acesso a dados.
Procedimentos armazenados
NOTE:
Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.
Além de trabalhar com os dados da planilha, você pode usar os procedimentos armazenados* para alterar os metadados de um arquivo do Excel.
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 Excel
Nome | Descrição |
---|---|
CreateWorksheet | Cria uma nova planilha em uma pasta de trabalho do Excel. Se a pasta de trabalho não existir, a pasta de trabalho também será criada. |
GetOAuthAccessToken | Obtém o token de acesso OAuth a ser usado para autenticação com fontes de armazenamento usando OAuth. |
GetOAuthAuthorizationURL | Obtém a URL de autorização OAuth usada para autenticação com fontes de armazenamento usando OAuth. |
RefreshOAuthAccessToken | Troca um token de atualização por um novo token de acesso. |
Criar Planilha
Cria uma nova planilha em uma pasta de trabalho do Excel. Se a pasta de trabalho não existir, a pasta de trabalho também será criada.
Entrada
Nome | Tipo | Descrição |
---|---|---|
File | String | O caminho para a pasta de trabalho do Excel. |
Sheet | String | O nome da planilha do Excel a ser criada dentro da pasta de trabalho. O valor padrão é planilha1. |
Columnnames | String | Lista separada por vírgulas de nomes de coluna para adicionar à nova planilha. Os nomes das colunas não podem conter espaços em branco. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
File | String | O nome da pasta de trabalho do Excel que foi atualizada. |
Sheet | String | O nome da planilha do Excel criada dentro da pasta de trabalho. Pode ser diferente da planilha especificada se o nome entrar em conflito com uma planilha existente. |
GetOAuthAccessToken
Obtém o token de acesso OAuth a ser usado para autenticação com fontes de armazenamento usando OAuth.
Entrada
Nome | Tipo | Descrição |
---|---|---|
Other_Options | String | Outras opções para controlar o comportamento do OAuth. |
Cert | String | Caminho para um arquivo .pfx de certificado pessoal. Disponível apenas para OAuth 1.0. |
Cert_Password | String | Senha do certificado pessoal. Disponível apenas para OAuth 1.0. |
AuthToken | String | O token de solicitação retornado por GetOAuthAuthorizationUrl. Disponível apenas para OAuth 1.0. |
AuthKey | String | A chave secreta da solicitação retornada por GetOAuthAuthorizationUrl. Disponível apenas para OAuth 1.0. |
AuthSecret | String | Este campo está obsoleto. Por favor, use AuthKey daqui para frente. |
Sign_Method | String | O método de assinatura usado para calcular a assinatura para OAuth 1.0. Os valores permitidos são HMAC-SHA1, PLAINTEXT. O valor padrão é HMAC-SHA1. |
GrantType | String | Tipo de concessão de autorização. Disponível apenas para OAuth 2.0. Os valores permitidos são CODE, PASSWORD, CLIENT, REFRESH. O valor padrão é CODE. |
Post_Data | String | Os dados da postagem a serem enviados, se houver. |
AuthMode | String | O tipo de modo de autenticação a ser usado. Os valores permitidos são APP, WEB. O valor padrão é WEB. |
Verifier | String | O código do verificador retornado pela fonte de dados depois que a permissão para o aplicativo se conectar foi concedida. WEB AuthMode apenas. |
Scope | String | O escopo de acesso às APIs. Por padrão, o acesso a todas as APIs usadas por esse provedor de dados será especificado. |
CallbackURL | String | Este campo determina para onde a resposta é enviada. |
Prompt | String | Este campo indica o prompt para apresentar ao usuário. Ele aceita um dos seguintes valores: NONE, CONSENT, SELECT ACCOUNT. O padrão é SELECT_ACCOUNT, portanto, um determinado usuário será solicitado a selecionar a conta à qual se conectar. Se estiver definido como CONSENT, o usuário verá uma página de consentimento todas as vezes, mesmo que já tenha dado consentimento ao aplicativo para um determinado conjunto de escopos. Por fim, se for definido como NONE, nenhuma tela de autenticação ou consentimento será exibida ao usuário. O valor padrão é SELECT_ACCOUNT. |
AccessType | String | Este campo indica se seu aplicativo precisa acessar uma API do Google quando o usuário não está presente no navegador. O padrão deste parâmetro é ONLINE. Se seu aplicativo precisar atualizar os tokens de acesso quando o usuário não estiver presente no navegador, use OFFLINE. Isso fará com que seu aplicativo obtenha um token de atualização na primeira vez que seu aplicativo trocar um código de autorização para um usuário. |
State | String | Este campo indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta ao servidor de autorização do Google. Os usos incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
OAuthAccessToken | String | O token de autenticação retornado do Google. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico. |
OAuthAccessTokenSecret | String | O segredo do token de acesso OAuth. |
OAuthRefreshToken | String | Um token que pode ser usado para obter um novo token de acesso. |
ExpiresIn | String | O tempo de vida restante no token de acesso. |
\* | String | Outras saídas que podem ser retornadas pela fonte de dados. |
GetOAuthAuthorizationURL
Obtém a URL de autorização OAuth usada para autenticação com fontes de armazenamento usando OAuth.
Entrada
Nome | Tipo | Descrição |
---|---|---|
Cert | String | Caminho para um arquivo .pfx de certificado pessoal. Disponível apenas para OAuth 1.0. |
Cert_Password | String | Senha do certificado pessoal. Disponível apenas para OAuth 1.0. |
Sign_Method | String | O método de assinatura usado para calcular a assinatura para OAuth 1.0. Os valores permitidos são HMAC-SHA1, PLAINTEXT. O valor padrão é HMAC-SHA1. |
Scope | String | O escopo de acesso às APIs. Por padrão, o acesso a todas as APIs usadas por esse provedor de dados será especificado. |
CallbackURL | String | A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. |
Prompt | String | Este campo indica o prompt para apresentar ao usuário. Ele aceita um dos seguintes valores: NONE, CONSENT, SELECT ACCOUNT. O padrão é SELECT_ACCOUNT, portanto, um determinado usuário será solicitado a selecionar a conta à qual se conectar. Se estiver definido como CONSENT, o usuário verá uma página de consentimento todas as vezes, mesmo que já tenha dado consentimento ao aplicativo para um determinado conjunto de escopos. Por fim, se for definido como NONE, nenhuma tela de autenticação ou consentimento será exibida ao usuário. O valor padrão é SELECT_ACCOUNT. |
AccessType | String | Este campo indica se seu aplicativo precisa acessar uma API do Google quando o usuário não está presente no navegador. O padrão deste parâmetro é ONLINE. Se seu aplicativo precisar atualizar tokens de acesso quando o usuário não estiver presente no navegador, use OFFLINE. Isso fará com que seu aplicativo obtenha um token de atualização na primeira vez que seu aplicativo trocar um código de autorização para um usuário. |
State | String | Este campo indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta ao servidor de autorização do Google. Os usos possíveis incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites. |
Other_Options | String | Outras opções para controlar o comportamento do OAuth. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
AuthToken | String | O token de autorização, passado para o procedimento armazenado GetOAuthAccessToken. |
AuthSecret | String | Este campo está obsoleto. Por favor, use AuthKey daqui para frente. |
URL | String | A URL para concluir a autenticação do usuário. |
RefreshOAuthAccessToken
Troca um token de atualização por um novo token de acesso.
Entrada
Nome | Tipo | Descrição |
---|---|---|
OAuthRefreshToken | String | O token de atualização retornado da troca do código de autorização original. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
OAuthAccessToken | String | O token de autenticação retornado da fonte de dados. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico. |
OAuthRefreshToken | String | O token de autenticação retornado da fonte de dados. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico. |
ExpiresIn | String | O tempo de vida restante no token de acesso. |
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 Excel:
- 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:
- 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
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados. |
Sys_schemas
Lista os esquemas disponíveis.
A consultar a seguir recupera todos os esquemas disponíveis:
SELECT * FROM sys_schemas
Colunas
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados. |
SchemaName | String | O nome do esquema. |
Sys_tables
Lista as tabelas disponíveis.
A consultar a seguir recupera as tabelas e exibições disponíveis:
SELECT * FROM sys_tables
Colunas
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O banco de dados que contém a tabela ou exibição. |
SchemaName | String | O esquema que contém a tabela ou exibição. |
TableName | String | O nome da tabela ou exibição. |
TableType | String | O tipo de tabela (tabela ou exibição). |
Description | String | Uma descrição da tabela ou visualização. |
IsUpdateable | Boolean | Se a tabela pode ser atualizada. |
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 Sheet:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Sheet'
Colunas
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados que contém a tabela ou exibição. |
SchemaName | String | O esquema que contém a tabela ou exibição. |
TableName | String | O nome da tabela ou exibição que contém a coluna. |
ColumnName | String | O nome da coluna. |
DataTypeName | String | O nome do tipo de dados. |
DataType | Int32 | Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente. |
Length | Int32 | O tamanho de armazenamento da coluna. |
DisplaySize | Int32 | A largura máxima normal da coluna designada em caracteres. |
NumericPrecision | Int32 | O número máximo de dígitos em dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora. |
NumericScale | Int32 | A escala da coluna ou o número de dígitos à direita do ponto decimal. |
IsNullable | Boolean | Se a coluna pode conter null. |
Description | String | Uma breve descrição da coluna. |
Ordinal | Int32 | O número de sequência da coluna. |
IsAutoIncrement | String | Se o valor da coluna é atribuído em incrementos fixos. |
IsGeneratedColumn | String | Se a coluna é gerada. |
IsHidden | Boolean | Se a coluna está oculta. |
IsArray | Boolean | Se a coluna é uma matriz. |
Sys_procedures
Lista os procedimentos armazenados disponíveis.
A consultar a seguir recupera os procedimentos armazenados disponíveis:
SELECT * FROM sys_procedures
Colunas
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O banco de dados que contém o procedimento armazenado. |
SchemaName | String | O esquema que contém o procedimento armazenado. |
ProcedureName | String | O nome do procedimento armazenado. |
Description | String | Uma descrição do procedimento armazenado. |
ProcedureType | String | O tipo do procedimento, como PROCEDURE ou FUNCTION. |
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 CreateWorksheet:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateWorksheet' AND Direction=1 OR Direction=2
Colunas
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados que contém o procedimento armazenado. |
SchemaName | String | O nome do esquema que contém o procedimento armazenado. |
ProcedureName | String | O nome do procedimento armazenado* contendo o parâmetro. |
ColumnName | String | O nome do procedimento armazenado* parâmetro. |
Direction | Int32 | Um número inteiro correspondente ao tipo do parâmetro: entrada (1), entrada/saída (2) ou saída (4). parâmetros de tipo de entrada/saída podem ser parâmetros de entrada e saída. |
DataTypeName | String | O nome do tipo de dados. |
DataType | Int32 | Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente. |
Length | Int32 | O número de caracteres permitido para dados de caractere. O número de dígitos permitidos para dados numéricos. |
NumericPrecision | Int32 | A precisão máxima para dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora. |
NumericScale | Int32 | O número de dígitos à direita do ponto decimal em dados numéricos. |
IsNullable | Boolean | Se o parâmetro pode conter null. |
IsRequired | Boolean | Se o parâmetro é necessário para a execução do procedimento. |
IsArray | Boolean | Se o parâmetro é uma matriz. |
Description | String | A descrição do parâmetro. |
Ordinal | Int32 | O índice do parâmetro. |
Sys_keycolumns
Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela Sheet:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Sheet'
Colunas
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados que contém a chave. |
SchemaName | String | O nome do esquema que contém a chave. |
TableName | String | O nome da tabela que contém a chave. |
ColumnName | String | O nome da coluna chave. |
IsKey | Boolean | Se a coluna é uma chave primária na tabela referenciada no campo TableName. |
IsForeignKey | Boolean | Se a coluna é uma chave estrangeira referenciada no campo TableName. |
PrimaryKeyName | String | O nome da chave primária. |
ForeignKeyName | String | O nome da chave estrangeira. |
ReferencedCatalogName | String | O banco de dados que contém a chave primária. |
ReferencedSchemaName | String | O esquema que contém a chave primária. |
ReferencedTableName | String | A tabela que contém a chave primária. |
ReferencedColumnName | String | O nome da coluna da chave primária. |
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
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados que contém a chave. |
SchemaName | String | O nome do esquema que contém a chave. |
TableName | String | O nome da tabela que contém a chave. |
ColumnName | String | O nome da coluna chave. |
PrimaryKeyName | String | O nome da chave primária. |
ForeignKeyName | String | O nome da chave estrangeira. |
ReferencedCatalogName | String | O banco de dados que contém a chave primária. |
ReferencedSchemaName | String | O esquema que contém a chave primária. |
ReferencedTableName | String | A tabela que contém a chave primária. |
ReferencedColumnName | String | O nome da coluna da chave primária. |
ForeignKeyType | String | Designa se a chave estrangeira é uma chave de importação (aponta para outras tabelas) ou de exportação (referenciada de outras tabelas). |
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
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados que contém o índice. |
SchemaName | String | O nome do esquema que contém o índice. |
TableName | String | O nome da tabela que contém o índice. |
IndexName | String | O nome do índice. |
ColumnName | String | O nome da coluna associada ao índice. |
IsUnique | Boolean | True se o índice for exclusivo. Falso caso contrário. |
IsPrimary | Boolean | Verdadeiro se o índice for uma chave primária. Falso caso contrário. |
Type | Int16 | Um valor inteiro correspondente ao tipo de índice: estatística (0), clusterizado (1), hash (2) ou outro (3). |
SortOrder | String | A ordem de classificação: A para crescente ou D para decrescente. |
OrdinalPosition | Int16 | O número de sequência da coluna no índice. |
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:excel: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
Nome | Tipo | Descrição |
---|---|---|
Name | String | O nome da propriedade de conexão. |
ShortDescription | String | Uma breve descrição. |
Type | String | O tipo de dados da propriedade de conexão. |
Default | String | O valor padrão, se não houver um definido explicitamente. |
Values | String | Uma lista separada por vírgulas de valores possíveis. Um erro de validação é lançado se outro valor for especificado. |
Value | String | O valor que você definiu ou um padrão pré-configurado. |
Required | Boolean | Se a propriedade é necessária para se conectar. |
Category | String | A categoria da propriedade de conexão. |
IsSessionProperty | String | Se a propriedade é uma propriedade de sessão, usada para salvar informações sobre a conexão atual. |
Sensitivity | String | O nível de sensibilidade da propriedade. Isso informa se a propriedade está ofuscada nos formulários de registro e autenticação. |
PropertyName | String | Uma forma truncada em camel case do nome da propriedade de conexão. |
Ordinal | Int32 | O índice do parâmetro. |
CatOrdinal | Int32 | O índice da categoria do parâmetro. |
Hierarchy | String | Mostra as propriedades dependentes associadas que precisam ser definidas juntamente com esta. |
Visible | Boolean | Informa se a propriedade está visível na UI da conexão. |
ETC | String | Diversas informações diversas sobre o imóvel. |
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. O conector transfere o máximo possível do processamento da instrução SELECT para o servidor e, em seguida, processa o restante da consultar na memória.
Descobrindo os Recursos SELECT da Fonte de Dados
Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. 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.
Nome | Descrição | Valores Possíveis |
---|---|---|
AGGREGATE_FUNCTIONS | Funções de agregação suportadas. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Se a função COUNT é suportada. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | O caractere de abertura usado para escapar de um identificador. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | O caractere de fechamento usado para escapar de um identificador. | ] |
SUPPORTED_OPERATORS | Uma lista de operadores SQL com suporte. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Se GROUP BY é compatível e, em caso afirmativo, o grau de suporte. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Funções de string suportadas. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Funções numéricas suportadas. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Funções de data/hora suportadas. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indica tabelas ignoradas durante a replicação. | |
REPLICATION_TIMECHECK_COLUMNS | Uma matriz de string contendo uma lista de colunas que serão usadas para verificar (na ordem especificada) para usar como uma coluna modificada durante a replicação. | |
IDENTIFIER_PATTERN | Valor de string que indica qual string é válida para um identificador. | |
SUPPORT_TRANSACTION | Indica se o provedor oferece suporte a transações como confirmação e reversão. | YES , NO |
DIALECT | Indica o dialeto SQL a ser usado. | |
KEY_PROPERTIES | Indica as propriedades que identificam o banco de dados uniforme. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indica se vários esquemas podem existir para o provedor. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indica se vários catálogos podem existir para o provedor. | YES , NO |
DATASYNCVERSION | A versão do Data Sync necessária para acessar este driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | A categoria Data Sync deste driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Se a funcionalidade SQL aprimorada além do que é oferecido pela API é suportada. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Se as operações em lote são suportadas. | YES , NO |
SQL_CAP | Todos os recursos SQL suportados para este driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | Um valor de string especifica o cacheOptions preferencial. | |
ENABLE_EF_ADVANCED_QUERY | Indica se o driver oferece suporte direto a consultas avançadas provenientes do Entity Framework. Caso contrário, as consultas serão tratadas no lado do cliente. | YES , NO |
PSEUDO_COLUMNS | Uma matriz de cadeia de caracteres que indica as pseudocolunas disponíveis. | |
MERGE_ALWAYS | Se o valor for verdadeiro, o modo de mesclagem será executado à força no Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | Uma consultar de seleção para retornar a data e hora de início da replicação. | |
REPLICATION_MIN_FUNCTION | Permite que um provedor especifique o nome da fórmula a ser usado para executar um min do lado do servidor. | |
REPLICATION_START_DATE | Permite que um provedor especifique uma data de início de replicação. | |
REPLICATION_MAX_DATE_QUERY | Uma consultar de seleção para retornar a data e hora de término da replicação. | |
REPLICATION_MAX_FUNCTION | Permite que um provedor especifique o nome da fórmula a ser usado para executar um máximo do lado do servidor. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | Uma lista de tabelas que ignorará a divisão da replicação em blocos na replicação inicial. | |
CHECKCACHE_USE_PARENTID | Indica se a instrução CheckCache deve ser executada na coluna de chave pai. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indica procedimentos armazenados* que pode ser usado para gerar arquivos de esquema. |
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
Nome | Tipo | Descrição |
---|---|---|
NAME | String | Um componente da sintaxe SQL ou um recurso que pode ser processado no servidor. |
VALUE | String | Detalhes sobre a sintaxe SQL ou SQL suportada. |
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
Nome | Tipo | Descrição |
---|---|---|
Id | String | O ID gerado pelo banco de dados retornado de uma operação de modificação de dados. |
Batch | String | Um identificador para o lote. 1 para uma única operação. |
Operation | String | O resultado da operação no lote: INSERTED, UPDATED ou DELETED. |
Message | String | SUCCESS ou uma mensagem de erro se a atualização no lote falhou. |
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.
Propriedade | Descrição |
---|---|
AuthScheme | O tipo de autenticação a ser usado ao conectar-se a serviços remotos. |
User | A conta de usuário do Excel usada para autenticação. |
Password | A senha usada para autenticar o usuário. |
SharePointEdition | A edição do SharePoint que está sendo usada. Defina SharePointOnline ou SharePointOnPremise. |
Propriedade | Descrição |
---|---|
URI | O Uniform Resource Identifier (URI) para o local do recurso do Excel. |
DefineTables | Mapeie intervalos do Excel para nomes de tabelas. |
Header | Indica se a primeira linha deve ser usada como cabeçalho de coluna. |
Orientation | Indica se os dados no Excel são dispostos horizontalmente ou verticalmente. |
ExcelFile | A localização de um arquivo do Excel. |
BufferChanges | Indica se as alterações nos dados devem ser mantidas na memória até que a conexão seja encerrada. |
Region | A região de hospedagem para seus serviços da Web semelhantes ao S3. |
ProjectId | O ID do projeto em que sua instância do Google Cloud Storage reside. |
OracleNamespace | O namespace do Oracle Cloud Object Storage a ser usado. |
StorageBaseURL | A URL de um provedor de serviços de armazenamento em nuvem. |
UseVirtualHosting | Se true (padrão), os buckets serão referenciados na solicitação usando a solicitação de estilo hospedado: http://yourbucket.s3.amazonaws.com/yourobject . Se definido como falso, o bean usará a solicitação de estilo de caminho: http://s3.amazonaws.com/yourbucket/yourobject . Observe que esta propriedade será definida como false, no caso de um serviço customizado baseado em S3 quando o CustomURL for especificado. |
Propriedade | Descrição |
---|---|
AWSAccessKey | Sua chave de acesso da conta da AWS. Esse valor pode ser acessado na página de credenciais de segurança da AWS. |
AWSSecretKey | A chave secreta da sua conta da AWS. Esse valor pode ser acessado na página de credenciais de segurança da AWS. |
AWSRoleARN | O nome de recurso da Amazon da papel a ser usada durante a autenticação. |
AWSPrincipalARN | O ARN do provedor de identidade SAML em sua conta da AWS. |
AWSRegion | A região de hospedagem do seu Amazon Web Services. |
AWSSessionToken | Seu token de sessão da AWS. |
MFASerialNumber | O número de série do dispositivo MFA, se estiver sendo usado. |
MFAToken | O token temporário disponível em seu dispositivo MFA. |
Propriedade | Descrição |
---|---|
AzureStorageAccount | O nome da sua conta de armazenamento do Azure. |
AzureAccessKey | A chave de armazenamento associada à sua conta do Excel. |
AzureSharedAccessSignature | Uma assinatura de chave de acesso compartilhado que pode ser usada para autenticação. |
AzureTenant | O locatário do Microsoft Online sendo usado para acessar dados. Se não for especificado, seu tentante padrão será usado. |
AzureEnvironment | O ambiente do Azure a ser usado ao estabelecer uma conexão. |
Propriedade | Descrição |
---|---|
SSOLoginURL | A URL de login do provedor de identidade. |
SSOProperties | Propriedades adicionais necessárias para se conectar ao provedor de identidade em uma lista separada por ponto e vírgula. |
Propriedade | Descrição |
---|---|
AllowFormula | Se deve ou não tratar os valores que começam com um sinal de igual (=) como fórmulas durante inserções e atualizações. |
EmptyValueMode | Indica se os valores vazios devem ser lidos como vazios ou nulos. |
NullValues | Uma lista separada por vírgulas que será substituída por nulos se forem encontrados no arquivo CSV. |
IgnoreCalcError | Indica se os erros ocorridos durante o cálculo devem ser ignorados. |
NullValueMode | Indica se as células vazias devem ser lidas como nulas ou vazias. |
HasCrossSheetReferences | Indica como as referências de folha cruzada são tratadas. |
Recalculate | Indica se todas as fórmulas devem ser recalculadas quando os dados são lidos. |
ShowEmptyRows | Indica se as linhas vazias devem ou não ser empurradas. |
TypeDetectionScheme | Determina como o provedor detecta os tipos de dados das colunas. |
UseFastInsert | Indica se deve usar o fastInsert ao executar Instrução de Inserção. |
SkipTop | Ignora o número de linhas especificadas a partir do topo. |
Propriedade | Descrição |
---|---|
InitiateOAuth | Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar. |
OAuthVersion | A versão do OAuth que está sendo usada. |
OAuthClientId | O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth. |
OAuthClientSecret | O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth. |
OAuthAccessToken | O token de acesso para conexão usando OAuth. |
OAuthAccessTokenSecret | O segredo do token de acesso OAuth para conexão usando OAuth. |
CallbackURL | O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo. |
OAuthGrantType | O tipo de concessão para o fluxo OAuth. |
OAuthPasswordGrantMode | Como passar ID e Segredo do Cliente com OAuthGrantType definido como Senha. |
OAuthIncludeCallbackURL | Se o URL de retorno de chamada deve ser incluído em uma solicitação de token de acesso. |
OAuthAuthorizationURL | A URL de autorização para o serviço OAuth. |
OAuthAccessTokenURL | A URL da qual recuperar o token de acesso OAuth. |
OAuthRefreshTokenURL | A URL a partir da qual atualizar o token OAuth. |
OAuthRequestTokenURL | A URL que o serviço fornece para recuperar tokens de solicitação. Isso é necessário no OAuth 1.0. |
OAuthVerifier | O código do verificador retornado da URL de autorização OAuth. |
AuthToken | O token de autenticação usado para solicitar e obter o token de acesso OAuth. |
AuthKey | O segredo de autenticação usado para solicitar e obter o token de acesso OAuth. |
OAuthParams | Uma lista separada por vírgulas de outros parâmetros a serem enviados na solicitação para o token de acesso OAuth no formato paramname=value. |
OAuthRefreshToken | O token de atualização OAuth para o token de acesso OAuth correspondente. |
OAuthExpiresIn | O tempo de vida em segundos do OAuth AccessToken. |
OAuthTokenTimestamp | O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado. |
Propriedade | Descrição |
---|---|
OAuthJWTCert | A loja de certificados JWT. |
OAuthJWTCertType | O tipo de armazenamento de chaves que contém o certificado JWT. |
OAuthJWTCertPassword | A senha para o certificado OAuth JWT. |
OAuthJWTCertSubject | O assunto do certificado OAuth JWT. |
OAuthJWTIssuer | O emissor do Java Web Token. |
OAuthJWTSubject | O assunto do usuário para o qual o aplicativo está solicitando acesso delegado. |
Propriedade | Descrição |
---|---|
KerberosKDC | O serviço Kerberos Key Distribution Center (KDC) usado para autenticar o usuário. |
KerberosRealm | O Kerberos Realm usado para autenticar o usuário. |
KerberosSPN | O nome principal do serviço (SPN) para o controlador de domínio Kerberos. |
KerberosKeytabFile | O arquivo Keytab contendo seus pares de principais Kerberos e chaves criptografadas. |
KerberosServiceRealm | A região Kerberos do serviço. |
KerberosServiceKDC | O Kerberos KDC do serviço. |
KerberosTicketCache | O caminho de arquivo completo para um arquivo de cache de credenciais do MIT Kerberos. |
Propriedade | Descrição |
---|---|
SSLClientCert | O armazenamento de certificados de cliente TLS/SSL para autenticação de cliente SSL (SSL bidirecional). |
SSLClientCertType | O tipo de armazenamento de chaves que contém o certificado do cliente TLS/SSL. |
SSLClientCertPassword | A senha para o certificado de cliente TLS/SSL. |
SSLClientCertSubject | O assunto do certificado de cliente TLS/SSL. |
SSLMode | O mecanismo de autenticação a ser usado ao conectar-se ao servidor FTP ou FTPS. |
SSLServerCert | O certificado a ser aceito do servidor ao conectar usando TLS/SSL. |
Propriedade | Descrição |
---|---|
SSHAuthMode | O método de autenticação a ser usado para fazer logon em um servidor SFTP. |
SSHClientCert | Um certificado a ser usado para autenticar o usuário. |
SSHClientCertPassword | A senha do certificado SSHClientCert, se houver. |
SSHClientCertType | O tipo de certificado SSHClientCert. |
Propriedade | Descrição |
---|---|
Location | Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados. |
BrowsableSchemas | Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC. |
Views | Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC. |
Propriedade | Descrição |
---|---|
Charset | Especifica o conjunto de caracteres da sessão para codificação e decodificação de dados de caracteres transferidos de e para o arquivo Excel. O valor padrão é UTF-8. |
ClientCulture | Essa propriedade pode ser usada para especificar o formato dos dados (por exemplo, valores monetários) que são aceitos pelo aplicativo cliente. Essa propriedade pode ser usada quando o aplicativo cliente não oferece suporte às configurações de cultura da máquina. Por exemplo, o Microsoft Access requer 'en-US'. |
Culture | Essa configuração pode ser usada para especificar configurações de cultura que determinam como o provedor interpreta determinados tipos de dados que são passados para o provedor. Por exemplo, definir Culture='de-DE' produzirá formatos alemães mesmo em uma máquina americana. |
CustomHeaders | Outros cabeçalhos conforme determinado pelo usuário (opcional). |
CustomUrlParams | A string de consultar personalizada a ser incluída na solicitação. |
IncludeDropboxTeamResources | Indica se você deseja incluir arquivos e pastas da equipe do Dropbox. |
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. |
Other | Essas propriedades ocultas são usadas apenas em casos de uso específicos. |
PseudoColumns | Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela. |
RowScanDepth | O número máximo de linhas a serem verificadas para procurar as colunas disponíveis em uma tabela. |
Timeout | O valor em segundos até que o erro de timeout seja lançado, cancelando a operação. |
Autenticação
Esta seção fornece uma lista completa de propriedades de autenticação que você pode configurar.
Propriedade | Descrição |
---|---|
AuthScheme | O tipo de autenticação a ser usado ao conectar-se a serviços remotos. |
User | A conta de usuário do Excel usada para autenticação. |
Password | A senha usada para autenticar o usuário. |
SharePointEdition | A edição do SharePoint que está sendo usada. Defina SharePointOnline ou SharePointOnPremise. |
AuthScheme
O tipo de autenticação a ser usado ao conectar-se a serviços remotos.
Valores Possíveis
None
, Basic
, Auto
, Digest
, NTLM
, Negotiate
, OAuth
, OAuthJWT
, SFTP
, FTP
, SSLCertificate
, AwsRootKeys
, AwsIAMRoles
, AwsEC2Roles
, AwsMFA
, AwsTempCredentials
, AwsCredentialsFile
, AzureAD
, AzureServicePrincipal
, AzureMSI
, OKTA
, ADFS
, OneLogin
, PingFederate
, HMAC
Tipo de Dados
string
Valor Padrão
"None"
Observações
Em Geral
As seguintes opções estão geralmente disponíveis para todas as conexões:
- Nenhum: Não usa autenticação.
- Básico: Usa autenticação básica com Usuário e senha.
- Auto: determina o tipo certo de autenticação a ser usado com base no serviço. Arquivos locais e HTTP usarão None.
HTTP
As seguintes opções estão disponíveis quando URI refere-se a um serviço da web:
- Digest: Usa autenticação HTTP Digest com User e senha.
- NTLM: Usa autenticação NTLM com Usuário e senha definido para suas credenciais do Windows.
- Negociar: negocia com o servidor para determinar um esquema de autenticação. Normalmente usado com Kerberos, que requer KerberosKDC, KerberosRealm e KerberosSPN.
- OAuth: Usa OAuth1 ou OAuth2, com o fluxo específico sendo determinado pelo OAuthGrantType. OAuthVersion deve ser definido para determinar qual versão do OAuth é usada.
- SSL: Usa certificados de cliente SSL para autenticação. Requer que URI seja definido como um URL HTTPS e que SSLClientCert e SSLClientCertType ser definido.
AWS
As seguintes opções também estão disponíveis quando URI aponta para um serviço da Amazon:
- AwsRootKeys: defina isso para usar a chave de acesso e o segredo do usuário raiz. Útil para testes rápidos, mas os casos de uso de produção são encorajados a usar algo com permissões restritas.
- AwsIAMRoles: definido para usar funções IAM para a conexão.
- AwsEC2Roles: defina isso para usar automaticamente as funções IAM atribuídas à máquina EC2 em que o Jitterbit Connector for Excel está sendo executado no momento.
- AwsMFA: definido para usar a autenticação multifator.
- OKTA: definido para usar uma conexão de logon único com OKTA como o provedor de identificação.
- ADFS: definido para usar uma conexão de logon único com ADFS como o provedor de identificação.
- Microsoft Entra ID: definido para usar uma conexão de logon único com o Microsoft Entra ID como o provedor de identificação.
- AwsTempCredentials: defina isso para aproveitar as credenciais de segurança temporárias juntamente com um token de sessão para se conectar.
- AwsCredentialsFile: definido para usar um arquivo de credencial para autenticação.
Azure
As seguintes opções também estão disponíveis quando URI aponta para um serviço do Azure:
- Microsoft Entra ID: defina isso para executar a autenticação OAuth do Azure Active Directory.
- AzureServicePrincipal: defina isso para autenticar como uma Entidade de Serviço do Azure.
- AzureMSI: defina isso para obter automaticamente credenciais de Identidade de Serviço Gerenciado ao executar em uma VM do Azure.
SharePoint
As seguintes opções também estão disponíveis quando URI aponta para um serviço SOAP do SharePoint:
- OKTA: definido para usar uma conexão de logon único com OKTA como o provedor de identificação.
- ADFS: definido para usar uma conexão de logon único com ADFS como o provedor de identificação.
- OneLogin: definido para usar uma conexão de logon único com OneLogin como o provedor de identificação.
- PingFederate: definido para usar uma conexão de logon único com PingFederate como o provedor de identificação.
IBM Cloud Object Storage
As seguintes opções também estão disponíveis quando URI aponta para um serviço IBM Cloud Object Storage:
- OAuth: Usa OAuth com o fluxo específico sendo determinado pelo InitiateOAuth. Chave API deve ser definido para concluir esse fluxo com êxito.
- HMAC: Usa AccessKey e SecretKey para autenticar no serviço IBM Cloud Object Storage.
Do Utilizador
A conta de usuário do Excel usada para autenticação.
Tipo de Dados
string
Valor Padrão
""
Observações
Juntamente com Senha, este campo é usado para autenticar no servidor Excel.
Senha
A senha usada para autenticar o usuário.
Tipo de Dados
string
Valor Padrão
""
Observações
O usuário e Password
são usados juntos para autenticar com o servidor.
Edição do SharePoint
A edição do SharePoint que está sendo usada. Defina SharePointOnline ou SharePointOnPremise.
Valores Possíveis
SharePointOnline
, SharePointOnPremise
Tipo de Dados
string
Valor Padrão
"SharePointOnline"
Observações
A edição do SharePoint que está sendo usada. Defina SharePointOnline ou SharePointOnPremise.
Conexão
Esta seção fornece uma lista completa de propriedades de conexão que você pode configurar.
Propriedade | Descrição |
---|---|
URI | O Uniform Resource Identifier (URI) para o local do recurso do Excel. |
DefineTables | Mapeie intervalos do Excel para nomes de tabelas. |
Header | Indica se a primeira linha deve ser usada como cabeçalho de coluna. |
Orientation | Indica se os dados no Excel são dispostos horizontalmente ou verticalmente. |
ExcelFile | A localização de um arquivo do Excel. |
BufferChanges | Indica se as alterações nos dados devem ser mantidas na memória até que a conexão seja encerrada. |
Region | A região de hospedagem para seus serviços da Web semelhantes ao S3. |
ProjectId | O ID do projeto em que sua instância do Google Cloud Storage reside. |
OracleNamespace | O namespace do Oracle Cloud Object Storage a ser usado. |
StorageBaseURL | A URL de um provedor de serviços de armazenamento em nuvem. |
UseVirtualHosting | Se true (padrão), os buckets serão referenciados na solicitação usando a solicitação de estilo hospedado: http://yourbucket.s3.amazonaws.com/yourobject . Se definido como falso, o bean usará a solicitação de estilo de caminho: http://s3.amazonaws.com/yourbucket/yourobject . Observe que esta propriedade será definida como false, no caso de um serviço customizado baseado em S3 quando o CustomURL for especificado. |
URI
O Uniform Resource Identifier (URI) para o local do recurso do Excel.
Tipo de Dados
string
Valor Padrão
""
Observações
Colocou o URI
propriedade para especificar um caminho para um arquivo ou fluxo.
Abaixo estão exemplos de URI
formatos para as fontes de dados disponíveis:
Prestador de Serviços | Formatos URI |
---|---|
Local | localPath/file.xlsx file://localPath/file.xlsx |
HTTP ou HTTPS | http://remoteStream https://remoteStream |
Amazon S3 | s3://remotePath/file.xlsx |
Google Drive | gdrive://remotePath/file.xlsx |
Box | box://remotePath/file.xlsx |
FTP ou FTPS | ftp://server:port/remotePath/file.xlsx ftps://server:port/remotepath/file.xlsx |
SFTP | sftp://server:port/remotePath/file.xlsx |
Sharepoint | sp://https://server/remotePath/file.xlsx |
Exemplos de Strings de Conexão e Consultas
Abaixo estão exemplos de cadeias de conexão para arquivos ou fluxos do Excel.
Prestador de Serviços | Formatos URI | Exemplo de conexão | Exemplo de consulta (se file.xlsx contiver planilha1 ou streamname1 for um fluxo do Excel ) |
---|---|---|---|
Local | localPath file://localPath/file.xlsx | URI=C:/pasta1/arquivo.xlsx | SELECT * FROM planilha1 |
HTTP ou HTTPS | http://remoteStream https://remoteStream | URI=http://www.host1.com/streamname1; | SELECT * FROM tabela de streaming |
Amazon S3 | s3://bucket1/folder1/file.xlsx | URI=s3://bucket1/folder1/file.xlsx; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegião=OHIO; | SELECT * FROM planilha1 |
Google Drive | gdrive://remotePath/file.xlsx | URI=gdrive://folder1/file.xlsx;InitiateOAuth=GETANDREFRESH; | SELECT * FROM planilha1 |
Box | box://remotePath/file.xlsx | URI=box://folder1/file.xlsx; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthclientsecret1; CallbackUrl=http://localhost:12345; | SELECT * FROM planilha1 |
FTP ou FTPS | ftp://server:port/remotePath/file.xlsx ftps://server:port/remotepath/file.xlsx | URI=ftps://localhost:990/folder1/file.xlsx; Usuário=usuário1; Senha=senha1; | SELECT * FROM planilha1 |
SFTP | sftp://server:port/remotePath/file.xlsx | URI=sftp://127.0.0.1:22/remotePath/file.xlsx; Usuário=usuário1; Senha=senha1; | SELECT * FROM planilha1 |
Sharepoint | sp://https://server/remotePath/file.xlsx | URI=sp://https://domain.sharepoint.com/Documents/file.xlsx; Usuário=usuário1; Senha=senha1; | SELECT * FROM planilha1 |
DefinirTabelas
Mapeie intervalos do Excel para nomes de tabelas.
Tipo de Dados
string
Valor Padrão
""
Observações
Você pode usar essa propriedade para definir explicitamente intervalos em uma planilha do Excel que aparecerá como tabelas; o conector detecta automaticamente tabelas para planilhas e intervalos nomeados.
Mapeando Nomes de Tabelas para Intervalos
O DefineTables
valor é uma lista separada por vírgulas de pares nome-valor no formato [Nome da tabela]=[Nome da planilha]![Intervalo]. Nome da tabela é o nome da tabela que você deseja usar para os dados e será usado ao emitir consultas. Nome da Planilha é o nome da planilha dentro da Planilha do Excel e Intervalo é o intervalo de células que contém os dados da tabela.
Aqui está um exemplo de valor DefineTables: DefineTables="Table1=Sheet1!A1:N25,Table2=Sheet2!C3:M53"
Cabeçalho
Indica se a primeira linha deve ser usada como cabeçalho de coluna.
Tipo de Dados
string
Valor Padrão
"true"
Observações
Se verdadeiro, a primeira linha será usada como cabeçalho de coluna. Caso contrário, serão usados os nomes das pseudocolunas A, B, C, etc.
Se você deseja excluir alguma planilha desta regra, pode definir: Header=True, Sheet1= False (significa que os cabeçalhos são verdadeiros para todas as planilhas, exceto Sheet1)
Orientação
Indica se os dados no Excel são dispostos horizontalmente ou verticalmente.
Valores Possíveis
Horizontal
, Vertical
Tipo de Dados
string
Valor Padrão
"Vertical"
Observações
Por padrão, o conector modela dados de planilha orientados verticalmente -- linhas organizadas verticalmente abaixo de uma linha de cabeçalho.
Defina como "Horizontal" se as linhas estiverem organizadas da esquerda para a direita. A primeira coluna contém os nomes das colunas e as colunas subsequentes se tornam linhas.
A propriedade Header é usada em conjunto com a propriedade Orientation. Quando Cabeçalho é definido como falso e Orientação é definida como Colunas, os nomes das colunas são relatados como R1, R2, R3, etc.
Se você deseja excluir quaisquer planilhas desta regra, pode definir: Orientation=Horizontal, Sheet1=vertical (significa que a orientação é definida como horizontal para todas as planilhas, exceto Sheet1)
ExcelFile
A localização de um arquivo do Excel.
Tipo de Dados
string
Valor Padrão
""
Observações
Esta propriedade está obsoleta e foi substituída por URI.
Um caminho que aponta para um arquivo do Excel. O arquivo deve existir. O conector implementa suporte para planilhas Office Open XML usadas pelo Excel 2007 e posterior.
BufferChanges
Indica se as alterações nos dados devem ser mantidas na memória até que a conexão seja encerrada.
Tipo de Dados
bool
Valor Padrão
true
Observações
Indica se as alterações nos dados devem ser mantidas na memória até que a conexão seja encerrada. Definir como false gravará as alterações imediatamente, mas haverá um impacto no desempenho ao emitir muitas solicitações, pois o arquivo deve ser aberto e fechado repetidamente.
Região
A região de hospedagem para seus serviços da Web semelhantes ao S3.
Tipo de Dados
string
Valor Padrão
""
Observações
A região de hospedagem para seus serviços da Web semelhantes ao S3.
Regiões do Oracle Cloud Object Storage
Valor | Região |
---|---|
Regiões de nuvem comercial | |
ap-hyderabad-1 | Sul da Índia (Hyderabad) |
ap-melbourne-1 | Sudeste da Austrália (Melbourne) |
ap-mumbai-1 | Oeste da Índia (Mumbai) |
ap-osaka-1 | Japão Central (Osaka) |
ap-seoul-1 | Coreia do Sul Central (Seul) |
ap-sydney-1 | Austrália Leste (Sydney) |
ap-tokyo-1 | Japão Leste (Tóquio) |
ca-montreal-1 | Sudeste do Canadá (Montreal) |
ca-toronto-1 | Sudeste do Canadá (Toronto) |
eu-amsterdam-1 | Noroeste dos Países Baixos (Amsterdão) |
eu-frankfurt-1 | Alemanha Central (Frankfurt) |
eu-zurich-1 | Norte da Suíça (Zurique) |
me-jeddah-1 | Arábia Saudita Oeste (Jeddah) |
sa-saopaulo-1 | Brasil Leste (São Paulo) |
uk-london-1 | Sul do Reino Unido (Londres) |
us-ashburn-1 (padrão) | Leste dos EUA (Ashburn, VA) |
us-phoenix-1 | Oeste dos EUA (Phoenix, AZ) |
Regiões altas do FedRAMP do governo dos EUA | |
us-langley-1 | Governo dos EUA Leste (Ashburn, VA) |
us-luke-1 | Governo dos EUA Oeste (Phoenix, AZ) |
Regiões DISA IL5 do governo dos EUA | |
us-gov-ashburn-1 | US DoD East (Ashburn, VA) |
us-gov-chicago-1 | US DoD North (Chicago, IL) |
us-gov-phoenix-1 | US DoD West (Phoenix, AZ) |
Regiões Wasabi
Valor | Região |
---|---|
eu-central-1 | Europa (Amsterdã) |
us-east-1 (Padrão) | Leste dos EUA (Ashburn, VA) |
us-east-2 | Leste dos EUA (Manassas, VA) |
us-west-1 | Oeste dos EUA (Hillsboro, OR) |
ProjectId
O ID do projeto em que sua instância do Google Cloud Storage reside.
Tipo de Dados
string
Valor Padrão
""
Observações
O ID do projeto em que sua instância do Google Cloud Storage 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.
OracleNamespace
O namespace do Oracle Cloud Object Storage a ser usado.
Tipo de Dados
string
Valor Padrão
""
Observações
O namespace do Oracle Cloud Object Storage a ser usado. Essa configuração deve ser definida para o namespace do Oracle Cloud Object Storage associado à conta do Oracle Cloud antes que qualquer solicitação possa ser feita. Consulte Entendendo os namespaces de armazenamento de objetos da documentação do Oracle Cloud para obter instruções sobre como localizar o namespace do Object Storage da sua conta.
StorageBaseURL
A URL de um provedor de serviços de armazenamento em nuvem.
Tipo de Dados
string
Valor Padrão
""
Observações
Esta propriedade de conexão é usada para especificar:
- A URL de um serviço S3 personalizado
- A URL necessária para o provedor de serviços de armazenamento em nuvem Sharepoint SOAP/REST. Se o domínio para esta opção terminar em
-my
(por exemplo,https://bigcorp-my.sharepoint.com
) então você pode precisar usar oonedrive://
esquema em vez dosp://
ousprest://
esquema.
UseVirtualHosting
Se true (padrão), os buckets serão referenciados na solicitação usando a solicitação de estilo hospedado: http://yourbucket.s3.amazonaws.com/yourobject
. Se definido como falso, o bean usará a solicitação de estilo de caminho: http://s3.amazonaws.com/yourbucket/yourobject
. Observe que esta propriedade será definida como false, no caso de um serviço customizado baseado em S3 quando o CustomURL for especificado.
Tipo de Dados
bool
Valor Padrão
true
Observações
Se true (padrão), os buckets serão referenciados na solicitação usando a solicitação de estilo hospedado: http://yourbucket.s3.amazonaws.com/yourobject
. Se definido como falso, o bean usará a solicitação de estilo de caminho: http://s3.amazonaws.com/yourbucket/yourobject
. Observe que esta propriedade será definida como false, no caso de um serviço customizado baseado em S3 quando o CustomURL for especificado.
Autenticação da AWS
Esta seção fornece uma lista completa das propriedades de autenticação da AWS que você pode configurar.
Propriedade | Descrição |
---|---|
AWSAccessKey | Sua chave de acesso da conta da AWS. Esse valor pode ser acessado na página de credenciais de segurança da AWS. |
AWSSecretKey | A chave secreta da sua conta da AWS. Esse valor pode ser acessado na página de credenciais de segurança da AWS. |
AWSRoleARN | O nome de recurso da Amazon da papel a ser usada durante a autenticação. |
AWSPrincipalARN | O ARN do provedor de identidade SAML em sua conta da AWS. |
AWSRegion | A região de hospedagem do seu Amazon Web Services. |
AWSSessionToken | Seu token de sessão da AWS. |
MFASerialNumber | O número de série do dispositivo MFA, se estiver sendo usado. |
MFAToken | O token temporário disponível em seu dispositivo MFA. |
AWSAccessKey
Sua chave de acesso da conta da AWS. Esse valor pode ser acessado na página de credenciais de segurança da AWS.
Tipo de Dados
string
Valor Padrão
""
Observações
Sua chave de acesso da conta da AWS. Esse valor pode ser acessado na página de credenciais de segurança da AWS:
- Faça login no console de gerenciamento da AWS com as credenciais de sua conta raiz.
- Selecione o nome ou número da sua conta e selecione Minhas credenciais de segurança no menu exibido.
- Clique em Continuar para credenciais de segurança e expanda a seção Chaves de acesso para gerenciar ou criar chaves de acesso de conta root.
AWSSecretKey
A chave secreta da sua conta da AWS. Esse valor pode ser acessado na página de credenciais de segurança da AWS.
Tipo de Dados
string
Valor Padrão
""
Observações
A chave secreta da sua conta da AWS. Esse valor pode ser acessado na página de credenciais de segurança da AWS:
- Faça login no console de gerenciamento da AWS com as credenciais de sua conta root.
- Selecione o nome ou número da sua conta e selecione Minhas credenciais de segurança no menu exibido.
- Clique em Continuar para credenciais de segurança e expanda a seção Chaves de acesso para gerenciar ou criar chaves de acesso de conta raiz.
AWSRoleARN
O nome de recurso da Amazon da papel a ser usada durante a autenticação.
Tipo de Dados
string
Valor Padrão
""
Observações
Ao autenticar fora da AWS, é comum usar uma função para autenticação em vez de suas credenciais diretas da conta da AWS. Entrando no AWSRoleARN
fará com que o Jitterbit Connector for Excel execute uma autenticação baseada em papel em vez de usar a AWSAccessKey e AWSSecretKey diretamente. A AWSAccessKey e AWSSecretKey ainda deve ser especificado para executar esta autenticação. Você não pode usar as credenciais de um usuário raiz da AWS ao definir RoleARN. A AWSAccessKey e AWSSecretKey devem ser de um usuário do IAM.
AWSPrincipalARN
O ARN do provedor de identidade SAML em sua conta da AWS.
Tipo de Dados
string
Valor Padrão
""
Observações
O ARN do provedor de identidade SAML em sua conta da AWS.
AWSRegion
A região de hospedagem do seu Amazon Web Services.
Valores Possíveis
OHIO
, NORTHERNVIRGINIA
, NORTHERNCALIFORNIA
, OREGON
, CAPETOWN
, HONGKONG
, MUMBAI
, OSAKA
, SEOUL
, SINGAPORE
, SYDNEY
, TOKYO
, CENTRAL
, BEIJING
, NINGXIA
, FRANKFURT
, IRELAND
, LONDON
, MILAN
, PARIS
, STOCKHOLM
, BAHRAIN
, SAOPAULO
, GOVCLOUDEAST
, GOVCLOUDWEST
Tipo de Dados
string
Valor Padrão
"NORTHERNVIRGINIA"
Observações
A região de hospedagem do seu Amazon Web Services. Os valores disponíveis são Ohio, NorthernVirginia, NorthernCalifornia, Oregon, Capetown, Hong Kong, Mumbai, Osaka, Seul, Cingapura, Sydney, Tóquio, Central, Pequim, Ningxia, Frankfurt, Ireland, Londres, Milan, Paris, Stockholm, Bahrain, SAUL, SALFURT, SALAND, SALAN, MILAN, GOLAN, PARIS, BAHRAIN, e GOVCLOUDWEST.
AWSSessionToken
Seu token de sessão da AWS.
Tipo de Dados
string
Valor Padrão
""
Observações
Seu token de sessão da AWS. Esse valor pode ser recuperado de diferentes maneiras. Veja este link para mais informações.
MFASerialNumber
O número de série do dispositivo MFA, se estiver sendo usado.
Tipo de Dados
string
Valor Padrão
""
Observações
Você pode encontrar o dispositivo de um usuário do IAM acessando o Management Console da AWS e visualizando as credenciais de segurança do usuário. Para dispositivos virtuais, na verdade, é um nome de recurso da Amazon (como arn:aws:iam:123456789012:mfa/user).
MFAToken
O token temporário disponível em seu dispositivo MFA.
Tipo de Dados
string
Valor Padrão
""
Observações
Se o MFA for necessário, esse valor será usado junto com o MFASerialNumber para recuperar credenciais temporárias para fazer login. As credenciais temporárias disponíveis na AWS duram apenas 1 hora por padrão (consulte TemporaryTokenDuration). Uma vez esgotado o tempo, a conexão deve ser atualizada para especificar um novo token MFA para que novas credenciais possam ser obtidas. %AWSpSecurityToken; %AWSpTemporaryTokenDuration;
Autenticação do Azure
Esta seção fornece uma lista completa das propriedades de autenticação do Azure que você pode configurar.
Propriedade | Descrição |
---|---|
AzureStorageAccount | O nome da sua conta de armazenamento do Azure. |
AzureAccessKey | A chave de armazenamento associada à sua conta do Excel. |
AzureSharedAccessSignature | Uma assinatura de chave de acesso compartilhado que pode ser usada para autenticação. |
AzureTenant | O locatário do Microsoft Online sendo usado para acessar dados. Se não for especificado, seu tentante padrão será usado. |
AzureEnvironment | O ambiente do Azure a ser usado ao estabelecer uma conexão. |
AzureStorageAccount
O nome da sua conta de armazenamento do Azure.
Tipo de Dados
string
Valor Padrão
""
Observações
O nome da sua conta de armazenamento do Azure.
AzureAccessKey
A chave de armazenamento associada à sua conta do Excel.
Tipo de Dados
string
Valor Padrão
""
Observações
A chave de armazenamento associada à sua conta do Excel. Você pode recuperá-lo da seguinte maneira:
- Entre no portal azure com as credenciais de sua conta root. ( https://portal.azure.com/ )
- Clique em contas de armazenamento e selecione a conta de armazenamento que deseja usar.
- Em configurações, clique em Chaves de acesso.
- O nome e a chave da sua conta de armazenamento serão exibidos nessa página.
AzureSharedAccessSignature
Uma assinatura de chave de acesso compartilhado que pode ser usada para autenticação.
Tipo de Dados
string
Valor Padrão
""
Observações
Uma assinatura de acesso compartilhado. Você pode criar um seguindo estas etapas:
- Entre no portal azure com as credenciais de sua conta root. (https://portal.azure.com/)
- Clique em contas de armazenamento e selecione a conta de armazenamento que deseja usar.
- Em configurações, clique em Assinatura de acesso compartilhado.
- Defina as permissões e quando o token expirará
- Clique em Gerar SAS para copiar o token.
AzureTenant
O locatário do Microsoft Online sendo usado para acessar dados. Se não for especificado, seu tentante padrão será usado.
Tipo de Dados
string
Valor Padrão
""
Observações
O locatário do Microsoft Online sendo usado para acessar dados. Por exemplo, contoso.onmicrosoft.com. Como alternativa, especifique a ID do locatário. Esse valor é a ID do diretório no Portal do Azure > Azure Active Directory > Propriedades.
Normalmente, não é necessário especificar o inquilino. Isso pode ser determinado automaticamente pela Microsoft ao usar o OAuthGrantType definido como CODE (padrão). No entanto, pode falhar caso o usuário pertença a vários locatários. Por exemplo, se um administrador do domínio A convidar um usuário do domínio B para ser um usuário convidado. O usuário agora pertencerá a ambos os locatários. É uma boa prática especificar o inquilino, embora em geral as coisas funcionem normalmente sem precisar especificá-lo.
O AzureTenant
é necessário ao definir OAuthGrantType ao CLIENTE. Ao usar credenciais de cliente, não há contexto de usuário. As credenciais são obtidas do contexto do próprio aplicativo. Embora a Microsoft ainda permita que as credenciais do cliente sejam obtidas sem especificar qual locatário, ela tem uma probabilidade muito menor de escolher o locatário específico com o qual deseja trabalhar. Por este motivo, exigimos AzureTenant
a ser declarado explicitamente para todas as conexões de credenciais do cliente para garantir que você obtenha credenciais aplicáveis ao domínio ao qual pretende se conectar.
Ambiente Azure
O ambiente do Azure a ser usado ao estabelecer uma conexão.
Valores Possíveis
GLOBAL
, CHINA
, GERMANY
, USGOVT
, USGOVTDOD
Tipo de Dados
string
Valor Padrão
"GLOBAL"
Observações
Na maioria dos casos, deixar o ambiente definido como global funcionará. No entanto, se sua conta do Azure tiver sido adicionada a um ambiente diferente, o AzureEnvironment
pode ser usado para especificar qual ambiente. Os valores disponíveis são GLOBAL, CHINA, GERMANY, USGOVT e USGOVTDOD.
SSO
Esta seção fornece uma lista completa de propriedades SSO que você pode configurar.
Propriedade | Descrição |
---|---|
SSOLoginURL | A URL de login do provedor de identidade. |
SSOProperties | Propriedades adicionais necessárias para se conectar ao provedor de identidade em uma lista separada por ponto e vírgula. |
SSOLoginURL
A URL de login do provedor de identidade.
Tipo de Dados
string
Valor Padrão
""
Observações
A URL de login do provedor de identidade.
SSOPropriedades
Propriedades adicionais necessárias para se conectar ao provedor de identidade em uma lista separada por ponto e vírgula.
Tipo de Dados
string
Valor Padrão
""
Observações
Propriedades adicionais necessárias para se conectar ao provedor de identidade em uma lista separada por ponto e vírgula. é usado em conjunto com o SSOLoginURL.
A configuração de SSO é discutida mais adiante em.
Dados
Esta seção fornece uma lista completa das propriedades de dados que você pode configurar.
Propriedade | Descrição |
---|---|
AllowFormula | Se deve ou não tratar os valores que começam com um sinal de igual (=) como fórmulas durante inserções e atualizações. |
EmptyValueMode | Indica se os valores vazios devem ser lidos como vazios ou nulos. |
NullValues | Uma lista separada por vírgulas que será substituída por nulos se forem encontrados no arquivo CSV. |
IgnoreCalcError | Indica se os erros ocorridos durante o cálculo devem ser ignorados. |
NullValueMode | Indica se as células vazias devem ser lidas como nulas ou vazias. |
HasCrossSheetReferences | Indica como as referências de folha cruzada são tratadas. |
Recalculate | Indica se todas as fórmulas devem ser recalculadas quando os dados são lidos. |
ShowEmptyRows | Indica se as linhas vazias devem ou não ser empurradas. |
TypeDetectionScheme | Determina como o provedor detecta os tipos de dados das colunas. |
UseFastInsert | Indica se deve usar o fastInsert ao executar Instrução de Inserção. |
SkipTop | Ignora o número de linhas especificadas a partir do topo. |
PermitirFórmula
Se deve ou não tratar os valores que começam com um sinal de igual (=) como fórmulas durante inserções e atualizações.
Tipo de Dados
bool
Valor Padrão
true
Observações
Defina esse valor como true para tratar os valores que começam com um sinal de igual (=) como fórmulas em inserções e atualizações. Defina o valor como false para tratar todos os valores usados em inserções e atualizações como strings.
EmptyValueMode
Indica se os valores vazios devem ser lidos como vazios ou nulos.
Valores Possíveis
ReadAsEmpty
, ReadAsNull
Tipo de Dados
string
Valor Padrão
"ReadAsEmpty"
Observações
Os valores possíveis são ReadAsEmpty e ReadAsNull. Um valor vazio é uma célula que contém uma string vazia (por exemplo, =""), que é diferente de uma célula que não foi definida e, portanto, contém uma string nula.
Valores Nulos
Uma lista separada por vírgulas que será substituída por nulos se forem encontrados no arquivo CSV.
Tipo de Dados
string
Valor Padrão
""
Observações
Uma lista separada por vírgulas que será substituída por nulos se forem encontrados no arquivo CSV. Exemplo: "NaN,\N,N/A". Se algum dos valores especificados for encontrado em uma linha CSV, ele será enviado como nulo.
IgnoreCalcError
Indica se os erros ocorridos durante o cálculo devem ser ignorados.
Tipo de Dados
bool
Valor Padrão
false
Observações
O padrão IgnoreCalcError é falso. Se IgnoreCalcError for definido como true, o provedor ignorará quaisquer erros que ocorram devido ao cálculo da fórmula. Se isso acontecer, o resultado da fórmula pode não ser confiável, mas outros dados serão precisos.
NullValueMode
Indica se as células vazias devem ser lidas como nulas ou vazias.
Valores Possíveis
ReadAsNull
, ReadAsEmpty
Tipo de Dados
string
Valor Padrão
"ReadAsNull"
Observações
NullValueMode controla como as células vazias do Excel são modeladas. Uma célula vazia é uma célula que não foi definida e, portanto, contém uma string nula. Se NullValueMode for definido como ReadAsNull, NULL será relatado para uma célula vazia; se NullValueMode for definido como ReadAsEmpty, uma string vazia será relatada para uma célula vazia.
TemReferênciasCrossSheet
Indica como as referências de folha cruzada são tratadas.
Tipo de Dados
bool
Valor Padrão
false
Observações
HasCrossSheetReferences controla como as referências de folha cruzada são tratadas. Se houver referências entre planilhas, alterações em uma planilha podem fazer com que algumas outras fórmulas em outras planilhas sejam recalculadas. Se HasCrossSheetReferences for definido como true, todas as planilhas na pasta de trabalho serão carregadas na memória e as referências de planilha cruzada serão tratadas. No entanto, definir a propriedade como true pode diminuir o desempenho porque todas as planilhas serão lidas do arquivo do Excel.
Esse valor deve ser definido como true se você planeja fazer atualizações na planilha. Quando esta opção está desativada, o conector gera arquivos maiores porque não pode reutilizar dados compartilhados em várias planilhas. No entanto, desabilitar essa opção permite que o conector reutilize dados em várias planilhas e gere arquivos menores.
Recalcular
Indica se todas as fórmulas devem ser recalculadas quando os dados são lidos.
Tipo de Dados
bool
Valor Padrão
true
Observações
Quando as células em uma planilha do Excel são modificadas, as células da fórmula mudam seu valor. Se Recalcular for definido como verdadeiro, o provedor detectará as células alteradas e recalculará as fórmulas. Esses novos resultados são então atualizados de volta na planilha do Excel para que um novo cálculo não seja necessário.
Mostrar Linhas Vazias
Indica se as linhas vazias devem ou não ser empurradas.
Tipo de Dados
bool
Valor Padrão
false
Observações
Se verdadeiro, as linhas vazias serão enviadas na saída.
TipoDetecçãoEsquema
Determina como o provedor detecta os tipos de dados das colunas.
Valores Possíveis
None
, RowScan
, ColumnFormat
Tipo de Dados
string
Valor Padrão
"ColumnFormat"
Observações
Propriedade | Descrição |
---|---|
None | Contexto TypeDetectionScheme para None retornará todas as colunas como tipo string. |
RowScan | Contexto TypeDetectionScheme para RowScan varrerá linhas para determinar heuristicamente o tipo de dados. A RowScanDepth determina o número de linhas a serem verificadas. |
ColumnFormat | Contexto TypeDetectionScheme para ColumnFormat informará o tipo de dados com base no formato da célula (Número, Moeda, Data, etc.) da coluna. |
UseFastInsert
Indica se deve usar o fastInsert ao executar Instrução de Inserção.
Tipo de Dados
bool
Valor Padrão
false
Observações
O FastInsert tem melhor desempenho do que o insert comum. No entanto, o FastInsert não suportava a instrução Insert com o ROWID especificado e salvaria os dados de inserção no arquivo após executar a instrução Insert.
SkipTop
Ignora o número de linhas especificadas a partir do topo.
Tipo de Dados
int
Valor Padrão
0
Observações
Ignora o número de linhas especificadas a partir do topo.
OAuth
Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.
Propriedade | Descrição |
---|---|
InitiateOAuth | Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar. |
OAuthVersion | A versão do OAuth que está sendo usada. |
OAuthClientId | O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth. |
OAuthClientSecret | O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth. |
OAuthAccessToken | O token de acesso para conexão usando OAuth. |
OAuthAccessTokenSecret | O segredo do token de acesso OAuth para conexão usando OAuth. |
CallbackURL | O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo. |
OAuthGrantType | O tipo de concessão para o fluxo OAuth. |
OAuthPasswordGrantMode | Como passar ID e Segredo do Cliente com OAuthGrantType definido como Senha. |
OAuthIncludeCallbackURL | Se o URL de retorno de chamada deve ser incluído em uma solicitação de token de acesso. |
OAuthAuthorizationURL | A URL de autorização para o serviço OAuth. |
OAuthAccessTokenURL | A URL da qual recuperar o token de acesso OAuth. |
OAuthRefreshTokenURL | A URL a partir da qual atualizar o token OAuth. |
OAuthRequestTokenURL | A URL que o serviço fornece para recuperar tokens de solicitação. Isso é necessário no OAuth 1.0. |
OAuthVerifier | O código do verificador retornado da URL de autorização OAuth. |
AuthToken | O token de autenticação usado para solicitar e obter o token de acesso OAuth. |
AuthKey | O segredo de autenticação usado para solicitar e obter o token de acesso OAuth. |
OAuthParams | Uma lista separada por vírgulas de outros parâmetros a serem enviados na solicitação para o token de acesso OAuth no formato paramname=value. |
OAuthRefreshToken | O token de atualização OAuth para o token de acesso OAuth correspondente. |
OAuthExpiresIn | O tempo de vida em segundos do OAuth AccessToken. |
OAuthTokenTimestamp | O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado. |
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:
OFF
: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.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.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.
OAuthVersion
A versão do OAuth que está sendo usada.
Valores Possíveis
Disabled
, 1.0
, 2.0
Tipo de Dados
string
Valor Padrão
"Disabled"
Observações
A versão do OAuth que está sendo usada. As seguintes opções estão disponíveis: Desativado,1.0,2.0
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.
OAuthAccessTokenSecret
O segredo do token de acesso OAuth para conexão usando OAuth.
Tipo de Dados
string
Valor Padrão
""
Observações
O OAuthAccessTokenSecret
propriedade é usada para conectar e autenticar usando OAuth. O OAuthAccessTokenSecret
é recuperado do servidor OAuth como parte do processo de autenticação. É usado com o OAuthAccessToken e pode ser usado para várias solicitações até atingir o tempo limite.
URL de Retorno
O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
Tipo de Dados
string
Valor Padrão
""
Observações
Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthGrantType
O tipo de concessão para o fluxo OAuth.
Valores Possíveis
CODE
, CLIENT
, PASSWORD
Tipo de Dados
string
Valor Padrão
"CLIENT"
Observações
O tipo de concessão para o fluxo OAuth. As seguintes opções estão disponíveis: CÓDIGO, CLIENTE, SENHA
OAuthPasswordGrantMode
Como passar ID e Segredo do Cliente com OAuthGrantType definido como Senha.
Valores Possíveis
Post
, Basic
Tipo de Dados
string
Valor Padrão
"Post"
Observações
O OAuth RFC especifica dois métodos para passar o OAuthClientId e OAuthClientSecret ao usar a senha OAuthGrantType. O mais comumente usado é passá-los por meio de dados de postagem para o serviço. No entanto, alguns serviços podem exigir que você os passe pelo cabeçalho Authorize para serem usados na autorização BASIC. Altere esta propriedade para Básico para enviar os parâmetros como parte do cabeçalho Autorizar em vez dos dados de postagem.
OAuthIncludeCallbackURL
Se o URL de retorno de chamada deve ser incluído em uma solicitação de token de acesso.
Tipo de Dados
bool
Valor Padrão
true
Observações
O padrão é verdadeiro, pois os serviços OAuth em conformidade com os padrões ignorarão o parâmetro redirect_uri para tipos de concessão como CLIENT ou PASSWORD que não o exigem.
Essa opção só deve ser habilitada para serviços OAuth que relatam erros quando o redirect_uri é incluído.
OAuthAuthorizationURL
A URL de autorização para o serviço OAuth.
Tipo de Dados
string
Valor Padrão
""
Observações
A URL de autorização para o serviço OAuth. Nessa URL, o usuário efetua login no servidor e concede permissões ao aplicativo. No OAuth 1.0, se as permissões forem concedidas, o token de solicitação será autorizado.
OAuthAccessTokenURL
A URL da qual recuperar o token de acesso OAuth.
Tipo de Dados
string
Valor Padrão
""
Observações
A URL da qual recuperar o token de acesso OAuth. No OAuth 1.0, o token de solicitação autorizado é trocado pelo token de acesso nessa URL.
OAuthRefreshTokenURL
A URL a partir da qual atualizar o token OAuth.
Tipo de Dados
string
Valor Padrão
""
Observações
A URL a partir da qual atualizar o token OAuth. No OAuth 2.0, esta URL é onde o token de atualização é trocado por um novo token de acesso quando o antigo token de acesso expira.
OAuthRequestTokenURL
A URL que o serviço fornece para recuperar tokens de solicitação. Isso é necessário no OAuth 1.0.
Tipo de Dados
string
Valor Padrão
""
Observações
A URL que o serviço fornece para recuperar tokens de solicitação. Isso é necessário no OAuth 1.0. No OAuth 1.0, este é o URL onde o aplicativo solicita o token de solicitação.
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.
AuthToken
O token de autenticação usado para solicitar e obter o token de acesso OAuth.
Tipo de Dados
string
Valor Padrão
""
Observações
Essa propriedade é necessária apenas ao executar a autenticação headless no OAuth 1.0. Ele pode ser obtido do procedimento armazenado GetOAuthAuthorizationUrl.
Ele pode ser fornecido juntamente com a AuthKey no GetOAuthAccessToken procedimento armazenado* para obter o OAuthAccessToken.
Chave de Autenticação
O segredo de autenticação usado para solicitar e obter o token de acesso OAuth.
Tipo de Dados
string
Valor Padrão
""
Observações
Essa propriedade é necessária apenas ao executar a autenticação headless no OAuth 1.0. Ele pode ser obtido do procedimento armazenado GetOAuthAuthorizationUrl.
Ele pode ser fornecido juntamente com o AuthToken no GetOAuthAccessToken procedimento armazenado* para obter o OAuthAccessToken.
OAuthParams
Uma lista separada por vírgulas de outros parâmetros a serem enviados na solicitação para o token de acesso OAuth no formato paramname=value.
Tipo de Dados
string
Valor Padrão
""
Observações
Uma lista separada por vírgulas de outros parâmetros a serem enviados na solicitação para o token de acesso OAuth no formato paramname=value.
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.
Propriedade | Descrição |
---|---|
OAuthJWTCert | A loja de certificados JWT. |
OAuthJWTCertType | O tipo de armazenamento de chaves que contém o certificado JWT. |
OAuthJWTCertPassword | A senha para o certificado OAuth JWT. |
OAuthJWTCertSubject | O assunto do certificado OAuth JWT. |
OAuthJWTIssuer | O emissor do Java Web Token. |
OAuthJWTSubject | O assunto do usuário para o qual o aplicativo está solicitando acesso delegado. |
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:
Propriedade | Descrição |
---|---|
MY | Um armazenamento de certificados que contém certificados pessoais com suas chaves privadas associadas. |
CA | Certificados de autoridade certificadora. |
ROOT | Certificados raiz. |
SPC | Certificados de editor de software. |
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:
Propriedade | Descrição |
---|---|
USER | Para Windows, isso especifica que o armazenamento de certificados é um armazenamento de certificados pertencente ao usuário atual. Nota: Este tipo de loja não está disponível em Java. |
MACHINE | Para Windows, isso especifica que o armazenamento de certificados é um armazenamento de máquina. Nota: este tipo de loja não está disponível em Java. |
PFXFILE | O armazenamento de certificados é o nome de um arquivo PFX (PKCS12) que contém certificados. |
PFXBLOB | O armazenamento de certificados é uma string (codificada em base 64) que representa um armazenamento de certificados no formato PFX (PKCS12). |
JKSFILE | O armazenamento de certificados é o nome de um arquivo de armazenamento de chaves Java (JKS) que contém certificados. Nota: este tipo de loja só está disponível em Java. |
JKSBLOB | O armazenamento de certificados é uma sequência (codificada em base 64) que representa um armazenamento de certificados no formato Java key store (JKS). Nota: este tipo de loja só está disponível em Java. |
PEMKEY_FILE | O armazenamento de certificados é o nome de um arquivo codificado por PEM que contém uma chave privada e um certificado opcional. |
PEMKEY_BLOB | O armazenamento de certificados é uma string (codificada em base64) que contém uma chave privada e um certificado opcional. |
PUBLIC_KEY_FILE | O armazenamento de certificados é o nome de um arquivo que contém um certificado de chave pública codificado por PEM ou DER. |
PUBLIC_KEY_BLOB | O armazenamento de certificados é uma string (codificada em base 64) que contém um certificado de chave pública codificado em PEM ou DER. |
SSHPUBLIC_KEY_FILE | O armazenamento de certificados é o nome de um arquivo que contém uma chave pública de estilo SSH. |
SSHPUBLIC_KEY_BLOB | O armazenamento de certificados é uma string (codificada em base 64) que contém uma chave pública de estilo SSH. |
P7BFILE | O armazenamento de certificados é o nome de um arquivo PKCS7 contendo certificados. |
PPKFILE | O armazenamento de certificados é o nome de um arquivo que contém um PPK (PuTTY Private Key). |
XMLFILE | O armazenamento de certificados é o nome de um arquivo que contém um certificado no formato XML. |
XMLBLOB | O armazenamento de certificados é uma string que contém um certificado no formato XML. |
GOOGLEJSON | O armazenamento de certificados é o nome de um arquivo JSON que contém as informações da conta de serviço. Válido apenas ao conectar-se a um serviço do Google. |
GOOGLEJSONBLOB | O armazenamento de certificados é uma string que contém o JSON da conta de serviço. Válido apenas ao conectar-se a um serviço do Google. |
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.
Campo | Significado |
---|---|
CN | Nome comum. Geralmente, é um nome de hospedar como www.server.com. |
O | Organização |
OU | Unidade Organizacional |
L | Localidade |
S | Estado |
C | País |
E | Endereço E-mail |
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 e-mail.
Kerberos
Esta seção fornece uma lista completa das propriedades do Kerberos que você pode configurar.
Propriedade | Descrição |
---|---|
KerberosKDC | O serviço Kerberos Key Distribution Center (KDC) usado para autenticar o usuário. |
KerberosRealm | O Kerberos Realm usado para autenticar o usuário. |
KerberosSPN | O nome principal do serviço (SPN) para o controlador de domínio Kerberos. |
KerberosKeytabFile | O arquivo Keytab contendo seus pares de principais Kerberos e chaves criptografadas. |
KerberosServiceRealm | A região Kerberos do serviço. |
KerberosServiceKDC | O Kerberos KDC do serviço. |
KerberosTicketCache | O caminho completo do arquivo para um arquivo de cache de credenciais do MIT Kerberos. |
KerberosKDCName
O serviço Kerberos Key Distribution Center (KDC) usado para autenticar o usuário.
Tipo de Dados
string
Valor Padrão
""
Observações
As propriedades Kerberos são usadas ao usar SPNEGO ou Autenticação do Windows. O conector solicitará tíquetes de sessão e chaves de sessão temporárias do serviço Kerberos KDC. O serviço Kerberos KDC é colocado convencionalmente com o controlador de domínio.
Se o Kerberos KDC não for especificado, o conector tentará detectar essas propriedades automaticamente nos seguintes locais:
KRB5 Config File (krb5.ini/krb5.conf):
Se a variável de ambiente KRB5_CONFIG estiver definida e o arquivo existir, o conector obterá o KDC do arquivo especificado. Caso contrário, ele tentará ler a partir do local padrão do MIT com base no sistema operacional: C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) ou /etc/krb5.conf (Linux)Java System Properties:
Usando as propriedades do sistema java.security.krb5.realm e java.security.krb5.kdc.Domain Name and Host:
O conector inferirá o Kerberos Realm e o Kerberos KDC do nome de domínio configurado e do hospedar como último recurso.
Observação: A autenticação do Windows é suportada apenas no JRE 1.6 e superior.
KerberosRealmName
O Kerberos Realm usado para autenticar o usuário.
Tipo de Dados
string
Valor Padrão
""
Observações
As propriedades Kerberos são usadas ao usar SPNEGO ou Autenticação do Windows. O Kerberos Realm é usado para autenticar o usuário com o Kerberos Key Distribution Service (KDC). O Kerberos Realm pode ser configurado por um administrador para ser qualquer string, mas convencionalmente é baseado no nome de domínio.
Se Kerberos Realm não for especificado, o conector tentará detectar essas propriedades automaticamente nos seguintes locais:
KRB5 Config File (krb5.ini/krb5.conf):
Se a variável de ambiente KRB5_CONFIG estiver definida e o arquivo existir, o conector obterá o domínio padrão do arquivo especificado. Caso contrário, ele tentará ler a partir do local padrão do MIT com base no sistema operacional: C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) ou /etc/krb5.conf (Linux)Java System Properties:
Usando as propriedades do sistema java.security.krb5.realm e java.security.krb5.kdc.Domain Name and Host:
O conector inferirá o Kerberos Realm e o Kerberos KDC do nome de domínio configurado pelo usuário e do hospedar como último recurso. Isso pode funcionar em alguns ambientes Windows.
Observação: A autenticação baseada em Kerberos é suportada apenas no JRE 1.6 e superior.
KerberosSPN
O nome principal do serviço (SPN) para o controlador de domínio Kerberos.
Tipo de Dados
string
Valor Padrão
""
Observações
Se o SPN no controlador de domínio Kerberos não for igual ao URL para o qual você está se autenticando, use esta propriedade para definir o SPN.
KerberosKeytabFile
O arquivo Keytab contendo seus pares de principais Kerberos e chaves criptografadas.
Tipo de Dados
string
Valor Padrão
""
Observações
O arquivo Keytab contendo seus pares de principais Kerberos e chaves criptografadas.
O arquivo Keytab contendo seus pares de principais Kerberos e chaves criptografadas.
KerberosServiceRealmName
A região Kerberos do serviço.
Tipo de Dados
string
Valor Padrão
""
Observações
O KerberosServiceRealm
é a especificação do domínio Kerberos do serviço ao usar a autenticação Kerberos entre domínios.
Na maioria dos casos, um único domínio e uma máquina KDC são usados para executar a autenticação Kerberos e essa propriedade não é necessária.
Essa propriedade está disponível para configurações complexas em que um domínio e uma máquina KDC diferentes são usados para obter um tíquete de autenticação (solicitação AS) e um tíquete de serviço (solicitação TGS).
KerberosServiceKDC
O Kerberos KDC do serviço.
Tipo de Dados
string
Valor Padrão
""
Observações
O KerberosServiceKDC
é usado para especificar o serviço Kerberos KDC ao usar a autenticação Kerberos cross-realm.
Na maioria dos casos, um único domínio e uma máquina KDC são usados para executar a autenticação Kerberos e essa propriedade não é necessária.
Essa propriedade está disponível para configurações complexas em que um domínio e uma máquina KDC diferentes são usados para obter um tíquete de autenticação (solicitação AS) e um tíquete de serviço (solicitação TGS).
KerberosTicketCache
O caminho de arquivo completo para um arquivo de cache de credenciais do MIT Kerberos.
Tipo de Dados
string
Valor Padrão
""
Observações
Esta propriedade pode ser configurada se você deseja usar um arquivo de cache de credencial que foi criado usando o MIT Kerberos Ticket Manager ou o comando kinit.
SSL
Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.
Propriedade | Descrição |
---|---|
SSLClientCert | O armazenamento de certificados de cliente TLS/SSL para autenticação de cliente SSL (SSL bidirecional). |
SSLClientCertType | O tipo de armazenamento de chaves que contém o certificado do cliente TLS/SSL. |
SSLClientCertPassword | A senha para o certificado de cliente TLS/SSL. |
SSLClientCertSubject | O assunto do certificado de cliente TLS/SSL. |
SSLMode | O mecanismo de autenticação a ser usado ao conectar-se ao servidor FTP ou FTPS. |
SSLServerCert | O certificado a ser aceito do servidor ao conectar usando TLS/SSL. |
SSLClientCert
O armazenamento de certificados de cliente TLS/SSL para autenticação de cliente SSL (SSL bidirecional).
Tipo de Dados
string
Valor Padrão
""
Observações
O nome do armazenamento de certificados para o certificado do cliente.
O SSLClientCertType campo especifica o tipo de armazenamento de certificado especificado por SSLClientCert
. Se o armazenamento estiver protegido por senha, especifique a senha em SSLClientCertPassword.
SSLClientCert
é usado em conjunto com o SSLClientCertSubject para especificar os certificados do cliente. Se SSLClientCert
tem um valor e SSLClientCertSubject for definido, uma pesquisa por um certificado será iniciada. Consulte SSLClientCertSubject Para maiores informações.
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:
Propriedade | Descrição |
---|---|
MY | Um armazenamento de certificados que contém certificados pessoais com suas chaves privadas associadas. |
CA | Certificados de autoridade certificadora. |
ROOT | Certificados raiz. |
SPC | Certificados de editor de software. |
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 (por exemplo, armazenamento de certificados PKCS12).
SSLClientCertType
O tipo de armazenamento de chaves que contém o certificado do cliente TLS/SSL.
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
Tipo de Dados
string
Valor Padrão
"USER"
Observações
Esta propriedade pode assumir um dos seguintes valores:
Propriedade | Descrição |
---|---|
USER - default | Para Windows, isso especifica que o armazenamento de certificados é um armazenamento de certificados pertencente ao usuário atual. Observe que esse tipo de armazenamento não está disponível em Java. |
MACHINE | Para Windows, isso especifica que o armazenamento de certificados é um armazenamento de máquina. Observe que esse tipo de armazenamento não está disponível em Java. |
PFXFILE | O armazenamento de certificados é o nome de um arquivo PFX (PKCS12) que contém certificados. |
PFXBLOB | O armazenamento de certificados é uma string (codificada em base 64) que representa um armazenamento de certificados no formato PFX (PKCS12). |
JKSFILE | O armazenamento de certificados é o nome de um arquivo de armazenamento de chaves Java (JKS) que contém certificados. Observe que esse tipo de armazenamento está disponível apenas em Java. |
JKSBLOB | O armazenamento de certificados é uma string (codificada em base 64) que representa um armazenamento de certificados no formato JKS. Observe que esse tipo de armazenamento está disponível apenas em Java. |
PEMKEY_FILE | O armazenamento de certificados é o nome de um arquivo codificado por PEM que contém uma chave privada e um certificado opcional. |
PEMKEY_BLOB | O armazenamento de certificados é uma string (codificada em base64) que contém uma chave privada e um certificado opcional. |
PUBLIC_KEY_FILE | O armazenamento de certificados é o nome de um arquivo que contém um certificado de chave pública codificado por PEM ou DER. |
PUBLIC_KEY_BLOB | O armazenamento de certificados é uma string (codificada em base 64) que contém um certificado de chave pública codificado em PEM ou DER. |
SSHPUBLIC_KEY_FILE | O armazenamento de certificados é o nome de um arquivo que contém uma chave pública de estilo SSH. |
SSHPUBLIC_KEY_BLOB | O armazenamento de certificados é uma string (codificada em base 64) que contém uma chave pública de estilo SSH. |
P7BFILE | O armazenamento de certificados é o nome de um arquivo PKCS7 contendo certificados. |
PPKFILE | O armazenamento de certificados é o nome de um arquivo que contém uma chave privada PuTTY (PPK). |
XMLFILE | O armazenamento de certificados é o nome de um arquivo que contém um certificado no formato XML. |
XMLBLOB | O armazenamento de certificados é uma string que contém um certificado no formato XML. |
SSLClientCertPassword
A senha para o certificado de cliente TLS/SSL.
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.
SSLClientCertSubject
O assunto do certificado de cliente TLS/SSL.
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@company.com". Os campos comuns e seus significados são mostrados abaixo.
Campo | Significado |
---|---|
CN | Nome comum. Geralmente, é um nome de hospedar como www.server.com. |
O | Organização |
OU | Unidade Organizacional |
L | Localidade |
S | Estado |
C | País |
E | Endereço E-mail |
Se um valor de campo contiver uma vírgula, ela deverá ser colocada entre aspas.
SSLMode
O mecanismo de autenticação a ser usado ao conectar-se ao servidor FTP ou FTPS.
Valores Possíveis
AUTOMATIC
, NONE
, IMPLICIT
, EXPLICIT
Tipo de Dados
string
Valor Padrão
"AUTOMATIC"
Observações
Se SSLMode
é definido como NONE, a autenticação de texto simples padrão é usada para efetuar login no servidor. Se SSLMode
for definido como IMPLICIT, a negociação SSL será iniciada imediatamente após o estabelecimento da conexão. Se SSLMode
for definido como EXPLICIT, o conector se conectará primeiro em texto sem formatação e, em seguida, iniciará explicitamente a negociação SSL por meio de um comando de protocolo, como STARTTLS. Se SSLMode
for definido como AUTOMATIC, se a porta remota for definida como a porta padrão de texto sem formatação do protocolo (quando aplicável), o componente se comportará da mesma forma que SSLMode
é definido como EXPLÍCITO. Em todos os outros casos, a negociação SSL será IMPLICITA.
- AUTOMÁTICO
- NENHUM
- IMPLÍCITO
- EXPLÍCITO
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:
Descrição | Exemplo |
---|---|
Um certificado PEM completo (exemplo abreviado para concisão) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
Um caminho para um arquivo local contendo o certificado | C:\cert.cer |
A chave pública (exemplo abreviado para concisão) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
O Thumbprint MD5 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) | ecadbdda5a1529c58a1e9e09828d70e4 |
A impressão digital SHA1 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
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.
SSH
Esta seção fornece uma lista completa de propriedades SSH que você pode configurar.
Propriedade | Descrição |
---|---|
SSHAuthMode | O método de autenticação a ser usado para fazer logon em um servidor SFTP. |
SSHClientCert | Um certificado a ser usado para autenticar o usuário. |
SSHClientCertPassword | A senha do certificado SSHClientCert, se houver. |
SSHClientCertType | O tipo de certificado SSHClientCert. |
SSHAuthMode
O método de autenticação a ser usado para fazer logon em um servidor SFTP.
Valores Possíveis
None
, Password
, Public_Key
Tipo de Dados
string
Valor Padrão
"Password"
Observações
- Nenhum: Nenhuma autenticação será realizada. O atual Usuário é ignorado e a conexão será registrada como anônima.
- Senha: O conector usará os valores de Usuário e senha para autenticar o usuário.
- Public_Key: O conector usará os valores de User e SSHClientCert para autenticar o usuário. SSHClientCert deve ter uma chave privada disponível para que este método de autenticação seja bem-sucedido.
SSHClientCert
Um certificado a ser usado para autenticar o usuário.
Tipo de Dados
string
Valor Padrão
""
Observações
Para usar a autenticação de chave pública, SSHClientCert
deve conter um certificado com uma chave privada válida. O valor da chave pública do certificado é enviado ao servidor junto com uma assinatura produzida usando a chave privada. O servidor verificará primeiro se os valores da chave pública correspondem ao que é conhecido pelo usuário e, em seguida, tentará usar esses valores para verificar a assinatura.
O SSHClientCertType campo especifica o tipo de armazenamento de certificado especificado por SSHClientCert
. Se o armazenamento estiver protegido por senha, especifique a senha em SSHClientCertPassword.
SSHClientCert
é usado em conjunto com o SSHClientCertSubject para especificar os certificados do cliente. Se SSHClientCert
tem um valor e SSHClientCertSubject for definido, uma pesquisa por um certificado será iniciada. Consulte o SSHClientCertSubject 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:
Propriedade | Descrição |
---|---|
MY | Um armazenamento de certificados que contém certificados pessoais com suas chaves privadas associadas. |
CA | Certificados de autoridade certificadora. |
ROOT | Certificados raiz. |
SPC | Certificados de editor de software. |
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).
SSHClientCertPassword
A senha do certificado SSHClientCert, se houver.
Tipo de Dados
string
Valor Padrão
""
Observações
Esta propriedade é usada apenas ao autenticar em servidores SFTP com SSHAuthMode definido como PublicKey e SSHClientCert definido como uma chave privada.
SSHClientCertType
O tipo de certificado SSHClientCert.
Valores Possíveis
USER
, MACHINE
, PFXFILE
, PFXBLOB
, JKSFILE
, JKSBLOB
, PEMKEY_FILE
, PEMKEY_BLOB
, PUBLIC_KEY_FILE
, PUBLIC_KEY_BLOB
, SSHPUBLIC_KEY_BLOB
, P7BFILE
, P7BBLOB
, SSHPUBLIC_KEY_FILE
, PPKFILE
, PPKBLOB
, XMLFILE
, XMLBLOB
Tipo de Dados
string
Valor Padrão
"PUBLIC_KEY_FILE"
Observações
O tipo de SSHClientCert certificado. Esta propriedade pode assumir um dos seguintes valores:
Propriedade | Descrição |
---|---|
USER | Para Windows, isso especifica que o armazenamento de certificados é um armazenamento de certificados pertencente ao usuário atual. Nota: este tipo de loja não está disponível em Java. |
MACHINE | Para Windows, isso especifica que o armazenamento de certificados é um armazenamento de máquina. Nota: este tipo de loja não está disponível em Java. |
PFXFILE | O armazenamento de certificados é o nome de um arquivo PFX (PKCS12) que contém certificados. |
PFXBLOB | O armazenamento de certificados é uma string (binária ou codificada em base 64) que representa um armazenamento de certificados no formato PFX (PKCS12). |
JKSFILE | O armazenamento de certificados é o nome de um arquivo Java Key Store (JKS) que contém certificados. Nota: este tipo de loja só está disponível em Java. |
JKSBLOB | O armazenamento de certificados é uma sequência (binária ou codificada em base 64) que representa um armazenamento de certificados no formato Java Key Store (JKS). Nota: este tipo de loja só está disponível em Java. |
PEMKEY_FILE | O armazenamento de certificados é o nome de um arquivo codificado por PEM que contém uma chave privada e um certificado opcional. |
PEMKEY_BLOB | O armazenamento de certificados é uma string (binária ou codificada em base 64) que contém uma chave privada e um certificado opcional. |
PUBLIC_KEY_FILE | O armazenamento de certificados é o nome de um arquivo que contém um certificado de chave pública codificado por PEM ou DER. |
PUBLIC_KEY_BLOB | O armazenamento de certificados é uma string (binária ou codificada em base 64) que contém um certificado de chave pública codificado por PEM ou DER. |
SSHPUBLIC_KEY_BLOB | O armazenamento de certificados é uma string (binária ou codificada em base 64) que contém uma chave pública de estilo SSH. |
P7BFILE | O armazenamento de certificados é o nome de um arquivo PKCS7 contendo certificados. |
P7BBLOB | O armazenamento de certificados é uma string (binária) que representa um armazenamento de certificados no formato PKCS7. |
SSHPUBLIC_KEY_FILE | O armazenamento de certificados é o nome de um arquivo que contém uma chave pública de estilo SSH. |
PPKFILE | O armazenamento de certificados é o nome de um arquivo que contém um PPK (PuTTY Private Key). |
PPKBLOB | O armazenamento de certificados é uma string (binária) que contém um PPK (PuTTY Private Key). |
XMLFILE | O armazenamento de certificados é o nome de um arquivo que contém um certificado no formato XML. |
XMLBLOB | O armazenamento de certificados é uma string que contém um certificado no formato XML. |
Esquema
Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.
Propriedade | Descrição |
---|---|
Location | Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados. |
BrowsableSchemas | Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC. |
Views | Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC. |
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%\\\Excel 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%\\ Excel Data Provider\Schema" com %APPDATA%
sendo definido para o diretório de configuração do usuário:
Plataforma | %APPDATA% |
---|---|
Windows | O valor da variável de ambiente APPDATA |
Mac | ~/Biblioteca/Suporte de aplicativos |
Linux | ~/.config |
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.
Diversos
Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.
Propriedade | Descrição |
---|---|
Charset | Especifica o conjunto de caracteres da sessão para codificação e decodificação de dados de caracteres transferidos de e para o arquivo Excel. O valor padrão é UTF-8. |
ClientCulture | Essa propriedade pode ser usada para especificar o formato dos dados (por exemplo, valores monetários) aceitos pelo aplicativo cliente. Essa propriedade pode ser usada quando o aplicativo cliente não oferece suporte às configurações de cultura da máquina. Por exemplo, o Microsoft Access requer 'en-US'. |
Culture | Essa configuração pode ser usada para especificar configurações de cultura que determinam como o provedor interpreta determinados tipos de dados que são passados para o provedor. Por exemplo, definir Culture='de-DE' produzirá formatos alemães mesmo em uma máquina americana. |
CustomHeaders | Outros cabeçalhos conforme determinado pelo usuário (opcional). |
CustomUrlParams | A string de consultar personalizada a ser incluída na solicitação. |
IncludeDropboxTeamResources | Indica se você deseja incluir arquivos e pastas da equipe do Dropbox. |
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. |
Other | Essas propriedades ocultas são usadas apenas em casos de uso específicos. |
PseudoColumns | Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela. |
RowScanDepth | O número máximo de linhas a serem verificadas para procurar as colunas disponíveis em uma tabela. |
Timeout | O valor em segundos até que o erro de timeout seja lançado, cancelando a operação. |
Conjunto de Caracteres
Especifica o conjunto de caracteres da sessão para codificação e decodificação de dados de caracteres transferidos de e para o arquivo Excel. O valor padrão é UTF-8.
Tipo de Dados
string
Valor Padrão
"UTF-8"
Observações
Especifica o conjunto de caracteres da sessão para codificação e decodificação de dados de caracteres transferidos de e para o arquivo Excel. O valor padrão é UTF-8.
Cultura do Cliente
Essa propriedade pode ser usada para especificar o formato dos dados (por exemplo, valores monetários) que são aceitos pelo aplicativo cliente. Essa propriedade pode ser usada quando o aplicativo cliente não oferece suporte às configurações de cultura da máquina. Por exemplo, o Microsoft Access requer 'en-US'.
Tipo de Dados
string
Valor Padrão
""
Observações
Esta opção afeta o formato da saída do conector. Para especificar o formato que define como a entrada deve ser interpretada, use a opção Cultura. Por padrão, o conector usa as configurações de localidade atuais da máquina para interpretar a entrada e formatar a saída.
Cultura
Essa configuração pode ser usada para especificar configurações de cultura que determinam como o provedor interpreta determinados tipos de dados que são passados para o provedor. Por exemplo, definir Culture='de-DE' produzirá formatos alemães mesmo em uma máquina americana.
Tipo de Dados
string
Valor Padrão
""
Observações
Esta propriedade afeta a entrada do conector. Para interpretar valores em um formato cultural diferente, use a propriedade Client Culture. Por padrão, o conector usa as configurações de localidade atuais da máquina para interpretar a entrada e formatar a saída.
CustomHeaders
Outros cabeçalhos conforme determinado pelo usuário (opcional).
Tipo de Dados
string
Valor Padrão
""
Observações
Essa propriedade pode ser definida como uma sequência de cabeçalhos a serem anexados aos cabeçalhos de solicitação HTTP criados a partir de outras propriedades, como ContentType, From e assim por diante.
Os cabeçalhos devem estar no formato "cabeçalho: valor" conforme descrito nas especificações do HTTP. As linhas de cabeçalho devem ser separadas pelos caracteres de retorno de carro e alimentação de linha (CRLF).
Use esta propriedade com cautela. Se esta propriedade contiver cabeçalhos inválidos, as solicitações HTTP poderão falhar.
Essa propriedade é útil para ajustar a funcionalidade do conector para integração com APIs especializadas ou fora do padrão.
CustomUrlParams
A string de consultar personalizada a ser incluída na solicitação.
Tipo de Dados
string
Valor Padrão
""
Observações
O CustomUrlParams
permite que você especifique parâmetros de string de consultar personalizados incluídos na solicitação HTTP. Os parâmetros devem ser codificados como uma string de consultar no formato field1=value1&field2=value2&field3=value3. Os valores na string de consultar devem ser codificados em URL.
IncludeDropboxTeamResources
Indica se você deseja incluir arquivos e pastas da equipe do Dropbox.
Tipo de Dados
bool
Valor Padrão
false
Observações
Para acessar as pastas e arquivos da equipe do Dropbox, defina esta propriedade de conexão como True.
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. Casos de uso de driver normal e funcionalidade não devem exigir essas propriedades.
Especifique várias propriedades em uma lista separada por ponto e vírgula.
Integração e Formatação
Propriedade | Descrição |
---|---|
DefaultColumnSize | Define o comprimento padrão dos campos de string quando a fonte de dados não fornece o comprimento da coluna nos metadados. O valor padrão é 2000. Voltar para o início |
ConvertDateTimeToGMT | Determina se os valores de data e hora devem ser convertidos em GMT, em vez da hora local da máquina. |
RecordToFile=filename | Registra a transferência de dados do soquete subjacente para o arquivo especificado. |
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, "*=*".
RowScanDepth
O número máximo de linhas a serem verificadas para procurar as colunas disponíveis em uma tabela.
Tipo de Dados
int
Valor Padrão
15
Observações
As colunas em uma tabela devem ser determinadas pela varredura das linhas da tabela. Esse valor determina o número máximo de linhas que serão verificadas.
Definir um valor alto pode diminuir o desempenho. Definir um valor baixo pode impedir que o tipo de dados seja determinado corretamente, especialmente quando houver dados nulos.
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.