Descripción
system.* específicas de cada tipo.
La description se compone a partir de las partes estructuradas de la documentación integrada (description, syntax, argumentos, ejemplos, etc.), de modo que una sola columna contiene la documentación completa de una entidad. Cuando la documentación integrada contiene en su description toda la página de referencia (como ocurre con los componentes cuyas páginas web se generan automáticamente a partir de ella: motores de tabla, motores de base de datos, tipos de datos, formatos y funciones de tabla), la página se publica tal cual, sin añadir secciones compuestas a partir de los campos de metadatos estructurados, ya que el cuerpo de la página ya cubre ese material. Los alias se muestran como una referencia breve a la entidad canónica; por ejemplo, Alias of `trunc`.
Esta tabla, en cierto modo, recopila la información disponible en las tablas de documentación específicas de cada tipo (system.functions, system.table_engines, system.data_type_families y otras). Está pensada, en particular, como base para un comando help interactivo en el client, pero también es útil por sí sola.
Se recopilan los siguientes tipos de entidades (el valor de la columna type se muestra entre paréntesis):
- Funciones (
Function) - Funciones de agregación (
Aggregate Function) - Funciones de tabla (
Table Function) - Motores de tabla (
Table Engine) - Motores de base de datos (
Database Engine) - Tipos de datos (
Data Type) - Diseños de diccionario (
Dictionary Layout) - Fuentes de diccionario (
Dictionary Source) - Combinadores de funciones de agregación (
Aggregate Function Combinator) - Tipos de índices de omisión de datos (
Data Skipping Index) - Tipos de disco (
Disk Type) - Ajustes (
Setting) - Ajustes de MergeTree (
MergeTree Setting) - Ajustes del servidor (
Server Setting) - Formatos (
Format) - Códecs de compresión (
Compression Codec) - Eventos de perfil (
Profile Event) - Métricas actuales (
Current Metric) - Métricas asincrónicas (
Asynchronous Metric) - Tablas del sistema (
System Table)
source contiene la ruta del archivo fuente donde se define la documentación de la entidad, relativa a la raíz del repositorio. Para la mayoría de las entidades, se captura automáticamente en el lugar donde se construye el objeto de documentación (el punto de registro del componente); para los tipos que se documentan cada uno en un único archivo fuente (como los ajustes, los eventos de perfil y las métricas actuales), ese archivo es el que se usa.
Columnas
name(String) — El nombre de la entidad, p. ej.domainWithoutWWWoMergeTree.type(Enum8(‘Function’ = 1, ‘Aggregate Function’ = 2, ‘Table Function’ = 3, ‘Table Engine’ = 4, ‘Database Engine’ = 5, ‘Data Type’ = 6, ‘Dictionary Layout’ = 7, ‘Dictionary Source’ = 8, ‘Aggregate Function Combinator’ = 9, ‘Data Skipping Index’ = 10, ‘Disk Type’ = 11, ‘Setting’ = 12, ‘MergeTree Setting’ = 13, ‘Server Setting’ = 14, ‘Format’ = 15, ‘Compression Codec’ = 16, ‘Profile Event’ = 17, ‘Current Metric’ = 18, ‘Asynchronous Metric’ = 19, ‘System Table’ = 20)) — El tipo de la entidad, p. ej.FunctionoTable Engine.description(String) — La documentación de referencia de la entidad en formato Markdown, generada a partir de la documentación integrada (el mismo contenido que se publica en el sitio web), incluida la sintaxis, los ejemplos y otras partes estructuradas, si las hay.source(String) — La ruta al archivo fuente donde se define la documentación de la entidad, relativa a la raíz del repositorio. Vacío si se desconoce la ubicación del archivo fuente.
Ejemplo
Query
file como el origen del diccionario file), por lo que conviene buscar ese nombre en todos los tipos:
Query
Query
Véase también
system.functions— Funciones normales y de agregación.system.table_functions— Funciones de tabla.system.table_engines— Motores de tabla.system.database_engines— Motores de base de datos.system.data_type_families— Tipos de datos.system.disk_types— Tipos de disco.system.settings— Ajustes.system.merge_tree_settings— Ajustes de MergeTree.system.server_settings— Ajustes del servidor.system.formats— Formatos.