monday.com Detalhes da Conexão
Introdução
Versão do conector
Esta documentação é baseada na versão 22.0.8510 do conector.
Começando
Suporte para a versão de segunda-feira
O conector aproveita a API de segunda-feira para habilitar o acesso bidirecional a segunda-feira.
Estabelecendo uma Conexão
Conectando-se à API GraphQL de Segunda-feira
Conecte-se usando autenticação de token de API ou autenticação OAuth
Conexão com um Token de API
Conecte ao conector especificando o APIToken
. Colocou o AuthScheme
para Token
e obtenha APIToken
do seguinte modo:
- Faça login na sua conta de segunda-feira e navegue até
Manage Applications
no painel esquerdo. - Selecione o aplicativo para o qual deseja criar um token. Pode ser necessário criar um aplicativo primeiro.
- Clique no
Create token
botão para gerar umAPIToken
.
OAuth
Como alternativa, você pode estabelecer uma conexão usando autenticação OAuth.
Conectando-se à API do Monday AuditLog
Para gerar o token de API de log de auditoria, acesse a seção admin da sua conta Monday, clique na seção "Segurança" e depois na aba"Auditoria". A partir daí, selecione o botão "Monitor by API" e copie-o.
Depois de recuperar o token da API, você pode se conectar a partir do driver definindo as seguintes propriedades de conexão:
Schema
=AuditLog
AuthScheme
=Token
APIToken
=Seu token de API de log de auditoriaDomain
=https://yourdomain.monday.com
Usando Autenticação OAuth
OAuth requer que o usuário autenticado interaja com Monday usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.
Credenciais Personalizadas
Você precisa registrar um aplicativo para obter o OAuthClientId
e OAuthClientSecret
.
Aplicativos de Área de Trabalho
Crie um aplicativo OAuth. Consulte Criando um aplicativo OAuth personalizado para o procedimento.
Criando um Aplicativo OAuth Personalizado
Consulte Criando um aplicativo OAuth personalizado para o procedimento.
Credenciais Personalizadas
Esta seção descreve a autenticação da área de trabalho usando as credenciais para seu aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado Para maiores informações.
Obtenha um Token de Acesso OAuth
Depois de definir o seguinte, você está pronto para se conectar:
AuthScheme
: Definido comoOAuth
.OAuthClientId
: Defina o ID do cliente nas configurações do aplicativo.OAuthClientSecret
: Defina o segredo do cliente nas configurações do aplicativo.CallbackURL
: Defina como URL de redirecionamento nas configurações do aplicativo.InitiateOAuth
: Definido comoGETANDREFRESH
. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente oOAuthAccessToken
.
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 conclui o seguinte processo OAuth:
- Extrai o token de acesso da URL de retorno de chamada e autentica as solicitações.
- Obtém um novo token de acesso quando o antigo expira.
- Salva valores OAuth em
OAuthSettingsLocation
para ser persistido nas conexões.
Máquinas Sem Cabeça
Para criar fontes de dados de segunda-feira 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. Esta seção descreve o procedimento para autenticar e conectar-se aos dados.
Obtenha um Código Verificador
Primeiro, defina as seguintes propriedades na máquina sem periféricos:
InitiateOAuth
: Definido comoOFF
.OAuthClientId
: Defina o ID do aplicativo nas configurações do aplicativo.OAuthClientSecret
: Defina o Segredo do aplicativo nas configurações do aplicativo.
Em seguida, autentique-se em outra máquina e obtenha o OAuthVerifier
propriedade da 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 o URL de retorno de chamada, que contém o código do verificador.
- Salve o valor do código do verificador. Você precisa definir isso no
OAuthVerifier
propriedade de conexão.
Por fim, na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:
AuthScheme
: Definido comoOAuth
.OAuthClientId
: Defina a chave do consumidor nas configurações do aplicativo.OAuthClientSecret
: Defina como o segredo do consumidor nas configurações do seu aplicativo.OAuthVerifier
: Defina para o código do verificador.OAuthSettingsLocation
: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.InitiateOAuth
: Definido comoREFRESH
.
Conectar aos Dados
Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:
OAuthSettingsLocation
: Defina como 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
: Definido comoREFRESH
.
Transferir Configurações de OAuth
Para instalar o conector em outra máquina, autentique e transfira os valores OAuth resultantes:
- Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:
OAuthSettingsLocation
: Defina como um arquivo de texto gravável.InitiateOAuth
: Definido comoGETANDREFRESH
.AuthScheme
: Definido comoOAuth
.OAuthClientId
: Defina o ID do cliente nas configurações do aplicativo.OAuthClientSecret
: Defina o segredo do cliente nas configurações do aplicativo.CallbackURL
: Defina 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
: Definido comoREFRESH
.OAuthSettingsLocation
: Defina 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
Crie um Aplicativo OAuth Personalizado: Área de Trabalho
Conclua o procedimento a seguir para obter o OAuthClientId
, OAuthClientSecret
, e CallbackURL
.
Limitações do GraphQL
Cada API GraphQL tem suas próprias limitações e não podemos consultar um número arbitrariamente grande de nós porque cada consultar tem um custo e a API retornará um erro se o conector exceder o custo máximo. A função de custo da consultar depende diretamente dos tamanhos de página. O conector usa seus próprios algoritmos para encontrar os tamanhos de página, mas também oferece a liberdade de ajustá-los com base em suas necessidades. Há duas maneiras de obter esse comportamento:
- Especifique pesos de tamanho de página personalizados incluindo o
"other:pageSizeWeights"
atributo. Vamos supor que temos uma tabela "Clientes" que possui duas conexões GraphQl aninhadas, empresas e clientes. Se você deseja uma proporção específica entre essas duas entidades por consultar, digamos 200 clientes por 1 empresa, especifique "outro:pageSizeWeights=1:200" no respectivo script. A vantagem desse atributo é que você não ignora nossa lógica para localizar o tamanho de página ideal com base no custo da consultar. - Especifique tamanhos de página personalizados incluindo o
"other:pageSizes"
atributo. Ao especificar esse atributo, você ignorará qualquer verificação que fizermos para o custo da consultar, portanto, tome cuidado porque haverá erros de API se você exceder o custo máximo por consultar. Exemplo: "other:pageSizeWeights=10,30", recupere no máximo 10 empresas e no máximo 30 clientes por empresa em uma consultar.
Características Avançadas
Esta seção detalha uma seleção de recursos avançados do conector Monday.
Visualizações definidas pelo usuário
O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.
Configuração SSL
Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert
propriedade em "Opções de cadeia de conexão" para obter mais informações.
Procurador
Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings
caixa de seleção na tela de configuração da conexão.
Processamento de consulta
O conector descarrega o máximo possível do processamento da instrução SELECT para segunda-feira e, em seguida, processa o restante da consultar na memória (do lado do cliente).
Consulte Processamento de consultas Para maiores informações.
Visualizações Definidas pelo Usuário
O Jitterbit Connector for Monday permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.
Há duas maneiras de criar exibições definidas pelo usuário:
- Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
- declarações DDL.
Definindo Visualizações Usando um Arquivo de Configuração
As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json
. O conector detecta automaticamente as visualizações especificadas neste arquivo.
Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews
propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.
Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:
- Cada elemento raiz define o nome de uma exibição.
- Cada elemento raiz contém um elemento filho, chamado
query
, que contém a consultar SQL personalizada para a visualização.
Por exemplo:
{
"MyView": {
"query": "SELECT * FROM Invoices 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"
Definindo Exibições Usando Instruções DDL
O conector também é capaz de criar e alterar o esquema por meio de instruções DDL, como CREATE LOCAL VIEW, ALTER LOCAL VIEW e DROP LOCAL VIEW.
Criar uma Visualização
Para criar uma nova visualização usando instruções DDL, forneça o nome da visualização e a consultar da seguinte forma:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
Se não existir nenhum arquivo JSON, o código acima criará um. A exibição é então criada no arquivo de configuração JSON e agora pode ser descoberta. O local do arquivo JSON é especificado pelo UserDefinedViews
propriedade de conexão.
Alterar uma Visualização
Para alterar uma exibição existente, forneça o nome de uma exibição existente ao lado da nova consultar que você gostaria de usar:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
A visualização é então atualizada no arquivo de configuração JSON.
Solte uma Visualização
Para descartar uma exibição existente, forneça o nome de um esquema existente ao lado da nova consultar que você gostaria de usar.
DROP LOCAL VIEW [MyViewName]
Isso remove a visualização do arquivo de configuração JSON. Não pode mais ser consultado.
Esquema para Exibições Definidas pelo Usuário
As visualizações definidas pelo usuário são expostas no UserViews
esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName
propriedade.
Trabalhando com Exibições Definidas pelo Usuário
Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers
lista apenas clientes em Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
Exemplo de consultar ao driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resultando na consultar efetiva à fonte:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.
Configuração SSL
Personalizando a Configuração SSL
Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.
Para especificar outro certificado, consulte o SSLServerCert
propriedade para os formatos disponíveis para fazê-lo.
Modelo de Dados
O Jitterbit Connector for Monday modela objetos Monday como tabelas e exibições relacionais. Um objeto Monday tem relacionamentos com outros objetos; nas tabelas, esses relacionamentos são expressos por meio de chaves estrangeiras. As seções a seguir mostram os objetos de API disponíveis e fornecem mais informações sobre como executar SQL para APIs de segunda-feira.
Os esquemas para a maioria dos objetos de banco de dados são definidos em arquivos de configuração simples baseados em texto.
O conector transfere o máximo possível do processamento da instrução SELECT para as APIs de segunda-feira e, em seguida, processa o restante da consultar na memória. Ver SupportEnhancedSQL
para obter mais informações sobre como o conector contorna as limitações da API com processamento na memória do lado do cliente.
Usando GraphQL API
Consulte Modelo de dados GraphQL para as entidades disponíveis na API GraphQL.
Usando a API AuditLog
Consulte Modelo de dados do AuditLog para as entidades disponíveis na API AuditLog.
Modelo de Dados GraphQL
Visão Geral
O Jitterbit Connector for Monday modela objetos Monday como tabelas e exibições relacionais.
Um objeto Monday tem relacionamentos com outros objetos nas tabelas. Esses relacionamentos são expressos por meio de chaves estrangeiras. As seções a seguir mostram os objetos de API disponíveis e fornecem mais informações sobre a execução de SQL para APIs de segunda-feira.
Os esquemas para a maioria dos objetos de banco de dados são definidos em arquivos de configuração simples baseados em texto.
Visualizações
Visualizações descreve as exibições disponíveis. As exibições são definidas estaticamente para modelar contas, clientes, produtos e muito mais.
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.
Visualizações dinâmicas, como consultas expostas como visualizações e visualizações para procurar combinações específicas de itens de trabalho project_team são suportadas.
Conector Jitterbit para Exibições de Segunda-feira
Nome | Descrição |
---|---|
ActivityLogs | A placa registra eventos. |
Assets | Obtenha uma coleção de ativos por IDs. |
BoardItemsInternal | Obtenha uma coleção de IDs de tabuleiros e itens. Esta exibição é apenas para uso interno. |
Boards | Obtenha uma coleção de placas. |
BoardViews | As opiniões do conselho. |
Columns | As colunas visíveis do quadro. |
ColumnValues | Os valores da coluna do item. |
Groups | Os grupos visíveis do quadro. |
Items | Obtenha uma coleção de itens. |
Tags | Obtenha uma coleção de tags. |
Teams | Obtenha uma coleção de equipes. |
Updates | Obtenha uma coleção de atualizações. |
Users | Obtenha uma coleção de usuários. |
Logs de Atividades
A placa registra eventos.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes.
Por exemplo, as consultas a seguir são processadas no lado do servidor.
BoardId
suporta os operadores '=, IN'.UserId
suporta os operadores '=, IN'.ColumnId
suporta os operadores '=, IN'.GroupId
suporta os operadores '=, IN'.ItemId
suporta os operadores '=, IN'.CreatedAt
suporta os operadores '=, >, >=, <, <='.
SELECIONE
SELECT * FROM ActivityLogs WHERE BoardId IN ('2307103055','2182296646')
SELECT * FROM ActivityLogs WHERE UserId IN ('27278379','28087608')
SELECT * FROM ActivityLogs WHERE ColumnId IN ('27278379','28087608')
SELECT * FROM ActivityLogs WHERE GroupId IN ('27278379','28087608')
SELECT * FROM ActivityLogs WHERE ItemId IN ('27278379','28087608')
SELECT * FROM ActivityLogs WHERE CreatedAt > '2022-02-17 05:12:04.419' AND CreatedAt < '2022-02-17 05:12:04.861'
SELECT * FROM ActivityLogs WHERE CreatedAt >= '2022-02-17 05:12:04.419' AND CreatedAt <= '2022-02-17 05:12:04.861'
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | A ID do evento do log de atividades. | |
BoardId | Long | Pranchas.id | O identificador exclusivo da placa. |
AccountId | String | O ID da conta que iniciou o evento. | |
UserId | Int | Usuários.ID | O ID do usuário que iniciou o evento. |
CreatedAt | Datetime | A hora do evento. | |
Data | String | Os valores da coluna do item em forma de string. | |
Entity | String | A entidade do evento que foi alterada (pulso/placa). | |
Event | String | A ação que ocorreu. | |
ColumnId | String | ID da coluna para filtrar. | |
GroupId | String | ID do grupo para filtrar. | |
ItemId | Long | ID do item a filtrar. |
Ativos
Obtenha uma coleção de ativos por IDs.
Informações Específicas da Tabela
Observação: O filtro de ID é necessário para recuperar dados desta tabela.
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes. Por exemplo, as consultas a seguir são processadas no lado do servidor.
Id
suporta os operadores '=, IN'.
SELECIONE
SELECT * FROM Assets WHERE Id = '397532775'
SELECT * FROM Assets WHERE ID IN ('397532775','397532776')
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | Int | O identificador exclusivo do arquivo. | |
Name | String | O nome do arquivo. | |
CreatedAt | Datetime | A data de criação do arquivo. | |
FileExtension | String | A extensão do arquivo. | |
FileSize | Int | O tamanho do arquivo em bytes. | |
OriginalGeometry | String | A geometria original do ativo. | |
PublicUrl | String | A URL pública para o ativo, válida por 1 hora. | |
UploadedById | Int | Usuários.ID | O identificador exclusivo do usuário. |
Url | String | A URL para visualizar o ativo. | |
UrlThumbnail | String | A URL para visualizar o recurso no modo de miniatura. Disponível apenas para imagens. |
BoardItemsInternal
Obtenha uma coleção de IDs de tabuleiros e itens. Esta exibição é apenas para uso interno.
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
BoardId [KEY] | Long | O identificador exclusivo da placa. | |
ItemId [KEY] | Long | O identificador exclusivo do item. |
Pranchas
Obtenha uma coleção de placas.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes.
Por exemplo, as consultas a seguir são processadas no lado do servidor.
Id
suporta os operadores '=, IN'.BoardKind
suporta os operadores '='.
SELECIONE
SELECT * FROM Boards WHERE Id = '2182296646'
SELECT * FROM Boards WHERE Id IN ('2307103055','2182296646','2181960030')
SELECT * FROM Boards WHERE Id IN ('2307103055','2182296646','2181960030') AND BoardKind = 'public'
SELECT * FROM Boards WHERE BoardKind = 'public'
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | Long | O identificador exclusivo da placa. | |
TopGroupId | String | Grupos.ID | O identificador exclusivo do grupo. |
Name | String | O nome da placa. | |
ItemsCount | Int | O número de itens no quadro. | |
Description | String | A descrição da placa. | |
UpdatedAt | Datetime | A última vez que o quadro foi atualizado em. | |
BoardKind | String | O tipo do fórum (público/privado/compartilhado). | |
BoardFolderId | Int | O identificador exclusivo da pasta do quadro. | |
Communication | String | Obtenha o valor de comunicação do conselho - geralmente o ID da reunião. | |
Permissions | String | As permissões do conselho. | |
Pos | String | A posição do conselho. | |
TagsIds | String | Uma lista separada por vírgulas dos identificadores exclusivos das tags. | |
State | String | O estado do quadro (todos/ativo/arquivado/excluído). | |
WorkspaceId | Int | O identificador exclusivo do espaço de trabalho do quadro (nulo para o espaço de trabalho principal). | |
WorkspaceName | String | O nome do espaço de trabalho do quadro. | |
WorkspaceKind | String | Retornará Aberto para Espaços de Trabalho Abertos e Fechado para Espaços de Trabalho Fechados. | |
WorkspaceDescription | String | A descrição do espaço de trabalho do quadro. |
BoardViews
As opiniões do conselho.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes. Por exemplo, as consultas a seguir são processadas no lado do servidor.
BoardId
suporta os operadores '=, IN'.Type
suporta o=
operador.
SELECIONE
SELECT * FROM BoardViews WHERE BoardId = '2182296646'
SELECT * FROM BoardViews WHERE Type = 'Chart'
SELECT * FROM BoardViews WHERE BoardId IN ('2182296646','2181960030')
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | O identificador exclusivo da exibição. | |
BoardId | Long | Pranchas.ID | O identificador exclusivo da placa. |
Name | String | O nome da visualização. | |
Settings | String | As configurações da exibição em um formato de string. | |
Type | String | O tipo de visualização. |
Colunas
As colunas visíveis do quadro.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes.
Por exemplo, as consultas a seguir são processadas no lado do servidor.
ID
suporta os operadores '=, IN'.BoardId
suporta os operadores '=, IN'.
SELECIONE
SELECT * FROM Columns WHERE ID = 'name'
SELECT * FROM Columns WHERE ID IN ('name','person')
SELECT * FROM Columns WHERE BoardId = '2182296646'
SELECT * FROM Columns BoardId IN ('2182296646','2181960030')
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | O identificador da coluna, exclusivo apenas para seu quadro. | |
BoardId [KEY] | Long | Pranchas.id | O identificador exclusivo da placa. |
Archived | Bool | Se a coluna é arquivada ou não. | |
Settings | String | As configurações da coluna em um formulário de string. | |
Title | String | O título da coluna. | |
Type | String | O tipo da coluna. | |
Width | Int | A largura da coluna. |
Valores da Coluna
Os valores da coluna do item.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes. Por exemplo, as consultas a seguir são processadas no lado do servidor.
Id
suporta os operadores '=, IN'.ItemId
suporta os operadores '=, IN'.
SELECIONE
SELECT * FROM ColumnValues WHERE Id = 'person'
SELECT * FROM ColumnValues WHERE Id IN ('person','status')
SELECT * FROM ColumnValues WHERE ItemId IN ('2181853162','2181853151')
SELECT * FROM ColumnValues WHERE ItemId = '2181853162'
SELECT * FROM ColumnValues WHERE ItemId = '2181853162' AND ID = 'status'
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | O identificador exclusivo da coluna. | |
ItemId [KEY] | Long | Unid.ID | O identificador exclusivo do item. |
AdditionalInfo | String | As informações adicionais do valor da coluna. | |
Text | String | O valor textual da coluna na forma de string. | |
Title | String | O título da coluna. | |
Type | String | O tipo da coluna. | |
Value | String | O valor da coluna no formato json. |
Grupos
Os grupos visíveis do quadro.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes.
Por exemplo, as consultas a seguir são processadas no lado do servidor.
Id
suporta os operadores '=, IN'.BoardId
suporta os operadores '=, IN'.
SELECIONE
SELECT * FROM Groups WHERE Id = 'topics'
SELECT * FROM Groups WHERE Id IN ('topics','group_title')
SELECT * FROM Groups WHERE BoardId IN ('2182296646','21822966')
SELECT * FROM Groups WHERE BoardId = '2182296646' AND ID = 'topics'
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | O identificador exclusivo do grupo. | |
BoardId [KEY] | Long | Pranchas.ID | O identificador exclusivo da placa. |
Archived | Bool | Se o grupo está arquivado ou não. | |
Color | String | A cor do grupo. | |
Deleted | Bool | Se o grupo foi excluído ou não. | |
Position | String | A posição do grupo no conselho. | |
Title | String | O título do grupo. |
Unid
Obtenha uma coleção de itens.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes.
Por exemplo, as consultas a seguir são processadas no lado do servidor.
Id
suporta os operadores '='.BoardId
suporta os operadores '='.ColumnId
suporta os operadores '='.ColumnValue
suporta os operadores '=, IN'.
SELECIONE
SELECT * FROM Items ORDER BY CreatedAt DESC
SELECT * FROM Items WHERE Id = 2181917692
SELECT * FROM Items WHERE BoardId = '2181917679' AND ColumnId = 'text' AND ColumnValue = 'test'
SELECT * FROM Items WHERE BoardId = '2181917679' AND ColumnId = 'text' AND ColumnValue IN ('Working on it','test')
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | Long | O identificador exclusivo do item. | |
BoardId | Long | Pranchas.ID | O identificador exclusivo da placa. |
CreatorId | String | Usuários.ID | O identificador exclusivo do criador do item. |
GroupId | String | Grupos.ID | O identificador exclusivo do grupo. |
CreatedAt | Datetime | A data de criação do item. | |
Name | String | O nome do item. | |
Email | String | O e-mail do item. | |
State | String | O estado do item (todos/ativo/arquivado/excluído). | |
UpdatedAt | Datetime | A data da última atualização do item. | |
AssetsIds | String | Uma lista separada por vírgulas dos identificadores exclusivos de ativos/arquivos dos itens. | |
ColumnId | String | Colunas.ID | O identificador exclusivo da coluna. |
ColumnValue | String | Os valores de coluna pelos quais pesquisar itens. Você pode usar valores de texto para a pesquisa. | |
ColumnType | String | O tipo de coluna. |
Tag
Obtenha uma coleção de tags.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes. Por exemplo, as consultas a seguir são processadas no lado do servidor.
ID
suporta os operadores '=, IN'.IsPrivate
suporta o=
operador.
SELECIONE
SELECT * FROM Tags WHERE IsPrivate = true
SELECT * FROM Tags WHERE IsPrivate = false
SELECT * FROM Tags WHERE ID = '13327214'
SELECT * FROM Tags WHERE ID IN ('13327214','13327217')
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | Int | O identificador exclusivo da tag. | |
Color | String | A cor da etiqueta. | |
Name | String | O nome da etiqueta. | |
IsPrivate | Bool | Se a tag é privada ou não. O valor padrão é falso. |
Equipes
Obtenha uma coleção de equipes.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes.
Por exemplo, as consultas a seguir são processadas no lado do servidor.
Id
suporta os operadores '=, IN'.
SELECIONE
SELECT * FROM Teams WHERE Id = '565332'
SELECT * FROM Teams WHERE ID IN ('565332,565333')
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | Int | O identificador exclusivo da equipe. | |
Name | String | O nome da equipe. | |
PictureUrl | String | URL da imagem da equipe. |
Atualizações
Obtenha uma coleção de atualizações.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes. Por exemplo, as consultas a seguir são processadas no lado do servidor. SELECIONE
SELECT * FROM Updates
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | String | O identificador exclusivo da atualização. | |
Body | String | O corpo formatado em html da atualização. | |
CreatedAt | Datetime | A data de criação da atualização. | |
CreatorId | String | Usuários.ID | O identificador exclusivo do criador da atualização. |
ItemId | String | O ID do item da atualização. | |
TextBody | String | O corpo do texto da atualização. | |
UpdatedAt | Date | A data da última edição da atualização. | |
AssetsIds | String | Uma lista separada por vírgulas dos identificadores exclusivos de ativos/arquivos da atualização. | |
Replies | String | As respostas da atualização. |
Usuários
Obtenha uma coleção de usuários.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes. Por exemplo, as consultas a seguir são processadas no lado do servidor.
ID
suporta os operadores '=, IN'.IsPending
suporta os operadores '='.IsGuest
suporta os operadores '='.Email
suporta os operadores '=, IN'.
SELECIONE
SELECT * FROM Users ORDER BY CreatedAt DESC
SELECT * FROM Users WHERE IsPending = true
SELECT * FROM Users WHERE IsGuest = true
SELECT * FROM Users WHERE ID = '27278379'
SELECT * FROM Users WHERE ID IN ('27278379','27278377')
SELECT * FROM Users WHERE Email = 'test@cdata.com'
SELECT * FROM Users WHERE Email IN ('test@cdata.com','test@gmail.com')
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Id [KEY] | Int | O identificador exclusivo do usuário. | |
TeamsIds | String | Equipes.ID | Uma lista de identificadores exclusivos de equipes às quais o usuário pertence. |
Name | String | O nome do usuário. | |
Phone | String | O número de telefone do usuário. | |
Birthday | Date | Aniversário do usuário. | |
CountryCode | String | O código do país do usuário. | |
CreatedAt | Datetime | A data de criação do usuário. | |
Email | String | O e-mail do usuário. | |
Enabled | Bool | Se o usuário está habilitado ou não. | |
EncryptApiToken | String | O token do usuário para e-mail a bordo. | |
IsAdmin | Bool | Se o usuário é ou não um administrador de conta. | |
IsGuest | Bool | Se o usuário é um convidado ou não. | |
IsPending | Bool | Se o usuário é um usuário pendente ou não | |
IsVerified | Bool | Se o usuário verificou ou não seu e-mail. | |
IsViewOnly | Bool | Se o usuário é ou não um usuário somente para visualização. | |
JoinDate | Date | A data em que o usuário ingressou na conta. | |
Location | String | A localização do usuário. | |
MobilePhone | String | O número do celular do usuário. | |
PhotoOriginal | String | A foto do usuário no tamanho original. | |
PhotoSmall | String | A foto do usuário em tamanho pequeno (150x150). | |
PhotoThumb | String | A foto do usuário em tamanho miniatura (100x100). | |
PhotoThumbSmall | String | A foto do usuário em tamanho de miniatura pequena (50x50). | |
PhotoTiny | String | A foto do usuário em tamanho minúsculo (30x30). | |
TimeZoneIdentifier | String | O identificador de fuso horário do usuário. | |
Title | String | O título do usuário. | |
Url | String | A URL do perfil do usuário. | |
UtcHoursDiff | Int | A diferença de horário UTC do usuário. | |
AccountFirstDayOfTheWeek | String | O primeiro dia da semana para a conta (domingo / segunda-feira) | |
AccountId | Int | O identificador exclusivo da conta. | |
AccountLogo | String | O logotipo da conta. | |
AccountName | String | O nome da conta. | |
AccountPlanMaxUsers | Int | O máximo de usuários permitidos no plano. | |
AccountPlanPeriod | String | O período de tempo do plano. | |
AccountPlanTier | String | O nível do plano. | |
AccountPlanVersion | Int | A versão do plano. | |
AccountShowTimelineWeekends | Bool | Mostrar ou não os finais de semana na linha do tempo. | |
AccountSlug | String | A lesma da conta. | |
AccountTier | String | O nível da conta. |
Procedimentos Armazenados
Procedimentos armazenados* são interfaces semelhantes a funções que estendem a funcionalidade do conector além das simples operações SELECT com Monday.
Procedimentos armazenados* aceitar uma lista de parâmetros, executar a função pretendida e, em seguida, retornar, se aplicável, quaisquer dados de resposta relevantes da segunda-feira, juntamente com uma indicação de se o procedimento foi bem-sucedido ou falhou.
Conector Jitterbit para Procedimentos Armazenados de Segunda-feira
Nome | Descrição |
---|---|
GetOAuthAccessToken | Obtém o token de acesso OAuth do GitHub. |
GetOAuthAuthorizationURL | Obtém a URL de autorização do GitHub. 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 string de conexão para o GitHub. |
GetOAuthAccessToken
Obtém o token de acesso OAuth do GitHub.
Entrada
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
AuthMode | String | Falso | O tipo de modo de autenticação a ser usado. Os valores permitidos são APP, WEB. |
Verifier | String | Falso | O token do verificador retornado pelo GitHub após usar a URL obtida com GetOAuthAuthorizationURL. Necessário apenas para Web AuthMode. |
Scope | String | Falso | O escopo ou as permissões que você está solicitando. O valor padrão é boards:ler espaços de trabalho:ler usuários:ler conta:ler atualizações:ler ativos:ler tags:ler equipes:ler. |
CallbackUrl | String | Falso | A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. |
State | String | Falso | Este campo indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma ida e volta ao servidor de autorização do GitHub e vice-versa. Os usos incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
OAuthAccessToken | String | O token de autenticação retornado do GitHub. |
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 a URL de autorização do GitHub. 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 string de conexão para o GitHub.
Entrada
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
CallbackUrl | String | Falso | A URL para a qual o GitHub retornará depois que o usuário autorizar seu aplicativo. |
Scope | String | Falso | O escopo ou as permissões que você está solicitando. O valor padrão é boards:ler espaços de trabalho:ler usuários:ler conta:ler atualizações:ler ativos:ler tags:ler equipes:ler. |
State | String | Falso | Este campo indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma ida e volta ao servidor de autorização do GitHub e vice-versa. Os usos incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites. |
Colunas do Conjunto de Resultados
Nome | Tipo | Descrição |
---|---|---|
URL | String | A URL a ser inserida em um navegador da Web para obter o token do verificador e autorizar o provedor de dados. |
Modelo de Dados AuditLog
Visão Geral
O Jitterbit Connector for Monday modela objetos Monday como tabelas e exibições relacionais.
Um objeto Monday tem relacionamentos com outros objetos nas tabelas. Esses relacionamentos são expressos por meio de chaves estrangeiras. As seções a seguir mostram os objetos de API disponíveis e fornecem mais informações sobre a execução de SQL para APIs de segunda-feira.
Os esquemas para a maioria dos objetos de banco de dados são definidos em arquivos de configuração simples baseados em texto.
Visualizações
Visualizações descreve as exibições disponíveis. As exibições são definidas estaticamente para modelar AuditLogs.
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.
Visualizações dinâmicas, como consultas expostas como visualizações e visualizações para procurar combinações específicas de itens de trabalho project_team são suportadas.
Conector Jitterbit para Exibições de Segunda-feira
Nome | Descrição |
---|---|
AuditLogs | Os eventos de registro de auditoria do conselho. |
AuditLogs
Os eventos de registro de auditoria do conselho.
Informações Específicas da Tabela
O conector usa a API Monday para processar alguns dos filtros. O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL como false, caso em que qualquer critério de pesquisa que se refira a outras colunas causará dados inconsistentes.
Por exemplo, as consultas a seguir são processadas no lado do servidor.
Timestamp
suporta os operadores '=, >, >=, <, <='.UserId
suporta o=
operador.IpAddress
suporta o=
operador.Event
suporta os operadores '=, IN'.
Todos os valores disponíveis para o filtro de eventos estão listados e explicados abaixo:
export-board-activity-log:
Exportação do Log de atividades do quadro de logs pelos usuáriosexport-account-data:
Registra a exportação de dados da conta pelos administradoresdownload-attachment:
Registra downloads de arquivos pelos usuáriosexport-board:
Registra as exportações da placa pelos usuáriosexport-dashboard:
Registra as exportações do painel pelos usuáriosexport-content-directory:
Registra as exportações do diretório de conteúdo pelos administradoreslogin:
Registra os logins dos usuários no sistemaforgot-password:
Registra "Esqueceu a senha?" cliques na página de loginlogout:
Registra os logouts dos usuários do sistemafailed-login:
Registra as tentativas de login com falha dos usuáriosuser-reactivated:
Registra a reativação dos usuários pelos administradoresuser-deactivated:
Registra a desativação de usuários pelos administradoresuser-details-deleted:
Registra a exclusão de usuários pelos administradoresuser-invite:
Registra os convites dos usuários de dentro do sistemacancel-user-invite:
Registra convites de usuários cancelados de dentro do sistemauser-role-change:
Registra a alteração do tipo de usuário pelos administradoresdelete-board:
Logs de exclusão de placa pelos usuáriosdelete-workspace:
Registra a exclusão do espaço de trabalho pelos usuárioscreate-team:
Registra a criação da equipe pelos usuáriosdelete-team:
Exclusão de equipe de logs por usuáriossecurity-settings-change:
Registra alterações nas configurações de segurança pelos administradoresboard-broadcast-enabled:
Habilitação de transmissão da placa de logs pelos usuáriosadd-user-to-team:
Registra a adição de usuários a equipes por usuáriosremove-user-from-team:
Registra a remoção dos usuários das equipes pelos usuáriosadd-user-to-product:
Registra a adição de usuários a produtos Work OSremove-user-from-product:
Registra a remoção dos usuários dos produtos Work OSadd-team-to-product:
Registra a adição das equipes aos produtos Work OSremove-team-from-product:
Registra a remoção das equipes dos produtos Work OSapi-complexity-breach-over-time:
Registra chamadas de API atingindo o limite da conta
SELECIONE
As seguintes consultas são executadas no lado do servidor:
SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z'
SELECT * FROM AuditLogs WHERE Event IN ('export-board-activity-log', 'delete-board')
SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z' AND Event = 'delete-board' AND UserId = 27 AND IpAddress = '123.123'
Colunas
Nome | Tipo | Referências | Descrição |
---|---|---|---|
Timestamp | Datetime | O timestamp do evento | |
AccountId | String | O ID da conta que iniciou o evento. | |
UserId | Integer | O ID do usuário que iniciou o evento. | |
Event | String | A ação que ocorreu. Os valores permitidos são export-board-activity-log, export-account-data, download-attachment, export-board, export-dashboard, export-content-directory, login, esqueceu-password, logout, failed-login, user -reativado, desativado pelo usuário, detalhes do usuário excluídos, convite do usuário, cancelamento do convite do usuário, alteração da função do usuário, quadro de exclusão, área de trabalho excluída, equipe de criação, equipe de exclusão, alteração das configurações de segurança, habilitado para transmissão de quadro, adicionar usuário à equipe, remover usuário da equipe, adicionar usuário ao produto, remover usuário do produto, adicionar equipe ao produto, remover equipe -from-product, api-complexity-breach-over-time. | |
Slug | String | A lesma do evento que ocorreu. | |
IpAddress | String | O endereço IP registrado para este evento. | |
UserAgent | String | O User Agente do evento. | |
ClientName | String | Nome do cliente de software. | |
ClientVersion | String | Versão do cliente de software. | |
OsName | String | Nome do sistema operacional. | |
OsVersion | String | Versão do sistema operacional. | |
DeviceName | String | O nome do dispositivo. | |
DeviceType | String | O tipo do dispositivo. | |
ActivityMetadata | String | Metadados de atividade adicionais para o evento |
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 do banco de dados para segunda-feira:
- sys_catalogs: Lista os bancos de dados disponíveis.
- sys_schemas: Lista os esquemas disponíveis.
- sys_tables: Lista as tabelas e exibições disponíveis.
- sys_tablecolumns: Descreve as colunas das tabelas e exibições disponíveis.
- sys_procedures: Descreve os procedimentos armazenados disponíveis.
- sys_procedureparameters: Descreve procedimento armazenado* parâmetros.
- sys_keycolumns: Descreve as chaves primárias e estrangeiras.
- sys_indexes: Descreve os índices disponíveis.
Tabelas de Fonte de Dados
As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:
- sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
- sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.
Consultar Tabelas de Informações
A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:
- sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.
Sys_catalogs
Lista os bancos de dados disponíveis.
A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:
SELECT * FROM sys_catalogs
Colunas
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados. |
Sys_schemas
Lista os esquemas disponíveis.
A consultar a seguir recupera todos os esquemas disponíveis:
SELECT * FROM sys_schemas
Colunas
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados. |
SchemaName | String | O nome do esquema. |
Sys_tables
Lista as tabelas disponíveis.
A consultar a seguir recupera as tabelas e exibições disponíveis:
SELECT * FROM sys_tables
Colunas
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O banco de dados que contém a tabela ou exibição. |
SchemaName | String | O esquema que contém a tabela ou exibição. |
TableName | String | O nome da tabela ou 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 Faturas:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Invoices'
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 SampleProcedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' 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 Faturas:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Invoices'
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_primarykeys
Descreve as chaves primárias. A consultar a seguir recupera as chaves primárias de todas as tabelas e exibições:
SELECT * FROM sys_primarykeys
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. |
KeySeq | String | O número de sequência da chave primária. |
KeyName | String | O nome da chave primária. |
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:monday: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.
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 |
---|---|
Schema | Especifica qual API de segunda-feira usar. |
AuthScheme | O tipo de autenticação a ser usado ao conectar-se a segunda-feira. |
APIToken | O token de API obtido de sua conta de segunda-feira. |
Domain | Especifique o domínio da sua conta do Monday. Obrigatório apenas ao usar o esquema AuditLog. Exemplo: https://yourdomain.monday.com . |
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. |
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 exibições relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC. |
Propriedade | Descrição |
---|---|
MaxPointsPerCall | Especifica quantos pontos uma ligação custará. |
MaxRows | Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design. |
Other | Essas propriedades ocultas são usadas apenas em casos de uso específicos. |
PseudoColumns | Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela. |
Timeout | O valor em segundos até que o erro de timeout seja lançado, cancelando a operação. |
UserDefinedViews | Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas. |
Autenticação
Esta seção fornece uma lista completa de propriedades de autenticação que você pode configurar.
Propriedade | Descrição |
---|---|
Schema | Especifica qual API de segunda-feira usar. |
AuthScheme | O tipo de autenticação a ser usado ao conectar-se a segunda-feira. |
APIToken | O token de API obtido de sua conta de segunda-feira. |
Domain | Especifique o domínio da sua conta do Monday. Obrigatório apenas ao usar o esquema AuditLog. Exemplo: https://yourdomain.monday.com . |
Esquema
Especifica qual API de segunda-feira usar.
Valores Possíveis
GraphQL
, AuditLog
Tipo de Dados
string
Valor Padrão
"GraphQL"
Observações
Os valores disponíveis são GraphQL e AuditLog.
AuthScheme
O tipo de autenticação a ser usado ao conectar-se a Monday.
Valores Possíveis
Token
, OAuth
Tipo de Dados
string
Valor Padrão
"Token"
Observações
- Token: Defina para executar a autenticação de token de segunda-feira.
- OAuth: Defina para executar a autenticação OAuth de segunda-feira.
APIToken
O token de API obtido de sua conta de segunda-feira.
Tipo de Dados
string
Valor Padrão
""
Observações
Aba Admin
Se você for um usuário administrador em sua conta monday.com, poderá acessar seus tokens de API na aba "Admin" com as seguintes etapas:
- Faça login na sua conta monday.com.
- Clique no seu avatar (ícone de imagem) no canto inferior esquerdo da tela.
- Selecione Admin no menu resultante (isso requer que você tenha permissões de administrador).
- Vá para a seção API.
- Gere um "token API v2"
- Copie seu token.
Aba Desenvolvedor
Se você for um usuário membro em sua conta monday.com, poderá acessar seus tokens de API na aba Desenvolvedor com as seguintes etapas:
- Faça login na sua conta monday.com.
- Clique no seu avatar (ícone de imagem) no canto inferior esquerdo da tela.
- Selecione Desenvolvedor no menu resultante.
- No menu superior, clique no menu suspenso "Desenvolvedor".
- Selecione a primeira opção no menu suspenso intitulada "Meus tokens de acesso".
- Clique no botão azul "Mostrar" para expor seu token de API e copiá-lo.
Domínio
Especifique o domínio da sua conta do Monday. Obrigatório apenas ao usar o esquema AuditLog. Exemplo: https://yourdomain.monday.com
.
Tipo de Dados
string
Valor Padrão
""
Observações
Especifique o domínio da sua conta do Monday. Obrigatório apenas ao usar o esquema AuditLog. Exemplo: https://yourdomain.monday.com
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. |
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 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 para o qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno de chamada 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.
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 onde 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 para 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 MD5 Thumbprint (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 exibiçõ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%\\\Monday 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%\\Monday Data Provider\Schema" com %APPDATA%
sendo definido para o diretório de configuração do usuário:
Plataforma | %APPDATA% |
---|---|
Windows | O valor da variável de ambiente APPDATA |
Mac | ~/Biblioteca/Suporte de aplicativos |
Linux | ~/.config |
Esquemas Navegáveis
Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tipo de Dados
string
Valor Padrão
""
Observações
Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.
Tabelas
Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.
Tipo de Dados
string
Valor Padrão
""
Observações
Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.
Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.
Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.
Visualizações
Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.
Tipo de Dados
string
Valor Padrão
""
Observações
Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.
Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitas 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 |
---|---|
MaxPointsPerCall | Especifica quantos pontos uma ligação custará. |
MaxRows | Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design. |
Other | Essas propriedades ocultas são usadas apenas em casos de uso específicos. |
PseudoColumns | Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela. |
Timeout | O valor em segundos até que o erro de timeout seja lançado, cancelando a operação. |
UserDefinedViews | Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas. |
MaxPointsPerCall
Especifica quantos pontos uma ligação custará.
Tipo de Dados
string
Valor Padrão
"1000000"
Observações
O custo total de suas consultas não pode exceder 5.000.000 de pontos a qualquer momento.
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. |
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, "*=*".
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.
UserDefinedViews
Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas.
Tipo de Dados
string
Valor Padrão
""
Observações
As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json
. O conector detecta automaticamente as visualizações especificadas neste arquivo.
Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews
propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.
Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:
- Cada elemento raiz define o nome de uma exibição.
- Cada elemento raiz contém um elemento filho, chamado
query
, que contém a consultar SQL personalizada para a visualização.
Por exemplo:
{
"MyView": {
"query": "SELECT * FROM Invoices 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"