Componentes

API REST

Usando o Connect, você pode criar, preencher e excluir tabelas de preparo por meio da API REST. O Connect requer permissão de administrador para todos os serviços Web.

Criar e preencher a tabela de preparo

/REST/1/dbstage/Insert: Preencha uma tabela de preparo nova ou existente com dados que seguem as restrições JSON definidas.

Defina estes atributos:

• Connection: definido como ignorado.
• Table: definido como o nome de uma tabela existente ou uma nova tabela com o prefixo EXT_.
• cols: definido para definir os nomes de coluna e os tipos de dados, que devem corresponder à estrutura da tabela.
• Rows: Defina como o número de linhas a serem inseridas na tabela.
• Operation: definido como Create para novos elementos. Defina como drop para excluir elementos. A operação pode ser definida no nível da tabela ou coluna.

Exemplo de tabela existente

{ "conexão": "ignorada", "mesa": "DB_TABLES", "cols": { "load_code": "string", "catalog_name": "string", "catalog_environment": "string", "schema_name": "string", "create_time": "data-data", "table_name": "string" },

Novo exemplo de tabela

{ "conexão": "ignorada", "mesa": {"nome":"EXT_DB_TABLES","operação":"criar"}, "cols": { "load_code": {"tipo":"string", "operação":"criar"}, "catalog_name": {"tipo":"string","operação":"drop"}, "catalog_environment": "string", " schema_name": "string", "create_time": "data", "table_name": "string" }

Exemplo de população de tabela

[ { "conexão":"ignorada", "tabela":"ARQUIVOS", "cols":{ "LOAD_CODE":"string", "SYSTEM_NAME":"string", "NAME":"string", "PATH":"string", "PATH_HASH":"string", "PARENT":"string", "PARENT_HASH":"string(255)", "TYPE":"string", "EXTENSION":" string", "SIZE":"ERROR:Int64", "CREATED":"datetime", "LAST_MODIFIED":"data", "ACCESS_TIME":"data", "HIDDEN":"ERROR:Int32", "READ_ONLY":"ERRO:Int32" }, "linhas":[ { "LOAD_CODE":"31abffbc019f597dbc688dde6cfa077e", "SYSTEM_NAME":" ACME", "NAME":"AlteryxSampleData", "PATH":"\\\ACME\\AlteryxSampleData\\\ ", "PATH_HASH":"2ac01f9c26e5d33908bbd821dee5b7e", "TYPE":"D", "EXTENSION":"dir" }, { "LOAD_CODE":"31abffbc019f597dbc688dde6cfa077e", "SYSTEM_NAME":"ACME", "NAME": "AdArea polygons.yxdb", "PATH":"\\\ACME\\AlteryxSampleData\\AdArea polygons.yxdb", "PATH_HASH":"52954616160973d7cd8e29 6e6c383547", "PARENT":"\\\ACME\\AlteryxSampleData\\\\ ", "PARENT_HASH":"2ac01f9c26e5d33908bbd821dee5b7e", "TYPE":" F", "EXTENSION":"yxdb", "SIZE":17420, "CREATED":"2017-08-04 19:40:51 UTC", "LAST_MODIFIED":"2017-08-16 14:08:03 UTC", "ACCESS_TIME":"2017-08-04 19:40:51 UTC", "HIDDEN":0, "READ_ONLY":1 }, { "LOAD_CODE":"31abffbc019f597dbc688dde6cfa077e", SYSTEM_NAME":"ACME", "NAME":"AddressData.yxdb", "PATH":"\\\ACME\\AlteryxSampleData\\AddressData.yxdb", "PATH_HASH":"f47a07120f7fab53f0caf39ae5ba064", "PARENT":"\\\ACME\\\AlteryxSampleData\\\", PARENT_HASH "":" 2ac01f9c26e5d33908bbd821dee5b7e", "TYPE":"F", "EXTENSION":"yxdb", "SIZE":70294, "CRIADO":"2017-08-04 19:40:51 UTC", "LAST_MODIFIED":"2017-08-16 14:08:03 UTC", "ACCESS_TIME":"2017-08-04 19:40:51 UTC", "HIDDEN":0, "READ_ONLY":1 } ]

Upload bem-sucedido retorna a resposta:

Resumo:

Escrevi 88 linhas para "ARQUIVOS"

Excluir tabela de preparo

/REST/1/dbstage/Delete: remover dados de uma tabela de preparo com base em um código de carregamento.

code=31abffbc019f597dbc688dde6cfa077e

A exclusão bem-sucedida retorna a resposta:

{ "isError":falso, "mensagem":"Removeu 88 linhas dos ARQUIVOS de tabela. \Nremovido 1 linhas da tabela FILE_SYSTEMS. \n "," replacer0 ": {" replaceType ":" refreshTables "," refreshTables ": [" espaço reservado-estágios "]}}

Executar Job POST

/REST/1/Jobs/execute: execute o trabalho de carregamento chamado para conectar.

Parâmetros para a execução do trabalho:

• tipo: definido como Sync.
• trabalhos: definido como o nome do trabalho conforme definido na configuração, concluído com o sufixo /_total.

Exemplo de chamada

type=sync&jobs=load-alteryx-fs%2F_total

A execução bem-sucedida retorna a resposta:

{"isError":falsa", mensagem":"1 empregos foram executados"}

Enviar postagem do serviço de configuração

/Rest/1/admin/upload: carregar arquivos de configuração e carregar configurações de trabalho para conectar.

curl --data-binário@configs" .zip" -H "Content-Type: aplicativo/octet-stream" -H "X-File-Name:configs.zip" -H "xf3-login: admin" -H "xf3-password: Conn3ct!" -vvv -X POST https://connect.semanta.cloud/rest/1/admin/upload

Consulte fluxo de trabalho de carregamento de dados.

Ferramentas do designer Connect

O designer usa as ferramentas de conexão para criar JSON válido e enviar o JSON formatado para conectar.

Conectar o Construtor JSON

A ferramenta Connect JSON Builder cria JSON formatado.

• Entrada: o nome do conjunto de dados que contém metadados.
• Parâmetro de entrada: o nome da tabela de onde o conjunto de dados está armazenado. Os nomes e os tipos de dados do DataSet devem corresponder àqueles na tabela de preparo.

Tabelas de preparo padrão

O Connect vem com várias tabelas de preparo padrão: DB_SCHEMAS, DB_TABLES e DB_COLUMNS. O usuário pode gravar nessas tabelas, mas não pode alterar as tabelas.

Conectar saída

A ferramenta conectar saída envia metadados para a API REST para enviar os dados para conectar, chamando serviços da Web em uma única ferramenta.

• Autenticar: conexão com a instância do Connect.
• Excluir etapa: Remova os metadados enviados na execução anterior.
• Inserir etapa: inserir metadados em tabelas de preparo.
• Executar: chame um trabalho para criar e indexar elementos da interface do usuário conforme eles aparecem no Connect.
• Entrada: enviar JSON formatado da ferramenta Connect JSON Builder.

Consulte fluxo de trabalho de carregamento de dados.

Arquivos de configuração

Os arquivos de configuração declaram a estrutura de suas entradas à medida que são exibidas no Connect. Para verificar a configuração padrão fornecida com o Connect, vá para administração > Export > exportar arquivos de configuração.

Campos obrigatórios

• XID: um identificador exclusivo para o registro.
• nome de entrada: o nome do registro.
• Icon: uma representação visual da entrada.

Consulte exemplo de criação de arquivos de configuração.

Documentos de esquema estão disponíveis como arquivos. xsd aqui.