COMENTARIO – define o cambia el comentario de un objeto

Sinopsis

COMMENTON

  SEQUENCE object_name  IS'text'where aggregate_signature is:

*|[ argmode ][ argname ] argtype [,...]|[[ argmode ][ argname ] argtype [,...]]ORDERBY[ argmode ][ argname ] argtype [,...]

Descripción

COMMENT almacena un comentario sobre un objeto de base de datos.

Solo un comentario string se almacena para cada objeto, por lo que para modificar un comentario, emita un nuevo COMMENT comando para el mismo objeto. Para eliminar un comentario, escriba NULL en lugar del texto string. Los comentarios se eliminan automáticamente cuando se elimina su objeto.

Para la mayoría de los tipos de objetos, solo el propietario del objeto puede establecer el comentario. Los roles no tienen propietarios, por lo que la regla para COMMENT ON ROLE es que debe ser superusuario para comentar sobre un rol de superusuario, o tener la CREATEROLE privilegio de comentar sobre roles que no sean de superusuario. Asimismo, los métodos de acceso tampoco tienen propietarios; debe ser superusuario para comentar sobre un método de acceso. Por supuesto, un superusuario puede comentar cualquier cosa.

Los comentarios se pueden ver usando psql d familia de comandos. Se pueden construir otras interfaces de usuario para recuperar comentarios sobre las mismas funciones integradas que usa psql, a saber obj_description, col_description, y shobj_description (ver Tabla 9.73).

Parámetros

object_namerelation_name.column_nameaggregate_nameconstraint_namefunction_nameoperator_namepolicy_nameprocedure_nameroutine_namerule_nametrigger_name

El nombre del objeto que se va a comentar. Los nombres de tablas, agregados, intercalaciones, conversiones, dominios, tablas externas, funciones, índices, operadores, clases de operadores, familias de operadores, procedimientos, rutinas, secuencias, estadísticas, objetos de búsqueda de texto, tipos y vistas pueden calificarse según el esquema. Al comentar una columna, relation_name debe hacer referencia a una tabla, vista, tipo compuesto o tabla externa.

table_namedomain_name

Al crear un comentario sobre una restricción, un activador, una regla o una política, estos parámetros especifican el nombre de la tabla o dominio en el que se define ese objeto.

source_type

El nombre del tipo de datos de origen de la transmisión.

target_type

El nombre del tipo de datos de destino del reparto.

argmode

El modo de una función, procedimiento o argumento agregado: IN, OUT, INOUT, o VARIADIC. Si se omite, el valor predeterminado es IN. Tenga en cuenta que COMMENT en realidad no presta atención a OUT argumentos, ya que solo se necesitan los argumentos de entrada para determinar la identidad de la función. Por tanto, basta con enumerar los IN, INOUT, y VARIADIC argumentos.

argname

El nombre de una función, procedimiento o argumento agregado. Tenga en cuenta que COMMENT en realidad, no presta atención a los nombres de los argumentos, ya que solo se necesitan los tipos de datos de los argumentos para determinar la identidad de la función.

argtype

El tipo de datos de una función, procedimiento o argumento agregado.

large_object_oid

El OID del objeto grande.

left_typeright_type

Los tipos de datos de los argumentos del operador (opcionalmente calificados por esquema). Escribir NONE por el argumento faltante de un prefix o operador de sufijo.

PROCEDURAL

Esta es una palabra ruidosa.

type_name

El nombre del tipo de datos de la transformación.

lang_name

El nombre del idioma de la transformación.

text

El nuevo comentario, escrito como string literal; o NULL para soltar el comentario.

Notas

Actualmente no existe ningún mecanismo de seguridad para ver los comentarios: cualquier usuario conectado a una base de datos puede ver todos los comentarios de los objetos en esa base de datos. Para objetos compartidos como bases de datos, roles y espacios de tabla, los comentarios se almacenan globalmente para que cualquier usuario conectado a cualquier base de datos del clúster pueda ver todos los comentarios de los objetos compartidos. Por lo tanto, no incluya información crítica para la seguridad en los comentarios.

