Descrições

funcional

Edite descrições de tabelas, views e colunas e grave-as de volta no servidor como DDL de comentários.

Tabelas, views e colunas podem ter uma descrição, o comentário que o próprio banco de dados armazena junto ao objeto. O SQLly lê essas descrições em todos os lugares em que mostra o esquema (a coluna Comentário do inventário de objetos, a exportação da documentação do esquema, o contexto de IA), e você pode escrevê-las de dois lugares sem escrever à mão a sintaxe de comentários do mecanismo.

Onde editar

  • Editar estrutura - uma Descrição O campo da tabela fica abaixo da lista de colunas, e cada linha de coluna possui sua própria caixa de descrição. As edições de descrição aparecem na lista de alterações como Definir descrição. Na maioria dos mecanismos, os comentários viram script depois das mudanças estruturais; o comentário pertence à coluna, então uma renomeação ou troca de tipo não precisa de instrução extra. No MySQL e MariaDB, onde mudar uma coluna reescreve a definição inteira dela, uma coluna renomeada, com o tipo trocado, com o padrão trocado ou adicionada leva a descrição dentro da mesma cláusula, então ela mantém (ou ganha) o comentário e a mudança estrutural não é desfeita.
  • Propriedades do objeto - o Geral A página de uma tabela ou visão mostra a descrição atual dela em um campo editável depois que ela é lida. Alterá-la marca a página como modificada; Revise as alterações mostra a instrução exata antes de qualquer execução.

Limpar o texto remove a descrição. As duas superfícies seguem as regras de revisão de sempre: Editar estrutura gera o script para uma aba do editor, e Propriedades do objeto executa somente pela folha de revisão.

Se as descrições atuais não puderem ser lidas (um problema de permissões, por exemplo), as duas telas ocultam o campo de descrição e mostram o motivo no lugar. Uma edição nunca gera script a partir de um valor presumido, porque no SQL Server o procedimento correto depende de já existir uma descrição.

O que o SQLly executa em cada mecanismo

MotorDescrição de tabela / viewDescrição da coluna
SQL Server / Azure SQLO MS_Description propriedade estendida: sp_addextendedproperty quando nenhuma existe, sp_updateextendedproperty quando existe um (incluindo um que contém texto vazio), sp_dropextendedproperty para limpar. As views são referenciadas como views.Os mesmos procedimentos no nível da coluna.
PostgreSQLCOMMENT ON TABLE / COMMENT ON VIEW … IS '…'; IS NULL limpa.COMMENT ON COLUMN … IS '…'.
CockroachDBCOMMENT ON TABLE … IS '…'. O CockroachDB não tem COMMENT ON VIEW, então o campo de descrição de uma view fica oculto por esse motivo.COMMENT ON COLUMN … IS '…'.
DuckDBCOMMENT ON TABLE / COMMENT ON VIEW; IS NULL limpa.COMMENT ON COLUMN.
Banco de Dados OracleCOMMENT ON TABLE … IS '…' (Oracle trata views com a palavra-chave TABLE); IS '' limpa.COMMENT ON COLUMN.
MySQL / MariaDBALTER TABLE … COMMENT = '…'. Views não podem armazenar descrição (o servidor reporta o comentário de toda view como VIEW), então o campo da view fica oculto com essa justificativa.O MySQL não tem uma instrução que mude apenas um comentário, então o SQLly executa ALTER TABLE … MODIFY COLUMN. Para uma mudança só de descrição, ele reescreve a coluna exatamente como SHOW CREATE TABLE imprime isso e substitui apenas a cláusula COMMENT '…' cláusula, mantendo todo o resto, incluindo as cláusulas depois do comentário, como no MariaDB, a CHECK (json_valid(…)); se esse texto não puder ser lido, o SQLly se recusa a fazer a alteração em vez de adivinhar. Quando a mesma edição também renomeia, altera o tipo, redefine o valor padrão ou adiciona a coluna, o COMMENT vai para essa CHANGE/MODIFY/ADD cláusula em vez disso.
ClickHouseALTER TABLE … MODIFY COMMENT '…'. Views não podem receber comentários depois de criadas; o SQLly pede para recriar a view com um COMMENT cláusula.ALTER TABLE … COMMENT COLUMN … '…'.
SQLite / libSQLNenhum armazenamento de comentários no servidor. Os campos de descrição estão ocultos e o editor mostra o motivo no lugar deles.

O texto recebe aspas para o mecanismo: aspas internas são duplicadas em todos os casos, e valores do SQL Server são enviados como Unicode N'…' literais, e MySQL e ClickHouse também escapam barras invertidas.

No MySQL e MariaDB, uma coluna que Editar Estrutura renomeia, altera o tipo ou redefine o padrão é reconstruída a partir dos campos do editor: seu tipo, nulidade, padrão, auto-incremento, seu ON UPDATE (para colunas timestamp e datetime), e sua descrição. Uma substituição de conjunto de caracteres ou agrupamento, uma expressão gerada, INVISIBLE, ou um CHECK não é reescrita; quando a definição atual possui um, o script informa isso em uma -- WARNING linha para que você possa adicioná-lo ao tipo antes de executar.

SQLly
Editar estrutura com o campo de descrição da tabela e caixas de descrição por coluna, além das linhas Definir descrição na lista de alterações.Editar estrutura com o campo de descrição da tabela e caixas de descrição por coluna, além das linhas Definir descrição na lista de alterações.
Editar estrutura com o campo de descrição da tabela e caixas de descrição por coluna, além das linhas Definir descrição na lista de alterações.