Banco de dados externo

Introdução

O banco de dados externo é usado para conectar bancos de dados empresariais existentes ao NocoBase, ler as tabelas, os campos e as visualizações desses bancos e permitir que essas tabelas sejam usadas em blocos de página, permissões, fluxos de trabalho e APIs.

Diferentemente do banco de dados principal, a estrutura das tabelas do banco de dados externo é mantida pelo sistema original ou pelo cliente de banco de dados. O NocoBase é responsável por ler a estrutura das tabelas e as visualizações, sem modificar a estrutura real das tabelas do banco de dados externo.

As versões de banco de dados e as edições comerciais compatíveis com bancos de dados externos são:

Banco de dados	Versões compatíveis	Edição Community	Edição Standard	Edição Professional	Edição Enterprise
MySQL	>= 5.7	❌	✅	✅	✅
PostgreSQL	>= 9.5	❌	✅	✅	✅
MariaDB	>= 10.3	❌	✅	✅	✅
MSSQL	2014-2019	❌	✅	✅	✅
KingbaseES	>=V9	❌	❌	✅	✅
OceanBase	>=4.3	❌	❌	❌	✅
Oracle	>= 11g	❌	❌	❌	✅
ClickHouse	>= 20.2	❌	❌	❌	✅
Doris	>= 2.1.0	❌	❌	❌	✅

Observação

O KingbaseES é compatível apenas com o modo de compatibilidade do PostgreSQL; OceanBase, ClickHouse e Doris são compatíveis apenas com o modo de compatibilidade do MySQL.

Cenários aplicáveis para bancos de dados externos:

Conectar bancos de dados de sistemas empresariais existentes, como ERP, MES e WMS antigos, e aproveitar os recursos do NocoBase para criar rapidamente interfaces de gerenciamento, controle de permissões, fluxos de trabalho e relatórios sem modificar a estrutura das tabelas do banco de dados original.
Adicionar recursos leves a sistemas existentes, como aprovações, correção de dados, tratamento de exceções e painéis operacionais, sem precisar substituir o sistema original.
Realizar consultas somente leitura, análises estatísticas ou exibições de BI em bancos de dados existentes, reduzindo a dependência das páginas do sistema empresarial original.
Migrar sistemas históricos por etapas: primeiro conectar o banco de dados antigo ao NocoBase e continuar usando-o; depois, migrar gradualmente os novos dados empresariais para serem mantidos no banco de dados principal.
A estrutura do banco de dados continua sendo mantida pelo DBA, por scripts de migração ou pelo sistema empresarial original; o NocoBase é responsável apenas por ler a estrutura, configurar a interface e usar os dados.

Atenção

O banco de dados externo não é o banco de dados do sistema NocoBase. O NocoBase não assume o backup, a restauração, a migração nem a estrutura das tabelas do banco de dados externo; essas operações continuam precisando ser realizadas no próprio banco de dados externo.

Instalação do plugin

Os bancos de dados externos são fornecidos pelos respectivos plugins de fonte de dados. Depois de instalar e ativar o plugin, será possível selecionar o tipo de banco de dados correspondente no menu 「Add new」 de 「Gerenciamento de fontes de dados」.

Banco de dados	Plugin correspondente	Método de instalação
MySQL	`@nocobase/plugin-data-source-external-mysql`	É necessária uma licença comercial; instale e ative o plugin antes de usá-lo.
PostgreSQL	`@nocobase/plugin-data-source-external-postgres`	É necessária uma licença comercial; instale e ative o plugin antes de usá-lo.
MariaDB	`@nocobase/plugin-data-source-external-mariadb`	É necessária uma licença comercial; instale e ative o plugin antes de usá-lo.
KingbaseES	`@nocobase/plugin-data-source-kingbase`	É necessária uma licença comercial; instale e ative o plugin antes de usá-lo.
OceanBase	`@nocobase/plugin-data-source-oceanbase`	É necessária uma licença comercial; instale e ative o plugin antes de usá-lo.
MSSQL	`@nocobase/plugin-data-source-external-mssql`	É necessária uma licença comercial; instale e ative o plugin antes de usá-lo.
Oracle	`@nocobase/plugin-data-source-external-oracle`	É necessária uma licença comercial; instale e ative o plugin antes de usá-lo.
ClickHouse	`@nocobase/plugin-data-source-external-clickhouse`	É necessária uma licença comercial; instale e ative o plugin antes de usá-lo.
Doris	`@nocobase/plugin-data-source-external-doris`	É necessária uma licença comercial; instale e ative o plugin antes de usá-lo.

add_new_database

Se o tipo de banco de dados desejado não aparecer no menu 「Add new」, geralmente é necessário verificar primeiro:

se o plugin correspondente já foi instalado
se o plugin já foi ativado
se a licença comercial atual inclui esse plugin
se o usuário atual tem permissão para gerenciar fontes de dados

