Detalhes da Conexão On-microsoft Excel Online
Introdução
Versão do conector
Esta documentação é baseada na versão 21.0.8361 do conector.
Começando
Suporte à versão on-line do Excel
O conector modela planilhas e intervalos como tabelas bidirecionais que podem ser consultadas com SQL.
Estabelecendo uma Conexão
Conectando a uma Pasta de Trabalho
Você pode se conectar a uma pasta de trabalho fornecendo autenticação ao Excel Online e definindo as seguintes propriedades:
-
Workbook
: Defina como o nome ou ID da pasta de trabalho. Se você deseja visualizar uma lista de informações sobre as pastas de trabalho disponíveis, execute uma consultar na exibição Pastas de trabalho após a autenticação. -
Drive
: Embora opcional, o Drive restringirá ainda mais qual pasta de trabalho usar. Uma pasta de trabalho só pode ser recuperada fornecendo a ID da unidade e a ID da pasta de trabalho. SeDrive
não for especificado, o Jitterbit Connector for Excel Online tentará automaticamente procurar a unidade apropriada em segundo plano. -
UseSandbox
: Defina como verdadeiro se você estiver se conectando a uma pasta de trabalho em uma conta de área restrita. Caso contrário, deixe em branco para se conectar a uma conta de produção.
Autenticação no Excel Online
Existem dois métodos de autenticação disponíveis para conexão com a fonte de dados do Excel Online, o OAuth 2.0 (AzureAD) e os métodos de autenticação MSI.
Autenticar Usando Autenticação OAuth (azuread)
Para autenticar usando OAuth, você pode deixar as credenciais OAuth em branco para usar o aplicativo integrado do conector.
Como alternativa, você pode criar um aplicativo personalizado para obter o OAuthClientId
, OAuthClientSecret
para usar credenciais OAuth personalizadas. Além dessas propriedades, defina CallbackURL
. Consulte Usando autenticação OAuth Para maiores informações.
AuthScheme
: Defina paraAzureAD
.
Autenticação Usando a Entidade de Serviço do Azure
A Entidade de Serviço do Azure é um tipo de conexão que passa por OAuth. Defina seu AuthScheme
para AzureServicePrincipal
e consulte Usando a Autenticação Principal de Serviço do Azure para obter um guia de autenticação.
Autenticação Usando Autenticação MSI
Se você estiver executando o Excel Online em uma VM do Azure, poderá aproveitar as credenciais de identidade de serviço gerenciado (MSI) para se conectar:
AuthScheme
: Defina paraAzureMSI
.
As credenciais MSI serão obtidas automaticamente para autenticação.
Executando SQL para Dados da Planilha
Consulte o seguinte para executar o SQL de manipulação de dados para planilhas e intervalos:
- Selecionando Dados ExcelOnline
- Inserção de Dados ExcelOnline
- Atualizando Dados ExcelOnline
- Excluindo dados do ExcelOnline
- Usando Fórmulas
Consulte Modelo de dados para obter mais informações sobre como o conector modela planilhas e células como tabelas e colunas.
Usando Autenticação OAuth
OAuth requer que o usuário autenticado interaja com o Excel Online usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.
Credenciais Incorporadas
Consulte Credenciais incorporadas para se conectar com as credenciais incorporadas do conector e pule a criação de um aplicativo OAuth personalizado.
Credenciais Personalizadas
Em vez de se conectar com as credenciais incorporadas do conector, você pode registrar um aplicativo com Custom Credentials para obter o OAuthClientId
e OAuthClientSecret
.
Quando Criar um Aplicativo OAuth Personalizado
A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Excel Online e você pode se conectar com suas credenciais incorporadas. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem logon no endpoint OAuth do Excel Online para conceder permissões ao conector.
Criando um Aplicativo OAuth Personalizado
Consulte Criando um aplicativo OAuth personalizado para um procedimento.
Credenciais Incorporadas
Autenticar Usando as Credenciais OAuth Incorporadas
Autenticação de Desktop com o Aplicativo OAuth Integrado
Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário.
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.
Credenciais Personalizadas
Existem dois tipos de autenticação de aplicativo disponíveis: usando um segredo do cliente e usando um certificado. Você pode usar qualquer um deles dependendo da autenticação de aplicativo configurada.
Autenticação de Desktop com Seu Aplicativo OAuth
Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.
Obtenha um Token de Acesso OAuth
Você está pronto para se conectar após definir um dos grupos de propriedades de conexão abaixo, dependendo do tipo de autenticação.
Authenticating using a Client Secret
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.CallbackURL
: Defina isso para o URL de redirecionamento nas configurações do aplicativo.AuthScheme
: Defina isso como "AzureAD" nas configurações do aplicativo.InitiateOAuth
: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente oOAuthAccessToken
..
Authenticating using a Certificate
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
.CallbackURL
: Defina isso para o URL de redirecionamento nas configurações do aplicativo.AuthScheme
: Defina isso como "AzureAD" nas configurações do aplicativo.InitiateOAuth
: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente oOAuthAccessToken
..
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 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.
Máquinas Sem Cabeça
Usando OAuth em uma Máquina Sem Cabeça
Para criar fontes de dados do Excel Online em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa autenticar de outra máquina. A autenticação é um processo de duas etapas.
- Ao invés de instalar o conector em outra máquina, você pode seguir os passos abaixo para obter o
OAuthVerifier
valor. Ou você pode instalar o conector em outra máquina e transferir os valores de autenticação OAuth, depois de autenticar por meio do fluxo normal baseado em navegador. - Em seguida, você pode configurar o conector para atualizar automaticamente o token de acesso da máquina sem periféricos.
Você pode seguir o fluxo de autenticação OAuth headless usando as credenciais OAuth incorporadas do conector ou usando as credenciais OAuth para seu aplicativo OAuth personalizado.
Usando as Credenciais para um Aplicativo OAuth Personalizado
Crie um aplicativo OAuth personalizado
Consulte Criando um aplicativo OAuth personalizado para um procedimento. Você pode seguir os procedimentos abaixo para autenticar e conectar-se aos dados.
Obtenha um código verificador
Na máquina sem periféricos, defina um dos seguintes grupos de propriedades, dependendo do tipo de autenticação:
Authenticating using a Client Secret
InitiateOAuth
: Defina como DESLIGADO.OAuthClientId
: Defina isso como o ID do aplicativo nas configurações do aplicativo.OAuthClientSecret
: Defina isso como o Segredo do aplicativo nas configurações do aplicativo.
Authenticating using a Certificate
InitiateOAuth
: Defina como DESLIGADO.OAuthClientId
: Defina isso como o ID do aplicativo 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
.
Você pode seguir as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier
propriedade de conexão.
- Chame o GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nas configurações do aplicativo.
- Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para a URL de retorno de chamada. A página da Web indicará que o site não pôde ser acessado.
- Inspecione o URL da página deste site e encontre o
code
valor. Ele estará presente na URL no formato code=XXXXXX (terminado com &, que denota o próximo parâmetro da URL) O valor após o "code=" é o código do verificador. - Salve o valor do código do verificador. Você definirá isso no
OAuthVerifier
propriedade de conexão.
Na máquina sem periféricos, defina um dos seguintes grupos de propriedades de conexão dependendo do tipo de autenticação para obter os valores de autenticação OAuth:
OAuthClientId
: Defina isso como a chave do consumidor nas configurações do aplicativo.OAuthClientSecret
: Defina isso como o segredo do consumidor nas configurações do aplicativo.OAuthVerifier
: Defina isso para o código do verificador.OAuthSettingsLocation
: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.InitiateOAuth
: Configure para ATUALIZAR.
Conecte-se aos dados
Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:
OAuthSettingsLocation
: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.InitiateOAuth
: Configure para ATUALIZAR.
Configurações de transferência OAuth
Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.
Em uma segunda máquina, instale o conector e conecte-se a um dos seguintes grupos de propriedades, dependendo do tipo de autenticação:
Authenticating using a Client Secret
OAuthSettingsLocation
: Defina isso como um arquivo de texto gravável.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.CallbackURL
: Defina isso para o URL de retorno de chamada nas configurações do aplicativo.
Authenticating using a Certificate
OAuthSettingsLocation
: Defina isso como um arquivo de texto gravável.InitiateOAuth
: Defina como GETANDREFRESH.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
.CallbackURL
: Defina isso para o URL de retorno de chamada nas configurações do aplicativo.
Teste a conexão para autenticar. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation
. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:
InitiateOAuth
: Configure para ATUALIZAR.OAuthSettingsLocation
: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.
Criando um Aplicativo OAuth Personalizado
Quando Criar um Aplicativo OAuth Personalizado
A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Excel Online e você pode se conectar com suas credenciais incorporadas.
Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem logon no endpoint OAuth do Excel Online para conceder permissões ao conector.
Siga as etapas abaixo para criar um aplicativo OAuth personalizado e obter as propriedades de conexão em um fluxo de autenticação OAuth específico.
Etapas para Criar um Aplicativo OAuth Personalizado
Siga as etapas abaixo para obter os valores OAuth para seu aplicativo, o OAuthClientId
e OAuthClientSecret
.
- Faça login em
https://portal.azure.com
. - No painel de navegação à esquerda, selecione Azure Active Directory, em seguida, Registros de aplicativos e clique no botão Novo registro.
- Insira um nome de aplicativo e defina o botão de opção para a configuração de locatário desejada. Ao criar um aplicativo OAuth personalizado no Azure Active Directory, você pode definir se o aplicativo é único ou multilocatário. Se você selecionar a opção padrão "Somente contas neste diretório organizacional", precisará definir o
AzureTenant
propriedade de conexão para a ID do locatário do Azure AD ao estabelecer uma conexão com o conector Jitterbit para Excel Online. Caso contrário, a tentativa de autenticação falhará com um erro. Se seu aplicativo for apenas para uso privado, "Somente contas neste diretório da organização" deve ser suficiente. Caso contrário, se você quiser distribuir seu aplicativo, escolha uma das opções multilocatário. - Em seguida, defina o URL de redirecionamento para algo como
http://localhost:33333
, o padrão do conector. Ou defina uma porta diferente de sua escolha e definaCallbackURL
para o URL de resposta exato que você definiu. - Defina o tipo de autenticação do aplicativo na seção Certificados e segredos. Existem dois tipos de autenticação disponíveis: usando um segredo do cliente e usando um certificado. O método de autenticação recomendado é por meio de um certificado, mas você também pode criar um segredo de aplicativo.
Option 1 - Upload a certificate
: Na seção Certificados e Segredos, selecione Carregar certificado e selecione o certificado para carregar de sua máquina local.Option 2 - Create a new application secret
: Na seção Certificates & Secrets, selecione New Client Secret para o aplicativo e selecione sua duração. Depois de salvar o segredo do cliente, o valor da chave é exibido. Copie este valor, pois ele é exibido apenas uma vez e é usado comoOAuthClientSecret
.
- Selecione Permissões de API e clique em Adicionar. Se você planeja que seu aplicativo se conecte sem um contexto de usuário, selecione as Permissões do aplicativo (
OAuthGrantType
= CLIENTE). Caso contrário, ao selecionar permissões, use as permissões delegadas. - Adicione as seguintes permissões de aplicativo: Sites.Read.All, Files.Read, Files.Read.All, Files.Read.Selected, Files.ReadWrite, Files.ReadWrite.All, Files.ReadWrite.AppFolder, Files.ReadWrite. Selecionado e offline_access.
- Salve suas alterações.
- Se você optou por usar permissões que exigem consentimento do administrador (como as Permissões do aplicativo), você pode concedê-las do locatário atual na página Permissões da API. Caso contrário, siga as etapas em Consentimento do administrador.
Consentimento do Administrador
O consentimento do administrador refere-se a quando o administrador de um locatário do Azure Active Directory concede permissões a um aplicativo que exige que um administrador consinta com o caso de uso. O aplicativo incorporado no Conector Jitterbit para Excel Online não contém permissões que exijam o consentimento do administrador. Portanto, essas informações se aplicam apenas a aplicativos personalizados.
Permissões de Consentimento do Administrador
Ao criar um novo aplicativo OAuth no Portal do Azure, você deve especificar quais permissões o aplicativo exigirá. Algumas permissões podem ser marcadas informando "Consentimento do administrador necessário". Por exemplo, todas as permissões de grupos exigem consentimento do administrador. Se seu aplicativo exigir consentimento do administrador, há algumas maneiras de fazer isso.
A maneira mais fácil de conceder consentimento de administrador é apenas fazer com que um administrador faça logon em portal.azure.com e navegue até o aplicativo que você criou em Registros de aplicativos. Em Permissões da API, haverá um botão para Conceder consentimento. Você pode consentir aqui para que seu aplicativo tenha permissões no locatário sob o qual foi criado.
Se sua organização tiver vários locatários ou o aplicativo precisar receber permissões para outros locatários fora de sua organização, o GetAdminConsentURL pode ser usado para gerar o URL de autorização do administrador. Ao contrário do GetOAuthAuthorizationURL, não haverá nenhuma informação importante retornada desse endpoint. Se conceder acesso, ele simplesmente retornará um booleano indicando que as permissões foram concedidas.
Depois que um administrador concede o consentimento, a autenticação pode ser realizada normalmente.
Credenciais do Cliente
As credenciais do cliente referem-se a um fluxo no OAuth em que não ocorre nenhuma autenticação direta do usuário. Em vez disso, as credenciais são criadas apenas para o próprio aplicativo. Todas as tarefas executadas pelo aplicativo são realizadas sem um contexto de usuário padrão. Isso torna o fluxo de autenticação um pouco diferente do padrão.
Fluxo OAuth do Cliente
Todas as permissões relacionadas ao fluxo de oauth do cliente exigem o consentimento do administrador. Isso significa que o aplicativo incorporado com o Jitterbit Connector for Excel Online não pode ser usado no fluxo oauth do cliente. Você deve criar seu próprio aplicativo OAuth para usar as credenciais do cliente. Consulte Criando um aplicativo OAuth personalizado para mais detalhes.
Em seu registro de aplicativo em portal.azure.com, navegue até API Permissions e selecione as permissões do Microsoft Graph. Existem dois conjuntos distintos de permissões - Permissões delegadas e de aplicativos. As permissões usadas durante a autenticação da credencial do cliente estão em Permissões do aplicativo. Selecione as permissões aplicáveis necessárias para sua integração.
Você está pronto para se conectar após definir um dos grupos de propriedades de conexão abaixo, dependendo do tipo de autenticação.
Authenticating using a Client Secret
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.OAuthClientSecret
: Defina isso como o segredo do cliente nas configurações do aplicativo.
Authenticating using a Certificate
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
.
A autenticação com as credenciais do cliente ocorrerá automaticamente como qualquer outra conexão, exceto que não haverá nenhuma janela aberta solicitando ao usuário. Como não há contexto do usuário, não há necessidade de um pop-up do navegador. As conexões ocorrerão e serão tratadas internamente.
Usando a Autenticação Principal de Serviço do Azure
A autenticação como Entidade de Serviço do Azure é tratada por meio do fluxo de Credenciais do Cliente OAuth e não envolve autenticação direta do usuário. Em vez disso, as credenciais são criadas apenas para o próprio aplicativo. Todas as tarefas executadas pelo aplicativo são feitas sem um contexto de usuário padrão, mas com base nas funções atribuídas. O acesso do aplicativo aos recursos é controlado por meio das permissões das funções atribuídas.
Credenciais Personalizadas
Você precisará registrar um aplicativo OAuth para obter os valores da propriedade OAuth antes da conexão com a fonte de dados do Excel Online. Você pode verificar as Credenciais personalizadas guia sobre como definir as propriedades OAuth.
Criando um Aplicativo OAuth Personalizado
Consulte Criando um aplicativo OAuth personalizado para um procedimento.
Criando um Aplicativo OAuth Personalizado
A criação de um aplicativo OAuth personalizado e uma entidade de serviço que pode acessar os recursos necessários é necessária ao autenticar usando uma entidade de serviço do Azure.
Siga as etapas abaixo para criar um aplicativo OAuth personalizado e obter as propriedades de conexão para a autenticação da Entidade de Serviço do Azure.
Etapas para Criar um Aplicativo OAuth Personalizado
Siga as etapas abaixo para obter os valores OAuth para seu aplicativo.
- Faça login em
<https://portal.azure.com>
. - No painel de navegação à esquerda, selecione Azure Active Directory, em seguida, Registros de aplicativos e clique no botão Novo registro.
- Insira um nome de aplicativo e defina o botão de opção para "Qualquer diretório do Azure AD - multilocatário". Em seguida, defina o URL de redirecionamento para algo como
http://localhost:33333
, o padrão do conector. - Copie o valor do ID do aplicativo (cliente) exibido na seção Visão geral após criar o aplicativo, pois esse valor é usado como
OAuthClientId
- Defina o tipo de autenticação do aplicativo na seção Certificados e segredos. Existem dois tipos de autenticação disponíveis: usando um segredo do cliente e usando um certificado. O método de autenticação recomendado é por meio de um certificado, mas você também pode criar um segredo de aplicativo.
Option 1 - Upload a certificate
: Na seção Certificados e Segredos, selecione Carregar certificado e selecione o certificado para carregar de sua máquina local.Option 2 - Create a new application secret
: Na seção Certificates & Secrets, selecione New Client Secret para o aplicativo e selecione sua duração. Depois de salvar o segredo do cliente, o valor da chave é exibido. Copie este valor, pois ele é exibido apenas uma vez e é usado comoOAuthClientSecret
.
- Na aba Autenticação, certifique-se de marcar a opção: Tokens de acesso (usados para fluxos implícitos).
- Abra a página Assinaturas pesquisando e selecionando o serviço Assinaturas na barra de pesquisa.
- Selecione a assinatura específica à qual atribuir o aplicativo, abra a seção Controle de acesso (IAM) e clique no botão Adicionar atribuição de papel.
- Selecione Proprietário como a papel a ser atribuída ao aplicativo OAuth criado.
Credenciais Personalizadas
Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.
Autenticação com Seu Aplicativo OAuth
Existem dois tipos de autenticação de aplicativo disponíveis: usando um segredo do cliente e usando um certificado. Você pode usar qualquer um deles dependendo da autenticação de aplicativo configurada.
Obtenha um Token de Acesso OAuth
Você está pronto para se conectar após definir um dos grupos de propriedades de conexão abaixo, dependendo do tipo de autenticação.
Authenticating using a Client Secret
AuthScheme
: Defina isso como "AzureServicePrincipal" nas configurações do aplicativo.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.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.
Authenticating using a Certificate
AuthScheme
: Defina isso como "AzureServicePrincipal" nas configurações do aplicativo.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.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
.
Selecionando Dados do ExcelOnline
As propriedades de conexão a seguir permitem que você execute consultas SELECT que correspondam à forma como sua planilha está organizada.
Selecionando Cabeçalhos de Colunas
Se sua planilha tiver cabeçalhos de coluna, você pode definir o Header
propriedade para usar nomes de coluna definidos em uma linha de cabeçalho. Então você pode consultar assim:
SELECT Id, Name, Item, Quantity, Amount FROM Test_xlsx_Sheet1 WHERE Amount = 50
A consultar acima assume que a primeira linha da planilha tem os nomes das colunas Id, Name, Quantity e Amount. A planilha pode ter mais colunas do que as selecionadas e elas podem estar em qualquer ordem.
Selecionando Colunas Alfabéticas
Se uma pasta de trabalho não tiver cabeçalhos ou se você quiser ignorá-los, defina o Header
propriedade para false. Neste caso, cada coluna é representada por nomes alfabéticos. Por exemplo:
SELECT A, B, C, D FROM Test_xlsx_Sheet1 WHERE D = 50
Selecionando Intervalos
Em vez de trabalhar com a planilha como uma única tabela, você pode trabalhar com intervalos como tabelas. Alguns exemplos: Em uma pasta de trabalho esparsa, você pode usar intervalos para selecionar dados sem as linhas vazias. Ou, em uma planilha que não esteja alinhada no canto superior esquerdo, você pode usar um intervalo para selecionar dados no meio da planilha.
Para selecionar um intervalo de dados na planilha, anexe o intervalo ao nome da tabela com o caractere #. Por exemplo, o seguinte comando irá selecionar o intervalo de células entre A1 e E5:
SELECT * FROM Test_xlsx_Sheet1#A1:E5
Para atribuir um nome de tabela a um intervalo e evitar especificar o intervalo repetidamente, consulte o Tables
propriedade.
Inserindo Dados ExcelOnline
Você pode executar instruções INSERT ao trabalhar com planilhas como tabelas. Você pode especificar os nomes das colunas detectados em uma linha de cabeçalho ou especificar os nomes das colunas em ordem alfabética no Excel Online. Você também pode configurar como o conector analisa os valores de entrada em formatos de célula do Excel Online.
Colocou o Header
propriedade para configurar os nomes das colunas. Definir ValueInputOption
para configurar a análise de entrada.
Observe que a inserção em intervalos não é suportada. Em vez disso, use inserções em lote ou tabelas temporárias.
Inserindo com Cabeçalhos
Quando o Header
for definida como true, você pode especificar as células em uma linha de cabeçalho como os nomes das colunas.
INSERT INTO Test_xlsx_Sheet1(Name, Amount) VALUES ('Test', 10)
Inserindo Sem Cabeçalhos
Quando o Header
a propriedade está definida como falsa, forneça os nomes das colunas em ordem alfabética.
INSERT INTO Test_xlsx_Sheet1(A, B) VALUES ('Test', 10)
Configurando a Análise de Entrada
Por padrão, o conector analisa todos os valores inseridos na instrução SQL da mesma forma como se você inserisse a entrada na interface do usuário do Excel Online. Por exemplo, strings podem ser convertidas em números, datas, etc.
Para desativar a análise dos valores de entrada, defina ValueInputOption
. Além disso, consulte Usando fórmulas para configurar a avaliação da fórmula.
Exemplo: Inserções em Massa Usando Tabelas Temporárias
Se estiver usando tabelas temporárias, elas devem ser definidas e inseridas dentro da mesma conexão. Fechar a conexão limpará todas as tabelas temporárias da memória.
Criando Tabelas Temporárias
Insira as linhas necessárias em uma tabela temporária. Em seguida, insira todas as linhas dessa tabela temporária na tabela real.
Exemplo de Código
Abaixo está o código completo para inserir 2 linhas em Test_xlsx_Sheet1:
Connection conn = DriverManager.getConnection("jdbc:excelonline:InitiateOAuth=GETANDREFRESH;");
Statement stat = conn.createStatement();
stat.executeUpdate("INSERT INTO [Test_xlsx_Sheet1#TEMP] (Column1, Column2) VALUES ('value1', 'value2')");
stat.executeUpdate("INSERT INTO [Test_xlsx_Sheet1#TEMP] (Column1, Column2) VALUES ('value3', 'value4')");
stat.executeUpdate("INSERT INTO [Test_xlsx_Sheet1] (Column1, Column2) SELECT Column1, Column2 FROM [Test_xlsx_Sheet1#TEMP]");
stat.close();
Atualizando Dados do ExcelOnline
Nas instruções UPDATE, você pode especificar os nomes das colunas detectados em uma linha de cabeçalho ou especificar os nomes das colunas em ordem alfabética no Excel Online. Você também pode configurar como o conector analisa os valores de entrada em formatos de célula do Excel Online.
Colocou o Header
propriedade para configurar os nomes das colunas. A chave primária é o número da linha; especifique a chave primária com a coluna ID. Definir ValueInputOption
para configurar a análise de entrada.
Atualizando com Cabeçalhos
Quando o Header
for definida como true, você atualizará as colunas especificando os nomes das colunas detectadas.
UPDATE Customers SET Col1='value' WHERE Id=7
Atualizando Sem Cabeçalhos
Quando o Header
for definido como falso, forneça os nomes das colunas em ordem alfabética:
UPDATE Customers SET H='value' WHERE Id=7
Atualizando Intervalos
Defina as colunas correspondentes ao intervalo e especifique o número da linha como o ID:
UPDATE [Clientes#A15:C15] SET A='Ana Trujilo', B='Northwind, Inc.', C='100,000' WHERE Id='15'
Configurando a Análise de Entrada
Por padrão, o conector analisa todos os valores inseridos na instrução SQL da mesma forma como se você inserisse a entrada na interface do usuário do Excel Online. Por exemplo, strings podem ser convertidas em números, datas, etc.
Para desativar a análise dos valores de entrada, defina ValueInputOption
. Além disso, consulte Usando fórmulas para configurar a avaliação da fórmula.
Excluindo Dados do ExcelOnline
Ao excluir uma linha inteira de dados, você precisará atualizar os dados da tabela. Isso ocorre porque os IDs são atribuídos com base na linha. Por exemplo, se houver cinco linhas, com IDs de 1 a 5, e você excluir a linha 3, a linha 4 se tornará 3 e a 5 se tornará 4.
Usando Fórmulas
Defina as seguintes propriedades para configurar a avaliação da fórmula ao executar as instruções SELECT, INSERT e UPDATE.
Selecionando Fórmulas
O conector pode retornar o resultado da fórmula ou a própria fórmula; configure esse comportamento com o ValueRenderOption
propriedade de conexão.
Inserindo e Atualizando Fórmulas
Definir AllowFormula
para true para inserir fórmulas (o padrão). Caso contrário, todos os valores usados em inserções e atualizações são inseridos como strings literais.
Por exemplo, com AllowFormula
definido como verdadeiro, 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)')
Nota: Se AllowFormula
for definido como true, todas as colunas contendo uma fórmula serão expostas como tipo String independentemente do conjunto TypeDetectionScheme
.
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.
Características Avançadas
Esta seção detalha uma seleção de recursos avançados do conector do Excel Online.
Visualizações definidas pelo usuário
O conector permite definir tabelas virtuais, denominadas visualizaçõ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 Online 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 Test_xlsx_Sheet1 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 bem mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.
Configuração SSL
Personalizando a Configuração SSL
Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.
Para especificar outro certificado, consulte o SSLServerCert
propriedade para os formatos disponíveis para fazê-lo.
Modelo de Dados
Pastas de trabalho como tabelas
O conector modela as planilhas e intervalos em suas pastas de trabalho como tabelas bidirecionais. Quando você se conecta, o conector recupera os metadados do Excel Online e reflete todas as alterações nos esquemas da tabela.
Consulte a seção Introdução para ver os inícios rápidos da execução do SQL nas tabelas. Esta seção fornece detalhes adicionais sobre o comportamento do conector.
Mesas
Esta seção fornece mais detalhes sobre como o conector modela as Tabelas. Consulte Colunas para obter detalhes sobre a descoberta de coluna.
Procedimentos armazenados
NOTE:
Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.
Além de trabalhar com os dados na pasta de trabalho, você pode usar os procedimentos armazenados* para acessar a funcionalidade na API do Excel Online que não é modelada como instruções SELECT, INSERT, UPDATE ou DELETE; por exemplo, Adicionar planilha procedimento armazenado.
Tabelas do sistema
Consulte as Tabelas do sistema para acessar os metadados do conector disponíveis, incluindo informações de esquema.
Melhores Práticas
1) Se você tiver muitas pastas de trabalho ou planilhas em sua conta, pode levar muito tempo para recuperar inicialmente todos os dados. Você pode encurtar esse tempo adicionando o Workbook
propriedade de conexão para sua string de conexão.
2) Se você estiver executando uma operação SELECT após INSERT ou BATCH INSERT, certifique-se de esperar de 3 a 5 segundos antes de executá-la. A API leva alguns segundos para registrar todos os dados que você está adicionando ao banco de dados, portanto, é necessário esperar para evitar resultados parciais.
Tabelas
O conector permite que você represente uma planilha voltada para cima à esquerda ou um intervalo especificado pelo usuário como uma tabela de banco de dados.
Planilhas Orientadas para Cima à Esquerda
Você pode usar o conector para começar a trabalhar imediatamente com planilhas voltadas para cima à esquerda:
- O nome da tabela para uma planilha com orientação superior esquerda é o nome da planilha.
- Por padrão o conector retornará todas as linhas até a primeira linha vazia. Nota: uma linha vazia entre os dados impedirá que mais dados sejam retornados.
- A primeira linha de dados na planilha pode conter os nomes das colunas. Consulte Colunas Para maiores informações.
Intervalos Especificados pelo Usuário
A notação de intervalo está disponível apenas em uma instrução SELECT ou UPDATE. Intervalos não são suportados para comandos DELETE e INSERT.
Você pode executar os comandos SELECT ou UPDATE em um determinado intervalo com uma referência no seguinte formato: WORKSHEET#RANGE. Você também pode definir o Tables
propriedade para atribuir um nome de tabela a um intervalo.
Por exemplo, o seguinte comando irá selecionar o intervalo de células entre A1 e E5:
SELECT * FROM Test_xlsx_Sheet1#A1:E5
Acessando Documentos Compartilhados Como uma Tabela de Banco de Dados
Você pode usar a propriedade de conexão ShowSharedDocuments
para listar pastas de trabalho do Excel compartilhadas como tabelas de banco de dados. As tabelas serão listadas ao lado das pastas de trabalho do usuário.
Executando SQL para Dados da Planilha
Consulte o seguinte para executar o SQL de manipulação de dados para planilhas e intervalos:
- Selecionando Dados ExcelOnline
- Inserção de Dados ExcelOnline
- Atualizando Dados ExcelOnline
- Excluindo dados do ExcelOnline
- Usando Fórmulas
Colunas
Quando você se conecta, o conector descobre as colunas disponíveis e reflete as alterações no Excel Online e as alterações de configuração feitas com as seguintes propriedades de conexão. Consulte as seções a seguir para configurar os aspectos da descoberta de colunas específicos do Excel Online.
Configurando a Detecção de Nome de Coluna
Você pode definir Header
para detectar nomes de coluna em uma linha de cabeçalho ou você pode referenciar colunas em ordem alfabética.
Cabeçalho=Verdadeiro (padrão)
Abaixo estão mais detalhes sobre como o conector detecta nomes de coluna de uma linha de cabeçalho quando Header
é definido como verdadeiro.
- O conector determina as colunas da primeira linha da planilha. Se nenhum valor for fornecido para a primeira linha da planilha, o conector criará nomes de colunas exclusivos e em ordem alfabética que estarão disponíveis somente dentro do escopo dessa solicitação.
- Os cabeçalhos não devem conter caracteres especiais.
- Devido a uma limitação da API do Excel Online, todos os cabeçalhos de coluna não devem estar vazios.
Cabeçalho=Falso
Quando Header
for definido como falso, os nomes das colunas em ordem alfabética serão atribuídos dinamicamente.
Chave Primária
O conector informa o número da linha como a chave primária. A coluna de ID para cada linha representa o número da linha na parte superior da planilha.
Por exemplo, se você especificar um intervalo A3:E6, as linhas 3, 4, 5 e 6 serão retornadas.
Configurando a Análise do Valor da Coluna
O ValueRenderOption
e ValueInputOption
as propriedades da conexão podem ser usadas para configurar como o conector analisa os formatos de célula do Excel Online nas operações SELECT, INSERT e UPDATE.
Opções de Renderização de Valor para Operações SELECT
Colocou o ValueRenderOption
para configurar como o conector renderiza valores na saída de uma operação SELECT. As opções de renderização de valor disponíveis são as seguintes.
FormattedValue:
Os valores serão calculados e formatados na saída de acordo com a formatação da célula. A formatação é baseada na localidade da pasta de trabalho, não na localidade do usuário solicitante. Este é o padrãoValueRenderOption
.UnformattedValue:
Os valores serão calculados, mas não formatados na saída.Formula:
Os valores não serão calculados e, em vez disso, a saída incluirá as fórmulas. Por este motivo, toda coluna contendo uma fórmula será exposta como tipo String independentemente do conjuntoTypeDetectionScheme
.
Opções de Entrada de Valor para Operações INSERT e UPDATE
Colocou o ValueInputOption
para configurar como o conector analisa os valores que o usuário envia à origem do Excel Online para operações INSERT e UPDATE. As opções de entrada de valor disponíveis são as seguintes.
UserEntered:
Os valores serão analisados como se o usuário os tivesse digitado na IU. Os números permanecerão como números, mas as strings podem ser convertidas em números, datas etc., seguindo as mesmas regras aplicadas ao inserir texto em uma célula por meio da interface do usuário do Excel Online. Este é o padrãoValueInputOption
.Raw:
Os valores inseridos pelo usuário não serão analisados e serão armazenados como estão.
Configurando a Detecção de Tipo de Dados
Colocou o TypeDetectionScheme
para configurar o método de detecção de tipo de dados. Os esquemas de detecção de tipo disponíveis são os seguintes.
RowScan:
O conector varrerá as linhas para determinar heuristicamente o tipo de dados. O número de linhas que o conector varrerá pode ser determinado peloRowScanDepth
propriedade. Este é o padrãoTypeDetectionScheme
.ColumnFormat:
O conector informará o tipo de dados com base no formato da célula da coluna. Esta opção é aplicável apenas para 'UnformattedValue' e 'Formula'ValueRenderOption
-s. Se oValueRenderOption
for definido como 'FormattedValue', todas as colunas serão expostas como tipos String.None:
O conector retornará todas as colunas como o tipo string.
Visualizações
As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.
As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.
Conector Jitterbit para Exibições On-line do Excel
Nome | Descrição |
---|---|
Drives | Recupere uma lista de objetos de unidade. |
SharedDocuments | Recupere a lista de todos os documentos compartilhados. Nem todos os itens listados por esta exibição podem ser usados como uma pasta de trabalho, pois o driver filtrará arquivos não Excel. Consulte as exibições Pasta de trabalho e Planilhas para obter mais informações. |
SharePointSites | Recupere a lista de todos os sites em sua conta do SharePoint. |
Workbooks | Recupere uma lista de objetos de pasta de trabalho. |
Worksheets | Recupere uma lista de objetos de planilha. Se estiver listando planilhas em uma pasta de trabalho que não pertencem à unidade do usuário, especifique a ID da unidade usando a propriedade de conexão da unidade. |
Unidades
Recupere uma lista de objetos de unidade.
Selecione
A consultar de exemplo abaixo retornará as Unidades com o ID do SharePointSite especificado.
SELECT * FROM Drives WHERE SiteId='rssbus.onmicrosoft.com,988a3-343a-4064-996a-d2a30559f,4233d-dfcd-4910-b7f0-71f1dc03a'
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | O identificador exclusivo da unidade. | |
SiteId | String | SharePointSites.ID | A ID do site ou subsite do SharePoint ao qual esta unidade pertence. |
Name | String | O nome da unidade. | |
Description | String | A descrição da unidade. | |
CreatedByName | String | O nome de exibição da identidade. | |
CreatedById | String | Identificador exclusivo para a identidade. | |
CreatedDateTime | Datetime | Data e hora em que a unidade foi criada. | |
LastModifiedDateTime | Datetime | Data e hora em que a unidade foi modificada pela última vez. | |
WebUrl | String | URL que exibe o recurso no navegador. |
Documentos Compartilhados
Recupere a lista de todos os documentos compartilhados. Nem todos os itens listados por esta exibição podem ser usados como uma pasta de trabalho, pois o driver filtrará arquivos não Excel. Consulte as exibições Pasta de trabalho e Planilhas para obter mais informações.
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | A ID do documento compartilhado | |
SharedFileId | String | O ID do arquivo compartilhado do documento. | |
DriveId | String | A ID da unidade onde este documento reside. | |
Name | String | O nome do documento compartilhado. | |
Size | String | O tamanho do documento compartilhado. | |
SharedByUserName | String | O nome do usuário que compartilhou este documento. | |
SharedDateTime | String | A data e a hora em que este documento foi compartilhado. | |
CreatedDateTime | Datetime | A data e hora em que este documento foi criado. | |
LastModifiedDateTime | Datetime | A data e a hora em que este documento foi modificado pela última vez. | |
WebUrl | String | A URL da Web deste documento compartilhado. |
Sites do SharePoint
Recupere a lista de todos os sites em sua conta do SharePoint.
Informações Específicas da Tabela
Em contraste com quase todas as outras tabelas e exibições expostas, essa exibição não implementa nenhum endpoint do Microsoft Graph, mas sim o endpoint '/ consultar /search' da API REST do SharePoint. Por esse motivo, na maioria dos casos, você precisará especificar o SharepointURL
propriedade da conexão antes de iniciar o fluxo OAuth. Durante o fluxo de autorização, o conector obterá as permissões necessárias para utilizar seus recursos do SharePoint.
Selecione
O conector usará a API REST do SharePoint para processar as condições da cláusula WHERE criadas com quase todas as colunas, exceto Id, e somente para o operador EQUALS (=). O restante do filtro é executado no lado do cliente dentro do conector.
A consultar de exemplo abaixo retornará o Site do SharePoint com o SiteId e o WebId especificados.
SELECT SiteId, SiteName, Title, SiteDescription FROM SharePointSites WHERE SiteId='9839b8a3-343a-4064-996a-d2a300bc559f' AND WebId='427d733d-dfcd-4910-b7f0-771f1d4cc03a'
Restrições
Para consultar esta exibição usando o 'AzureAD' AuthScheme
com o 'CLIENTE' OAuthGrantType
, ou usando o 'AzureServicePrincipal' AuthScheme
, você deve especificar o OAuthJWTCert
ao invés de OAuthClientSecret
propriedade de conexão. A restrição é imposta pela API REST do SharePoint, que não aceita nenhum OAuthAccessToken
recuperado ao especificar um OAuthClientSecret
para os fluxos de autenticação mencionados.
Para obter um guia sobre como autenticar usando um certificado para AuthSchemes 'AzureAD' e 'AzureServicePrincipal', você pode verificar as Credenciais do cliente ou as Credenciais personalizadas seção.
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | O identificador completo do site. | |
SiteId | String | O identificador exclusivo do conjunto de sites. | |
WebId | String | O ID da Web do site. | |
SiteName | String | O nome do site. | |
Title | String | O título do site. | |
SiteDescription | String | A descrição do site. | |
Description | String | A descrição do item. | |
CreatedDateTime | Datetime | Data e hora em que o site foi criado. | |
LastModifiedDateTime | Datetime | Data e hora em que o site foi modificado pela última vez. | |
SPWebUrl | String | URL que exibe o recurso no navegador. | |
Author | String | O autor do site. | |
DocumentSignature | String | A assinatura do documento do site. | |
FileExtension | String | A extensão do arquivo do site. | |
SecondaryFileExtension | String | A extensão secundária do arquivo do site. | |
FileType | String | O tipo de arquivo do site. | |
DocId | Long | O identificador exclusivo do site em uma localização geográfica. | |
GeoLocationSource | String | A localização geográfica do site. | |
HitHighlightedSummary | String | O resumo elevado do site. | |
Importance | Long | A importância do local. | |
IsContainer | Bool | Especifica se o site é uma pasta. | |
IsDocument | Bool | Especifica se o site é um documento. | |
OriginalPath | String | O caminho original do site. | |
Path | String | O caminho do site atual. | |
Rank | Double | A classificação do site. | |
RenderTemplateId | String | O nome do modelo de renderização do controle do site. | |
SiteLogo | String | O URI do logotipo do site. | |
ViewsLifeTime | Long | A contagem total de visualizações desde que o site foi criado. | |
ViewsRecent | Long | A contagem total de visualizações do site nos últimos 14 dias. | |
WebTemplate | String | O templo da web a partir do qual o site é criado. |
Apostilas
Recupere uma lista de objetos de pasta de trabalho.
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | O identificador exclusivo do item no Drive. | |
Name | String | O nome do objeto. | |
CreatedByName | String | O nome de exibição da identidade. | |
CreatedById | String | Identificador exclusivo para a identidade. | |
CreatedDateTime | Datetime | Data e hora em que o item foi criado. | |
LastModifiedDateTime | Datetime | Data e hora em que o item foi modificado pela última vez. | |
Size | Long | Tamanho do item em bytes. | |
WebUrl | String | URL que exibe o recurso no navegador. |
Fichas de Trabalho
Recupere uma lista de objetos de planilha. Se estiver listando planilhas em uma pasta de trabalho que não pertencem à unidade do usuário, especifique a ID da unidade usando a propriedade de conexão da unidade.
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | Retorna um valor que identifica exclusivamente a planilha em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo mesmo quando a planilha é renomeada ou movida. | |
WorkbookId | String | Cadernos de trabalho.ID | A ID da pasta de trabalho que contém esta planilha. |
Name | String | O nome de exibição da planilha. | |
Position | Integer | A posição baseada em zero da planilha dentro da pasta de trabalho. | |
Visibility | String | A visibilidade da planilha. Os valores possíveis são: Visível, Oculto, MuitoOculto. |
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.
Jitterbit Connector For Excel Online Stored Procedures
Nome | Descrição |
---|---|
AddWorksheet | Adicione uma planilha a uma pasta de trabalho existente do Excel Online. |
CreateSchema | Cria um arquivo de esquema para a tabela ou exibição especificada. |
GetAdminConsentURL | Obtém a URL de consentimento do administrador que deve ser aberta separadamente por um administrador de um determinado domínio para conceder acesso ao seu aplicativo. Necessário apenas ao usar credenciais OAuth personalizadas. |
GetOAuthAccessToken | Obtém o token de acesso OAuth do Excel Online. |
GetOAuthAuthorizationURL | Obtém o URL de autorização do Excel Online. Acesse a URL retornada na saída em um navegador da Web. Isso solicita o token de acesso que pode ser usado como parte da cadeia de conexão para o Excel Online. |
RefreshOAuthAccessToken | Atualiza o token de acesso OAuth usado para autenticação com o Excel Online. |
Adicionar Planilha
Adicione uma planilha a uma pasta de trabalho existente do Excel Online.
Entrada
Nome | Tipo | Descrição |
---|---|---|
WorkbookId | String | A ID da pasta de trabalho. |
Title | String | O nome da planilha. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra se a operação foi bem-sucedida ou não. |
Criar Esquema
Cria um arquivo de esquema para a tabela ou exibição especificada.
Entrada
Nome | Tipo | Descrição |
---|---|---|
TableName | String | O nome da tabela ou visualização. |
FileName | String | O caminho completo do arquivo e o nome do esquema a ser gerado. Ex: 'C:\Usuários\Usuário\Desktop\SmartSheet\sheet.rsd' |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
Result | String | Retorna Sucesso ou Falha. |
GetAdminConsentURL
Obtém a URL de consentimento do administrador que deve ser aberta separadamente por um administrador de um determinado domínio para conceder acesso ao seu aplicativo. Necessário apenas ao usar credenciais OAuth personalizadas.
Entrada
Nome | Tipo | Descrição |
---|---|---|
CallbackUrl | String | A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Esse valor deve corresponder à URL de resposta nas configurações do aplicativo Azure AD. |
State | String | O mesmo valor para o estado que você enviou quando solicitou o código de autorização. |
Scope | String | Uma lista separada por espaços de escopos a serem solicitados ao administrador. Verifique a documentação da API do Microsoft Graph para obter uma lista de permissões disponíveis. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
URL | String | O URL de autorização, inserido em um navegador da Web pelo administrador para conceder permissões para seu aplicativo. |
GetOAuthAccessToken
Obtém o token de acesso OAuth do Excel Online.
Entrada
Nome | Tipo | Descrição |
---|---|---|
AuthMode | String | O tipo de modo de autenticação a ser usado. Os valores permitidos são APP, WEB. |
Verifier | String | O token do verificador retornado pelo Excel Online após usar a URL obtida com GetOAuthAuthorizationURL. Necessário apenas para Web AuthMode. |
CallbackUrl | String | A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. |
Scope | String | Uma lista separada por espaços de escopos a serem solicitados ao usuário quando OAuthGrantType='CODE'. Verifique a documentação da API do Microsoft Graph para obter uma lista de permissões disponíveis. Quando OAuthGrantType='CLIENT', um escopo de 'https://graph.microsoft.com/.default' é usado. '/.default' seleciona todas as permissões que seu aplicativo já possui. |
State | String | Um valor incluído na solicitação que também será retornado na resposta do token. Pode ser uma string de qualquer conteúdo que você desejar. |
Prompt | String | O padrão é 'select_account', que solicita que o usuário selecione a conta durante a autenticação. Defina como 'Nenhum', para nenhum prompt, 'login' para forçar o usuário a inserir suas credenciais ou 'consentimento' para acionar a caixa de diálogo de consentimento OAuth depois que o usuário entrar, solicitando que ele conceda permissões ao aplicativo. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
OAuthAccessToken | String | O token de autenticação retornado do Excel Online. |
OAuthRefreshToken | String | Um token que pode ser usado para obter um novo token de acesso. |
ExpiresIn | String | O tempo de vida restante do token de acesso em segundos. |
GetOAuthAuthorizationURL
Obtém o URL de autorização do Excel Online. Acesse a URL retornada na saída em um navegador da Web. Isso solicita o token de acesso que pode ser usado como parte da cadeia de conexão para o Excel Online.
Entrada
Nome | Tipo | Descrição |
---|---|---|
CallbackUrl | String | A URL para a qual o Excel Online retornará depois que o usuário autorizar seu aplicativo. |
Scope | String | Uma lista separada por espaços de escopos a serem solicitados ao usuário quando OAuthGrantType='CODE'. Verifique a documentação da API do Microsoft Graph para obter uma lista de permissões disponíveis. Quando OAuthGrantType='CLIENT', um escopo de 'https://graph.microsoft.com/.default' é usado. '/.default' seleciona todas as permissões que seu aplicativo já possui. |
Prompt | String | O padrão é 'select_account', que solicita que o usuário selecione a conta durante a autenticação. Defina como 'Nenhum', para nenhum prompt, 'login' para forçar o usuário a inserir suas credenciais ou 'consentimento' para acionar a caixa de diálogo de consentimento OAuth depois que o usuário entrar, solicitando que ele conceda permissões ao aplicativo. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
URL | String | A URL a ser inserida em um navegador da Web para obter o token do verificador e autorizar o provedor de dados. |
RefreshOAuthAccessToken
Atualiza o token de acesso OAuth usado para autenticação com o Excel Online.
Entrada
Nome | Tipo | Descrição |
---|---|---|
OAuthRefreshToken | String | O token antigo a ser atualizado. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
OAuthAccessToken | String | O token de autenticação retornado do Excel Online. |
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 o Excel Online:
- sys_catalogs: Lista os bancos de dados disponíveis.
- sys_schemas: Lista os esquemas disponíveis.
- sys_tables: Lista as tabelas e exibições disponíveis.
- sys_tablecolumns: Descreve as colunas das tabelas e exibições disponíveis.
- sys_procedures: Descreve os procedimentos armazenados disponíveis.
- sys_procedureparameters: Descreve procedimento armazenado* parâmetros.
- sys_keycolumns: Descreve as chaves primárias e estrangeiras.
- sys_indexes: Descreve os índices disponíveis.
Tabelas de Fonte de Dados
As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:
- sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
- sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.
Consultar Tabelas de Informações
A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados, incluindo operações em lote:
- sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.
Sys_catalogs
Lista os bancos de dados disponíveis.
A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:
SELECT * FROM sys_catalogs
Colunas
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 visualizaçã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 Test_xlsx_Sheet1:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Test_xlsx_Sheet1'
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 AddWorksheet:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='AddWorksheet' 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 Test_xlsx_Sheet1:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Test_xlsx_Sheet1'
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), agrupado (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:excelonline: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 ao Excel Online. |
UseSandbox | Um booleano que indica se você está usando uma conta de sandbox. O provedor faz solicitações ao ambiente de produção por padrão. |
Propriedade | Descrição |
---|---|
DefineTables | Atribua nomes de tabela a intervalos. |
Workbook | O nome ou ID da pasta de trabalho. |
Drive | O ID da unidade. |
IncludeSharePointSites | Se deve recuperar unidades para todos os sites do SharePoint ao consultar a exibição Unidades. Se 'verdadeiro', o provedor recuperará todos os IDs do site recursivamente e, para cada um deles, emitirá uma chamada separada para obter suas unidades. Portanto, esteja ciente de que definir essa propriedade como 'true' pode diminuir o desempenho da visualização Drives. |
Propriedade | Descriçã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 |
---|---|
InitiateOAuth | Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar. |
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. |
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. |
OAuthVerifier | O código do verificador retornado da URL de autorização OAuth. |
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 |
---|---|
SSLServerCert | O certificado a ser aceito do servidor ao conectar usando TLS/SSL. |
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 |
---|---|
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. |
Header | Indica se o provedor deve ou não detectar nomes de coluna da primeira linha. |
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. |
Pagesize | O número máximo de resultados a serem retornados por página do Excel Online quando UsePagination for True. |
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. |
SharepointURL | A URL base do seu Sharepoint Server. |
ShowSharedDocuments | Se deve ou não mostrar documentos compartilhados. |
Timeout | O valor em segundos até que o erro de timeout seja lançado, cancelando a operação. |
TypeDetectionScheme | Determina como determinar os tipos de dados das colunas. |
UsePagination | Se o Provedor ADO.NET para Excel Online deve ou não usar a paginação do lado do cliente. |
UseSimpleNames | Booleano determinando se nomes simples devem ser usados para tabelas e colunas. |
ValueInputOption | Determina como o provedor analisa os valores que o usuário envia ao Excel Online. |
ValueRenderOption | Determina como o provedor renderiza valores na saída. |
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 ao Excel Online. |
UseSandbox | Um booleano que indica se você está usando uma conta de sandbox. O provedor faz solicitações ao ambiente de produção por padrão. |
AuthScheme
O tipo de autenticação a ser usado ao conectar-se ao Excel Online.
Valores Possíveis
AzureAD
, AzureMSI
, AzureServicePrincipal
Tipo de Dados
string
Valor Padrão
"AzureAD"
Observações
- Microsoft Entra ID: defina isso para executar a autenticação OAuth do Azure Active Directory.
- AzureMSI: defina isso para obter automaticamente credenciais de identidade de serviço gerenciado ao executar em uma VM do Azure.
- AzureServicePrincipal: defina isso para autenticar como uma Entidade de Serviço do Azure.
UseSandbox
Um booleano que indica se você está usando uma conta de sandbox. O provedor faz solicitações ao ambiente de produção por padrão.
Tipo de Dados
bool
Valor Padrão
false
Observações
Se você estiver usando uma conta de produção, esta propriedade pode ser deixada em branco. Se você estiver usando uma conta de teste de desenvolvedor, defina como true.
Conexão
Esta seção fornece uma lista completa de propriedades de conexão que você pode configurar.
Propriedade | Descrição |
---|---|
DefineTables | Atribua nomes de tabela a intervalos. |
Workbook | O nome ou ID da pasta de trabalho. |
Drive | O ID da unidade. |
IncludeSharePointSites | Se as unidades devem ser recuperadas para todos os sites do SharePoint ao consultar a exibição Unidades. Se 'verdadeiro', o provedor recuperará todos os IDs do site recursivamente e, para cada um deles, emitirá uma chamada separada para obter suas unidades. Portanto, esteja ciente de que definir essa propriedade como 'true' pode diminuir o desempenho da visualização Drives. |
DefinirTabelas
Atribua nomes de tabela a intervalos.
Tipo de Dados
string
Valor Padrão
""
Observações
Esta propriedade é usada para definir os intervalos dentro de uma planilha que aparecerão como tabelas. O valor é uma lista separada por ponto-e-vírgula de pares nome-valor no formato [Table Name]=[Workbook Name]_[Worksheet Name]![Range]
.
Aqui está um exemplo de valor DefineTables:
DefineTables="Table1=Test_xlsx_Sheet1!A1:N25,Table2=Spreadsheet1_Sheet2!C3:M53,Table4=xIsPcLs2-bF3AavQcSLCfzs3kGc_Sheet4!C20:N60"
Depois de definir DefineTables
, você pode emitir consultas que fazem referência ao nome da tabela especificada. Observe que você também pode usar a sintaxe de intervalo diretamente na instrução SQL: anexe o intervalo ao nome da planilha com o caractere #.
Por exemplo, o seguinte comando irá selecionar o intervalo de células entre A1 e E5:
SELECT * FROM Test_xlsx_Sheet1#A1:E5
Pasta de Trabalho
O nome ou ID da pasta de trabalho.
Tipo de Dados
string
Valor Padrão
""
Observações
Especifica o nome ou ID da pasta de trabalho. Uma lista de todas as pastas de trabalho está disponível na exibição Pastas de trabalho.
Dirigir
O ID da unidade.
Tipo de Dados
string
Valor Padrão
""
Observações
Especifica o ID da unidade. Uma lista de todas as unidades está disponível na exibição Unidades.
IncludeSharePointSites
Se deve recuperar unidades para todos os sites do SharePoint ao consultar a exibição Unidades. Se 'verdadeiro', o provedor recuperará todos os IDs do site recursivamente e, para cada um deles, emitirá uma chamada separada para obter suas unidades. Portanto, esteja ciente de que definir essa propriedade como 'true' pode diminuir o desempenho da visualização Drives.
Tipo de Dados
bool
Valor Padrão
false
Observações
Esta propriedade afeta apenas as exibições de Drives.
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 |
---|---|
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. |
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.
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. |
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. |
CallbackURL | O URL de retorno de chamada OAuth para o qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno de chamada especificado nas configurações do aplicativo. |
OAuthGrantType | O tipo de concessão para o fluxo OAuth. |
OAuthVerifier | O código do verificador retornado da URL de autorização OAuth. |
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.
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.
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
OAuthVerifier
O código do verificador retornado da URL de autorização OAuth.
Tipo de Dados
string
Valor Padrão
""
Observações
O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas em que um navegador não pode ser iniciado, como sistemas headless.
Autenticação em Máquinas Sem Cabeça
Consulte para obter o OAuthVerifier
valor.
Defina OAuthSettingsLocation juntamente com OAuthVerifier
. Quando você conecta, o conector troca o OAuthVerifier
para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Definir InitiateOAuth para GETANDREFRESH automatizar a troca.
Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier
nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.
Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.
OAuthRefreshToken
O token de atualização OAuth para o token de acesso OAuth correspondente.
Tipo de Dados
string
Valor Padrão
""
Observações
O OAuthRefreshToken
a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.
OAuthExpiresIn
O tempo de vida em segundos do OAuth AccessToken.
Tipo de Dados
string
Valor Padrão
""
Observações
Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.
OAuthTokenTimestamp
O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.
Tipo de Dados
string
Valor Padrão
""
Observações
Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.
SSL
Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.
Propriedade | Descrição |
---|---|
SSLServerCert | O certificado a ser aceito do servidor ao conectar usando TLS/SSL. |
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.
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%\\\ExcelOnline 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%\\ExcelOnline 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 muitas 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 |
---|---|
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. |
Header | Indica se o provedor deve ou não detectar nomes de coluna da primeira linha. |
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. |
Pagesize | O número máximo de resultados a serem retornados por página do Excel Online quando UsePagination for True. |
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. |
SharepointURL | A URL base do seu Sharepoint Server. |
ShowSharedDocuments | Se deve ou não mostrar documentos compartilhados. |
Timeout | O valor em segundos até que o erro de timeout seja lançado, cancelando a operação. |
TypeDetectionScheme | Determina como determinar os tipos de dados das colunas. |
UsePagination | Se o Provedor ADO.NET para Excel Online deve ou não usar a paginação do lado do cliente. |
UseSimpleNames | Booleano determinando se nomes simples devem ser usados para tabelas e colunas. |
ValueInputOption | Determina como o provedor analisa os valores que o usuário envia ao Excel Online. |
ValueRenderOption | Determina como o provedor renderiza valores na saída. |
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.
Por exemplo, com AllowFormula
definido como verdadeiro, 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)')
Observação: Se verdadeiro, todas as colunas contendo uma fórmula serão expostas como tipo String independentemente do conjunto TypeDetectionScheme.
Cabeçalho
Indica se o provedor deve ou não detectar nomes de coluna da primeira linha.
Tipo de Dados
bool
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.
O conector seguirá as especificações adicionais abaixo para detectar cabeçalhos de coluna:
- Os cabeçalhos não devem conter caracteres especiais.
- Devido a uma limitação da API do Excel Online, todos os cabeçalhos de coluna não devem estar vazios.
MaxRows
Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Tipo de Dados
int
Valor Padrão
-1
Observações
Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Outro
Essas propriedades ocultas são usadas apenas em casos de uso específicos.
Tipo de Dados
string
Valor Padrão
""
Observações
As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Os casos de uso e a funcionalidade normais do driver não devem exigir essas propriedades.
Especifique várias propriedades em uma lista separada por ponto e vírgula.
Integração e Formatação
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. |
Tamanho da Página
O número máximo de resultados a serem retornados por página do Excel Online quando UsePagination for True.
Tipo de Dados
int
Valor Padrão
-1
Observações
O Pagesize
propriedade afeta o número máximo de resultados a serem retornados por página do Excel Online. Definir um valor mais alto pode resultar em melhor desempenho ao custo de memória adicional consumida por página consumida. Um valor de -1 indica o tamanho de página máximo possível para o driver.
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
50
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.
SharepointURL
A URL base do seu Sharepoint Server.
Tipo de Dados
string
Valor Padrão
""
Observações
Para consultar os SharePointSites, esta URL base do seu Sharepoint Server deve ser especificada.
Por exemplo: https://SomeTenantName.sharepoint.com
.
Mostrar Documentos Compartilhados
Se deve ou não mostrar documentos compartilhados.
Tipo de Dados
bool
Valor Padrão
false
Observações
Se deve ou não mostrar documentos compartilhados. Se definido como true, os documentos compartilhados serão listados ao lado das pastas de trabalho do usuário como tabelas de banco de dados. Em última análise, os arquivos específicos devem ter acesso direto ou compartilhado explicitamente com o usuário autenticado.
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.
TipoDetecçãoEsquema
Determina como determinar os tipos de dados das colunas.
Valores Possíveis
None
, RowScan
, ColumnFormat
Tipo de Dados
string
Valor Padrão
"RowScan"
Observações
O conector pode detectar tipos de dados com o formato de célula (número, moeda, data, etc.) ou verificando linhas.
Propriedade | Descrição |
---|---|
None | Contexto TypeDetectionScheme para None retornará todas as colunas como o tipo de string. |
RowScan | Contexto TypeDetectionScheme para RowScan varrerá linhas para determinar heuristicamente o tipo de dados. A RowScanDepth determina o número de linhas que o conector varrerá. |
ColumnFormat | Contexto TypeDetectionScheme para ColumnFormat informará o tipo de dados com base no formato da célula da coluna. Nota: Esta opção é aplicável apenas para 'UnformattedValue' e 'Formula' ValueRenderOption-s. Se o ValueRenderOption for definido como 'FormattedValue', todas as colunas serão expostas como tipos String. |
Usar Paginação
Se o Provedor ADO.NET para Excel Online deve ou não usar a paginação do lado do cliente.
Tipo de Dados
bool
Valor Padrão
false
Observações
Se o Conector Jitterbit para Excel Online deve ou não usar a paginação do lado do cliente. Sugerimos que você defina isso como verdadeiro no caso de um grande conjunto de dados.
UseSimpleNames
Booleano determinando se nomes simples devem ser usados para tabelas e colunas.
Tipo de Dados
bool
Valor Padrão
false
Observações
As tabelas e colunas do Excel Online podem usar caracteres especiais em nomes que normalmente não são permitidos em bancos de dados padrão. UseSimpleNames
torna o conector mais fácil de usar com ferramentas de banco de dados tradicionais.
Contexto UseSimpleNames
para true simplificará os nomes das tabelas e colunas retornadas. Ele aplicará um esquema de nomenclatura de forma que apenas caracteres alfanuméricos e o sublinhado sejam válidos para os nomes de tabela e coluna exibidos. Quaisquer caracteres não alfanuméricos serão convertidos em um sublinhado.
ValueInputOption
Determina como o provedor analisa os valores que o usuário envia ao Excel Online.
Valores Possíveis
UserEntered
, Raw
Tipo de Dados
string
Valor Padrão
"UserEntered"
Observações
Determina como o conector analisa os valores que o usuário envia ao Excel Online.
Propriedade | Descrição |
---|---|
Raw | Os valores inseridos pelo usuário não serão analisados e serão armazenados como estão. |
UserEntered | Os valores serão analisados como se o usuário os tivesse digitado na IU. Os números permanecerão como números, mas as strings podem ser convertidas em números, datas etc., seguindo as mesmas regras aplicadas ao inserir texto em uma célula por meio da interface do usuário do Excel Online. |
ValueRenderOption
Determina como o provedor renderiza valores na saída.
Valores Possíveis
FormattedValue
, UnformattedValue
, Formula
Tipo de Dados
string
Valor Padrão
"FormattedValue"
Observações
Determina como o conector renderiza valores na saída.
Propriedade | Descrição |
---|---|
FormattedValue | Os valores serão calculados e formatados na resposta de acordo com a formatação da célula. A formatação é baseada na localidade da pasta de trabalho, não na localidade do usuário solicitante. Por exemplo, se A1 for 1,23 e A2 for "=A1" e formatado como moeda, A2 retornará "$1,23". |
UnformattedValue | Os valores serão calculados, mas não formatados na resposta. Por exemplo, se A1 for 1,23 e A2 for "=A1" e formatado como moeda, A2 retornará o número 1,23. |
Formula | Os valores não serão calculados e, em vez disso, a resposta incluirá as fórmulas. Por exemplo, se A1 for 1,23 e A2 for "=A1" e formatado como moeda, A2 retornará "=A1". Por esta razão, cada coluna contendo uma fórmula será exposta como tipo String independente do conjunto TypeDetectionScheme. |