Fornece um meio de exibir os comentários de campo (metadados) das bases de dados e planilhas. Os nomes de campo não presentes no aplicativo serão ignorados. Se houver várias ocorrências de um nome de campo, será usado o último valor.
Sintaxe:
comment [fields] *fieldlist using mapname
comment [field] fieldname with comment
A tabela de mapas usada deverá ter duas colunas: a primeira contendo nomes de campo e a segunda contendo comentários.
Argumentos:
| Argumento | Descrição |
|---|---|
| *fieldlist | Uma lista separada por vírgula dos campos a serem comentados. O uso de * como lista de campos indica todos os campos. Os caracteres curingas * e ? são permitidos nos nomes de campo. Poderá ser necessário colocar os nomes de campos entre aspas quando forem utilizados caracteres curinga. |
| mapname | O nome de uma tabela de mapeamento lida anteriormente em um comando de mapeamento LOAD ou SELECT. |
| fieldname | Nome do campo que deve ser comentado. |
| comment | O comentário que deve ser incluído no campo. |
Exemplo 1:
commentmap:
mapping LOAD * inline [
a,b
Alpha,This field contains text values
Num,This field contains numeric values
];
comment fields using commentmap;
Exemplo 2:
comment field Alpha with AFieldContainingCharacters;
comment field Num with '*A field containing numbers';
comment Gamma with 'Mickey Mouse field';