Instruções de uso

Adicionar um banco de dados externo

Depois de ativar o plugin, será possível selecionar e adicionar o banco de dados no menu suspenso Add new do gerenciamento de fontes de dados.

20240507204316

Preencha as informações do banco de dados que deseja conectar

20240507204820

Sincronização de tabelas

Depois que a conexão com o banco de dados externo for estabelecida, todas as tabelas de dados da fonte serão lidas diretamente. O banco de dados externo não permite adicionar tabelas nem modificar diretamente a estrutura das tabelas. Para fazer alterações, use um cliente de banco de dados e, em seguida, clique no botão 「Atualizar」 na interface para sincronizar.

20240507204725

Configuração de campos

O banco de dados externo lê automaticamente os campos das tabelas existentes e os exibe. É possível visualizar e configurar rapidamente o título, o tipo de dados (Field type) e o tipo de interface do usuário (Field interface) dos campos. Também é possível clicar no botão 「Editar」 para modificar outras configurações.

20240507210537

Como o banco de dados externo não permite modificar a estrutura das tabelas, ao adicionar campos, o único tipo disponível é o campo de relacionamento. Os campos de relacionamento não são campos reais; eles são usados para estabelecer conexões entre tabelas.

20240507220140

Para obter mais informações, consulte o capítulo Campos de tabela de dados / Visão geral.

Mapeamento de tipos de campo

O NocoBase mapeia automaticamente os tipos de campo do banco de dados externo para os tipos de dados correspondentes (Field type) e tipos de interface do usuário (Field Interface).

Tipo de dados (Field type): usado para definir os tipos, formatos e estruturas de dados que o campo pode armazenar;
Tipo de interface do usuário (Field interface): refere-se ao tipo de controle usado para exibir e inserir valores de campo na interface do usuário.

PostgreSQL	MySQL/MariaDB	NocoBase Data Type	NocoBase Interface Type
BOOLEAN	BOOLEAN TINYINT(1)	boolean	checkbox switch
SMALLINT INTEGER SERIAL SMALLSERIAL	TINYINT SMALLINT MEDIUMINT INTEGER	integer boolean sort	integer sort checkbox switch select radioGroup
BIGINT BIGSERIAL	BIGINT	bigInt sort	integer sort checkbox switch select radioGroup unixTimestamp createdAt updatedAt
REAL	FLOAT	float	number percent
DOUBLE PRECISION	DOUBLE PRECISION	double	number percent
DECIMAL NUMERIC	DECIMAL	decimal	number percent currency
VARCHAR CHAR	VARCHAR CHAR	string password uuid nanoid	input email phone password color icon select radioGroup uuid nanoid
TEXT	TEXT TINYTEXT MEDIUMTEXT LONGTEXT	text json	textarea markdown vditor richText url json
UUID	-	uuid	uuid
JSON JSONB	JSON	json	json
TIMESTAMP	DATETIME TIMESTAMP	date	date time createdAt updatedAt
DATE	DATE	dateOnly	datetime
TIME	TIME	time	time
-	YEAR		datetime
CIRCEL		circle	json circle
PATH GEOMETRY(LINESTRING)	LINESTRING	lineString	Json lineString
POINT GEOMETRY(POINT)	POINT	point	json point
POLYGON GEOMETRY(POLYGON)	POLYGON	polygon	json polygon
GEOMETRY	GEOMETRY	-	-
BLOB	BLOB	blob	-
ARRAY	-	array	multipleSelect checkboxGroup
BIT	BIT	-	-
SET	SET	set	multipleSelect checkboxGroup
RANGE	-	-	-

Tipos de campo não compatíveis

Os tipos de campo não compatíveis serão exibidos separadamente. Esses campos só poderão ser usados depois que forem adaptados.

20240507221854

Identificador exclusivo do registro

As tabelas de dados usadas para exibição em blocos precisam ter uma 「chave exclusiva do registro」 (Record unique key). A chave exclusiva do registro é usada para localizar um registro em um bloco de página; normalmente, escolhe-se a chave primária ou um campo exclusivo.

No caso de visualizações, tabelas sem chave primária ou tabelas com chave primária composta, é necessário definir manualmente a 「Record unique key」 na configuração da tabela de dados. Quando não houver um identificador exclusivo disponível, talvez os blocos de página não consigam ser criados corretamente, nem visualizar ou editar registros. Para obter mais informações, consulte Banco de dados principal / Editar tabela de dados.

edit_collection

edit_collection_configure

#Banco de dados externo

#Introdução

#Instalação do plugin

#Instruções de uso

#Adicionar um banco de dados externo

#Sincronização de tabelas

#Configuração de campos

#Mapeamento de tipos de campo

#Tipos de campo não compatíveis

#Identificador exclusivo do registro