Ejemplos de

Adjuntar un comentario a la tabla mytable:

COMMENTONTABLE mytable IS'This is my table.';

Retirarlo de nuevo:

COMMENTONTABLE mytable ISNULL;

Algunos ejemplos más:

COMMENTON ACCESS METHOD gin IS'GIN index access method';COMMENTON AGGREGATE my_aggregate (doubleprecision)IS'Computes sample variance';COMMENTON CAST (textAS int4)IS'Allow casts from text to int4';COMMENTON COLLATION "fr_CA"IS'Canadian French';COMMENTONCOLUMN my_table.my_column IS'Employee ID number';COMMENTON CONVERSION my_conv IS'Conversion to UTF8';COMMENTONCONSTRAINT bar_col_cons ON bar IS'Constrains column col';COMMENTONCONSTRAINT dom_col_constr ON DOMAIN dom IS'Constrains col of domain';COMMENTONDATABASE my_database IS'Development Database';COMMENTON DOMAIN my_domain IS'Email Address Domain';COMMENTON EVENT TRIGGER abort_ddl IS'Aborts all DDL commands';COMMENTON EXTENSION hstore IS'implements the hstore data type';COMMENTONFOREIGNDATA WRAPPER mywrapper IS'my foreign data wrapper';COMMENTONFOREIGNTABLE my_foreign_table IS'Employee Information in other database';COMMENTONFUNCTION my_function (timestamp)IS'Returns Roman Numeral';COMMENTONINDEX my_index IS'Enforces uniqueness on employee ID';COMMENTONLANGUAGE plpython IS'Python support for stored procedures';COMMENTON LARGE OBJECT 346344IS'Planning document';COMMENTON MATERIALIZED VIEW my_matview IS'Summary of order history';COMMENTON OPERATOR ^(text,text)IS'Performs intersection of two texts';COMMENTON OPERATOR -(NONE,integer)IS'Unary minus';COMMENTON OPERATOR CLASS int4ops USINGbtreeIS'4 byte integer operators for btrees';COMMENTON OPERATOR FAMILY integer_ops USINGbtreeIS'all integer operators for btrees';COMMENTON POLICY my_policy ON mytable IS'Filter rows by users';COMMENTONPROCEDURE my_proc (integer,integer)IS'Runs a report';COMMENTON PUBLICATION alltables IS'Publishes all operations on all tables';COMMENTON ROLE my_role IS'Administration group for finance tables';COMMENTONROUTINE my_routine (integer,integer)IS'Runs a routine (which is a function or procedure)';COMMENTONRULE my_rule ON my_table IS'Logs updates of employee records';COMMENTONSCHEMA my_schema IS'Departmental data';COMMENTON SEQUENCE my_sequence IS'Used to generate primary keys';COMMENTON SERVER myserver IS'my foreign server';COMMENTONSTATISTICS my_statistics IS'Improves planner row estimations';COMMENTON SUBSCRIPTION alltables IS'Subscription for all operations on all tables';COMMENTONTABLE my_schema.my_table IS'Employee Information';COMMENTONTABLESPACE my_tablespace IS'Tablespace for indexes';COMMENTONTEXT SEARCH CONFIGURATION my_config IS'Special word filtering';COMMENTONTEXT SEARCH DICTIONARY swedish IS'Snowball stemmer for Swedish language';COMMENTONTEXT SEARCH PARSER my_parser IS'Splits text into words';COMMENTONTEXT SEARCH TEMPLATE snowball IS'Snowball stemmer';COMMENTON TRANSFORM FOR hstore LANGUAGE plpythonu IS'Transform between hstore and Python dict';COMMENTONTRIGGER my_trigger ON my_table IS'Used for RI';COMMENTONTYPE complex IS'Complex number data type';COMMENTONVIEW my_view IS'View of departmental costs';

Compatibilidad

No hay COMMENT comando en el estándar SQL.

Anterior Hasta próximo
GRUPO Hogar COMETER