Skip to main content
Formata as linhas de cada grupo usando um formato de saída e retorna os dados formatados como uma string. É semelhante a formatRow, mas funciona com o grupo inteiro e pode usar formatos baseados em blocos.
Todas as linhas de cada grupo são acumuladas em memória antes de a string formatada ser produzida. Em grupos com um número muito grande de linhas, isso pode consumir uma quantidade significativa de memória. Considere usar LIMIT em subconsultas ou dividir grupos grandes para manter o uso de memória sob controle.

Sintaxe

Parâmetros

  • format — Nome do formato de saída, por exemplo JSONEachRow, CSV, TabSeparated.

Argumentos

  • x, y, ... — Expressões a serem formatadas como linhas. Pelo menos um argumento é obrigatório.

Valor retornado

  • Uma String contendo a saída formatada do grupo.
Os nomes das colunas na saída formatada são gerados como c1, c2, … na ordem dos argumentos.A ordem exata das linhas formatadas não é garantida.As configurações de formato da consulta (por exemplo, format_csv_delimiter ou output_format_json_quote_64bit_integers) são capturadas quando a função de agregação é inicializada e usadas para gerar a saída. A configuração output_format_write_statistics é sempre desabilitada, portanto a string formatada nunca contém uma seção de estatísticas.

Tratamento de NULL

Assim como groupArray e groupConcat, groupFormat ignora uma linha quando qualquer um dos seus argumentos é NULL; essas linhas não aparecem na saída formatada. Quando um argumento é do tipo Nullable, o tipo de resultado é Nullable(String), e um grupo em que todas as linhas são ignoradas — assim como um argumento NULL literal sem tipo do tipo Nullable(Nothing) — retorna NULL por meio do combinador genérico Null.

Exemplos

Uso básico com JSONEachRow

Resultado:

groupFormat

Introduzido em: v Formata as linhas de cada grupo usando o formato de saída especificado e retorna o resultado como uma string. O nome do formato é passado como parâmetro, e os argumentos são as colunas a serem formatadas. Os nomes das colunas são gerados como c1, c2, … na saída formatada. Sintaxe
Parâmetros
  • format — Nome do formato de saída. Por exemplo, JSONEachRow, CSV, TabSeparated. String
Argumentos
  • x, y, ... — Expressões a serem formatadas como linhas. Any
Valor retornado Saída formatada do grupo. String Exemplos Uso básico
Query
Response
Última modificação em 23 de julho de 2026