MySQL: aggiungere commenti a tabelle, campi e query

In MySQL è possibile inserire commenti, cioè annotazioni visibili solo all’amministratore del DBMS che hanno lo scopo di aggiungere promemoria utili alla gestione e/o all’eventuale modifica del database e della sua struttura.

I commenti in MySQL possono essere aggiunti sia all’interno della struttura della tabella (per meglio specificare il ruolo e/o la funzione della tabella o di un singolo campo) che all’interno della sintassi SQL delle query (per meglio specificare il loro funzionamento).

In questa lezione della nostra guida a MySQL vedremo entrambe queste eventualità.

Commenti nella struttura di una tabella MySQL

A livello strutturale i commenti possono essere aggiunti sia a livello di tabella che di campo.

I commenti a livello di tabella possono essere aggiunti in fase di creazione della tabella o di modifica e possono contenere fino ad un massimo di 2048 caratteri. Vediamo due esempi che meglio chiariranno entrambe le eventualità:

Creazione di tabella con commento:

CREATE TABLE clienti (
  id INT(10) NOT NULL auto_increment PRIMARY KEY,
  nome VARCHAR(100),
  cognome VARCHAR(100)
)
ENGINE=INNODB
COMMENT='Questa tabella contiene tutti i clienti del negozio';

Modifica di commento ad una tabella:

ALTER TABLE clienti COMMENT='Questo è il nuovo commento...'

Come detto i commenti non possono essere inseriti solo a livello di tabella ma anche a livello di singolo campo. Vediamo come fare in fase di creazione e modifica della struttura di una tabella.

Inserimento di un commento ad un campo in fase di creazione di tabella:

CREATE TABLE clienti (
  id INT(10) NOT NULL auto_increment PRIMARY KEY COMMENT 'Questo è l\'identificativo numerico del cliente',
  nome VARCHAR(100) COMMENT 'Questo è il nome del cliente',
  cognome VARCHAR(100) COMMENT 'Questo è il cognome del cliente'
)
ENGINE=INNODB;

Modifica di un commento ad un campo di tabella:

ALTER TABLE clienti MODIFY id INT(10) COMMENT 'Cambio il commento al campo...';

Commenti all’interno di una query MySQL

Come detto i commenti possono essere inseriti anche all’interno delle query SQL al fine di indicare all’amministratore di sistema la sintassi di alcuni comandi.

I commenti possono essere inseriti all’interno delle query SQL mediante differenti sintassi:

SELECT 1+1; # Questo è un commento in linea e prosegue fino al ritorno a capo
SELECT 1+1; -- Anche questo è un commento in linea e funziona come il precedente
SELECT 1 /* Questo commento è delimitato da un marcatore di inizio ed uno di fine */ + 1;

Come abbiamo visto esistono tre diverse sintassi per i commenti nelle query di MySQL:

• i commenti su singola linea preceduti dal simbolo cancelletto (#)
• i commenti su singola linea preceduti dal simbolo del doppio trattino (–)
• i commenti incapsulati tra /* e */: questa tipologia di commenti può essere anche su più linee

Vediamo un esempio di commento multilinea in una query MySQL:

/*
Questo è un commento
su più di una linea
all'interno di una query
*/
SELECT 1+1;

L’aggiunta di commenti alle query è consigliata soprattutto se si tratta di istruzioni particolarmente lunghe e complesse e che si suppone potranno essere modificate dallo stesso sviluppatore che le ha ideate o da altri fruitori del sistema. Come in tutti i linguaggi di sviluppo, l’aggiunta di commenti rappresenta una buona prassi nell’ottica di una migliore manutenzione e aggiornabilità del database.