Paramètres de format output_format_*

Ces paramètres sont générés automatiquement à partir du code source.

Toujours afficher un point décimal pour les nombres en virgule flottante et Decimal dans les formats texte, même lorsque la valeur est un nombre entier. Par exemple, afficher 1. au lieu de 1.

Désactivé par défaut.

Méthode de compression pour le format de sortie Arrow. Codecs pris en charge : lz4_frame, zstd, none (sans compression)

Écrit les valeurs Date sous forme de simples nombres 16 bits (relus en tant que UInt16), au lieu de les convertir en type Arrow DATE32 32 bits (relu en tant que Date32).

Utilise le type Arrow FIXED_SIZE_BINARY au lieu de Binary pour les colonnes de type FixedString.

Active la sortie du type LowCardinality sous forme de type Dictionary d’Arrow

Utiliser le type Arrow String au lieu de Binary pour les colonnes de type String

Les types de sortie sans conversion sont émis sous forme de données binaires brutes. Si false, ces types génèrent une exception UNKNOWN_TYPE.

Toujours utiliser des entiers sur 64 bits pour les index de dictionnaire au format Arrow

Utiliser des entiers signés pour les index de dictionnaire au format Arrow

Codec de compression utilisé pour la sortie. Valeurs possibles : 'null', 'deflate', 'snappy', 'zstd'.

Pour le format de sortie AvroConfluent : le nom du sujet sous lequel le schéma est enregistré dans Confluent Schema Registry. Obligatoire lors de l’écriture au format de sortie AvroConfluent.

Nombre maximal de lignes dans un fichier (si le stockage le permet)

Pour le format Avro : expression régulière des colonnes de type String à sélectionner comme chaînes AVRO.

Intervalle de synchronisation, en octets.

Écrire les types de données au format binaire au lieu des noms de type dans le format de sortie RowBinaryWithNamesAndTypes

Écrit les valeurs de type JSON sous forme de valeurs String contenant du JSON dans le format de sortie RowBinary.

Utilise le type BSON String au lieu de Binary pour les colonnes de type String.

Niveau de compression par défaut si la sortie de la requête est compressée. Ce paramètre s'applique lorsque la requête SELECT contient INTO OUTFILE ou lors de l'écriture dans les fonctions de table file, url, hdfs, s3 ou azureBlobStorage.

Valeurs possibles : de 1 à 22

Peut être utilisé lorsque la méthode de compression de sortie est zstd. Si ce paramètre est supérieur à 0, il définit explicitement la taille de la fenêtre de compression (puissance de 2) et active un mode longue portée pour la compression zstd. Cela peut permettre d'obtenir un meilleur taux de compression.

Valeurs possibles : nombres non négatifs. Notez que si la valeur est trop petite ou trop grande, zstdlib lèvera une exception. Les valeurs typiques vont de 20 (taille de fenêtre = 1MB) à 30 (taille de fenêtre = 1GB).

Si cette option est réglée sur true, la fin de ligne au format CSV sera \r\n au lieu de \n.

Lorsque output_format_csv_serialize_tuple_into_separate_columns est activé, les lignes d’en-tête de CSVWithNames et CSVWithNamesAndTypes développent chaque colonne Tuple non imbriquée en ses champs feuilles (noms pointés comme t.a, t.b, ainsi que les noms de type des feuilles), de sorte que l’en-tête comporte le même nombre de colonnes que les données. Une colonne Nullable(Tuple) n’est jamais développée (ses données restent un seul champ CSV), donc son en-tête conserve l’unique nom et type de colonne de niveau supérieur. Pour CustomSeparated*, cet aplatissement s’applique uniquement lorsque format_custom_escaping_rule = 'CSV' et que format_custom_field_delimiter est un caractère unique identique à format_csv_delimiter ; sinon (par exemple avec le délimiteur de tabulation par défaut ou format_custom_field_delimiter = '|'), l’en-tête n’est pas aplati afin de continuer à correspondre aux données. Définissez-le sur 0 pour conserver le comportement précédent, où l’en-tête garde le nom et le type uniques du Tuple de niveau supérieur.

Remarque : un en-tête aplati n’est pas relu dans un Tuple par nom lorsque input_format_with_names_use_header = 1. Pour relire ces données dans un Tuple, définissez soit ce paramètre sur 0 en sortie, soit lisez-les avec input_format_with_names_use_header = 0 (et, pour les formats *WithNamesAndTypes CSVWithNamesAndTypes et CustomSeparatedWithNamesAndTypes, également input_format_with_types_use_header = 0, car la ligne de types aplatie est sinon validée par rapport à l’unique champ Tuple d’entrée de niveau supérieur, puis rejetée).

Si ce paramètre est défini sur true, les colonnes Tuple utilisées seules au format CSV sont sérialisées en colonnes distinctes (c’est-à-dire que leur imbrication dans le tuple est perdue).

Cet aplatissement s’applique uniquement aux Tuple utilisés seuls. Un Nullable(Tuple) est toujours sérialisé comme un seul champ CSV (afin que les lignes NULL et non-NULL occupent le même nombre de champs), indépendamment de ce paramètre.

Affiche les zéros non significatifs lors de l’affichage des valeurs Decimal. Par ex. 1.230000 au lieu de 1.23.

Désactivé par défaut.

Lorsqu'elle est différente de zéro, formate la sortie des nombres à virgule flottante (Float32, Float64, BFloat16) avec au plus ce nombre de chiffres après le séparateur décimal (les zéros de fin sont supprimés). Lorsque la valeur est 0 (par défaut), utilise la représentation aller-retour la plus courte.

Les valeurs trop grandes pour la notation fixe, ainsi que les valeurs dont la valeur absolue est si faible qu'un arrondi à la précision demandée ferait perdre tous les chiffres significatifs (la mantisse deviendrait ±0), sont émises en notation scientifique à la place. Dans ces cas, la mantisse peut comporter plus de chiffres fractionnaires que le nombre demandé.

Plage valide : de 0 à 100.

Hauteur, en pixels, de l’image produite pour les formats de sortie d’image tels que PNG.

Valeur par défaut : 1024.

Pour les formats de sortie d’images tels que PNG, écrivez chaque image d’une animation dès que la valeur suivante de la colonne t est reçue, au lieu de mettre toutes les images en mémoire tampon jusqu’à la fin de la requête.

Une seule image est conservée en mémoire, et les images sont écrites dans la sortie alors que la requête est encore en cours d’exécution. En contrepartie, les valeurs de t doivent être non décroissantes, faute de quoi la requête lève une exception. De plus, le nombre d’images n’est pas connu lorsque l’en-tête de l’animation doit être écrit : le nombre déclaré constitue donc une borne supérieure plutôt que la valeur exacte. Les navigateurs peuvent lire un tel fichier, mais les décodeurs qui se fient au nombre déclaré signalent une erreur après la dernière image réelle.

Valeur par défaut : false.

Pour les formats de sortie d’image tels que PNG, affichez l’image directement dans le terminal à l’aide d’un protocole d’image intégré au lieu d’écrire les octets bruts de l’image.

Valeurs possibles :

• `` (vide) — écrire les octets bruts de l’image (par défaut).
• iterm — utiliser le protocole d’image intégré d’iTerm2.
• kitty — utiliser le protocole graphique Kitty.
• sixel — utiliser le protocole Sixel.
• auto — si la sortie est un terminal, détecter ses capacités et utiliser iterm, kitty ou sixel (dans cet ordre) ; sinon, écrire les octets bruts de l’image.

Valeur par défaut : `` (vide).

Le dénominateur, en secondes, de l'unité de temps de la colonne t pour les formats de sortie d'image tels que PNG.

Consultez output_format_image_time_multiplier_seconds.

Valeur par défaut : 60.

Le numérateur de l'unité de temps de la colonne t, en secondes, pour les formats de sortie d'images tels que PNG.

La présence d'une colonne t fait que le format produit une animation, dans laquelle t représente le décalage temporel relatif de l'image. Une unité de t correspond à output_format_image_time_multiplier_seconds / output_format_image_time_divisor_seconds secondes. Avec les valeurs par défaut (1 et 60), une unité de t correspond à 1/60 de seconde.

Valeur par défaut : 1.

Largeur, en pixels, de l’image de sortie pour les formats de sortie d’image tels que PNG.

Valeur par défaut : 1024.

Permet de renvoyer toutes les lignes sous la forme d’un tableau JSON au format JSONEachRow.

Valeurs possibles :

• 1 — ClickHouse renvoie toutes les lignes sous la forme d’un tableau, chaque ligne étant au format JSONEachRow.
• 0 — ClickHouse renvoie chaque ligne séparément au format JSONEachRow.

Exemple de requête avec le paramètre activé

Requête :

SET output_format_json_array_of_rows = 1;
SELECT number FROM numbers(3) FORMAT JSONEachRow;

Résultat :

[
{"number":"0"},
{"number":"1"},
{"number":"2"}
]

Exemple de requête avec le paramètre désactivé

Requête :

SET output_format_json_array_of_rows = 0;
SELECT number FROM numbers(3) FORMAT JSONEachRow;

Résultat :

{"number":"0"}
{"number":"1"}
{"number":"2"}

Contrôle l’échappement des slashs dans les chaînes de sortie au format de sortie JSON. Ce paramètre vise à assurer la compatibilité avec JavaScript. Ne pas confondre avec les antislashs, qui sont toujours échappés.

Activé par défaut.

Sérialise les colonnes de type Map sous forme de tableaux JSON de tuples.

Désactivé par défaut.

Sérialise les colonnes de tuples nommés sous forme d’objets JSON.

Activé par défaut.

Ce paramètre détermine la manière dont les structures imbriquées telles que les Tuples, les Maps et les Arrays sont affichées dans le tableau data lors de l’utilisation du format de sortie JSON.

Par exemple, au lieu de la sortie suivante :

"data":
[
  {
    "tuple": {"a":1,"b":2,"c":3},
    "array": [1,2,3],
    "map": {"a":1,"b":2,"c":3}
  }
],

La sortie se présentera comme suit :

"data":
[
    {
        "tuple": {
            "a": 1,
            "b": 2,
            "c": 3
        },
        "array": [
            1,
            2,
            3
        ],
        "map": {
            "a": 1,
            "b": 2,
            "c": 3
        }
    }
],

Activé par défaut.

Contrôle la mise entre guillemets des Float 64 bits lorsqu'ils sont générés dans les formats JSON*.

Désactivé par défaut.

Contrôle la mise entre guillemets des entiers de 64 bits ou plus (par exemple UInt64 ou Int128) lorsqu'ils sont renvoyés au format JSON. Par défaut, ces entiers sont entourés de guillemets. Ce comportement est compatible avec la plupart des implémentations JavaScript.

Valeurs possibles :

• 0 — Les entiers sont renvoyés sans guillemets.
• 1 — Les entiers sont entourés de guillemets.

Contrôle la mise entre guillemets des valeurs décimales dans les formats de sortie JSON.

Désactivé par défaut.

Permet d’afficher les sorties +nan, -nan, +inf, -inf dans le format de sortie JSON.

Valeurs possibles :

• 0 — Désactivé.
• 1 — Activé.

Exemple

Considérez la table account_orders suivante :

┌─id─┬─name───┬─duration─┬─period─┬─area─┐
│  1 │ Andrew │       20 │      0 │  400 │
│  2 │ John   │       40 │      0 │    0 │
│  3 │ Bob    │       15 │      0 │ -100 │
└────┴────────┴──────────┴────────┴──────┘

Lorsque output_format_json_quote_denormals = 0, la requête renvoie des valeurs null en sortie :

SELECT area/period FROM account_orders FORMAT JSON;

{
        "meta":
        [
                {
                        "name": "divide(area, period)",
                        "type": "Float64"
                }
        ],

        "data":
        [
                {
                        "divide(area, period)": null
                },
                {
                        "divide(area, period)": null
                },
                {
                        "divide(area, period)": null
                }
        ],

        "rows": 3,

        "statistics":
        {
                "elapsed": 0.003648093,
                "rows_read": 3,
                "bytes_read": 24
        }
}

Lorsque output_format_json_quote_denormals = 1, la requête renvoie :

{
        "meta":
        [
                {
                        "name": "divide(area, period)",
                        "type": "Float64"
                }
        ],

        "data":
        [
                {
                        "divide(area, period)": "inf"
                },
                {
                        "divide(area, period)": "-nan"
                },
                {
                        "divide(area, period)": "-inf"
                }
        ],

        "rows": 3,

        "statistics":
        {
                "elapsed": 0.000070241,
                "rows_read": 3,
                "bytes_read": 24
        }
}

Ignore les paires clé-valeur dont la valeur est nulle lors de la sérialisation des colonnes de tuples nommés en objets JSON. Ce paramètre n’est valide que lorsque output_format_json_named_tuples_as_objects vaut true.

Contrôle la validation des séquences UTF-8 dans les formats de sortie JSON. N'affecte pas les formats JSON/JSONCompact/JSONColumnsWithMetadata, qui valident toujours l’UTF-8.

Désactivé par défaut.

Lorsqu’il est activé, les caractères spéciaux sont échappés en Markdown.

Common Mark définit les caractères spéciaux suivants, qui peuvent être échappés :

! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

Valeurs possibles :

• 0 — Désactivé.
• 1 — Activé.

Définit la manière dont un UUID est représenté en sortie au format MsgPack.

Écrire les types de données au format binaire au lieu des nom de type dans le format de sortie Native

Écrire les données des colonnes JSON et Dynamic dans un format aplati (tous les types/chemins comme sous-colonnes distinctes).

Écrit les données d’une colonne JSON dans une colonne String contenant des chaînes JSON, au lieu d’utiliser la sérialisation JSON native par défaut.

Taille, en octets, du bloc de compression du format de sortie ORC.

Méthode de compression du format de sortie ORC. Codecs pris en charge : lz4, snappy, zlib, zstd, none (non compressé)

Pour une colonne de chaînes au format de sortie ORC, si le nombre de valeurs distinctes est supérieur à cette fraction du nombre total de lignes non NULL, l'encodage par dictionnaire est désactivé. Sinon, l'encodage par dictionnaire est activé

Pas cible de l'index de ligne du format de sortie ORC

Utiliser le type String d’ORC au lieu de Binary pour les colonnes de type String

Le nom du fuseau horaire utilisé par le writer ORC ; par défaut, le writer ORC utilise le fuseau horaire GMT.

Active ou désactive le formatage parallèle des formats de données. Pris en charge uniquement pour les formats TSV, TSKV, CSV et JSONEachRow.

Valeurs possibles :

• 1 — Activé.
• 0 — Désactivé.

Vérifie la taille de la page toutes les N lignes. Envisagez de diminuer cette valeur si vous avez des colonnes dont la taille moyenne des valeurs dépasse quelques Ko.

Nombre approximatif de bits à utiliser pour chaque valeur distincte dans les filtre de Bloom de Parquet. Taux de faux positifs estimés :

• 6 bits - 10 %
• 10.5 bits - 1 %
• 16.9 bits - 0.1 %
• 26.4 bits - 0.01 %
• 41 bits - 0.001 %

Emplacement des filtres de Bloom dans le fichier Parquet. Les filtres de Bloom seront écrits par groupes d'environ cette taille. Plus précisément :

• si la valeur est 0, les filtres de Bloom de chaque groupe de lignes sont écrits immédiatement après le groupe de lignes,
  • si elle est supérieure à la taille totale de tous les filtres de Bloom, les filtres de Bloom de tous les groupes de lignes seront accumulés en mémoire, puis écrits ensemble vers la fin du fichier,
  • sinon, les filtres de Bloom seront accumulés en mémoire et écrits dès que leur taille totale dépasse cette valeur.

Méthode de compression du format de sortie Parquet. Codecs pris en charge : snappy, lz4, brotli, zstd, gzip, none (non compressé)

Taille de page cible, en octets, avant compression.

Écrit les valeurs Date sous forme de simples nombres 16 bits (relus comme UInt16), au lieu de les convertir en type DATE Parquet 32 bits (relu comme Date32).

Écrire les valeurs DateTime sous forme d’horodatage Unix brut (relues comme UInt32), au lieu de les convertir en millisecondes (relues comme DateTime64(3)).

Écrire les enum en utilisant le type physique Parquet : BYTE_ARRAY et le type logique : ENUM

Utiliser le type Parquet FIXED_LEN_BYTE_ARRAY au lieu de Binary pour les colonnes FixedString.

Permet d’écrire des informations sur les colonnes Geo dans les métadonnées Parquet et d’encoder les colonnes au format WKB.

Si la taille du dictionnaire dépasse ce nombre d’octets, l’encodage bascule vers un mode sans dictionnaire. Définissez cette valeur sur 0 pour désactiver l’encodage par dictionnaire.

Effectue l’encodage Parquet en parallèle sur plusieurs threads.

Taille cible du groupe de lignes, en nombre de lignes.

Taille cible du groupe de lignes, en octets, avant compression.

Utiliser le type String de Parquet au lieu de Binary pour les colonnes de type String.

Écrit les valeurs Int128, UInt128, Int256 et UInt256 sous forme de valeurs Parquet DECIMAL conformes aux normes, avec un ordre des octets big-endian. La valeur par défaut conserve la représentation FIXED_LEN_BYTE_ARRAY little-endian non annotée legacy, afin d’assurer la compatibilité avec les anciennes versions de ClickHouse. La représentation décimale permet d’obtenir des statistiques numériques interopérables, mais certains lecteurs Parquet ne prennent pas en charge des précisions supérieures à 38 ou 76.

Écrire des filtres de Bloom dans les fichiers Parquet.

Insère des sommes de contrôle CRC32 dans les en-têtes de page Parquet.

Écrit les index de colonnes et de décalage (c’est-à-dire des statistiques sur chaque page de données, qui peuvent être utilisées pour le pushdown des filtres à la lecture) dans les fichiers Parquet.

Utilise les séquences d’échappement ANSI dans les format Pretty. 0 - désactivé, 1 - activé, 'auto' - activé si la sortie se fait dans un terminal.

Afficher les noms de colonnes dans le pied de page lorsqu'il y a beaucoup de lignes dans le tableau.

Valeurs possibles :

• 0 — Aucun nom de colonne n'est affiché dans le pied de page.
• 1 — Les noms de colonnes sont affichés dans le pied de page si le nombre de lignes est supérieur ou égal à la valeur de seuil définie par output_format_pretty_display_footer_column_names_min_rows (50 par défaut).

Exemple

Requête :

SELECT *, toTypeName(*) FROM (SELECT * FROM system.numbers LIMIT 1000);

Résultat :

      ┌─number─┬─toTypeName(number)─┐
   1. │      0 │ UInt64             │
   2. │      1 │ UInt64             │
   3. │      2 │ UInt64             │
   ...
 999. │    998 │ UInt64             │
1000. │    999 │ UInt64             │
      └─number─┴─toTypeName(number)─┘

Définit le nombre minimal de lignes à partir duquel un pied de page affichant les noms des colonnes est présenté si le paramètre output_format_pretty_display_footer_column_names est activé.

S'il est activé et que la table est large mais comporte peu de lignes, le format Pretty l'affiche comme le format Vertical. Consultez output_format_pretty_fallback_to_vertical_max_rows_per_chunk et output_format_pretty_fallback_to_vertical_min_table_width pour régler ce comportement plus finement.

Le basculement vers le format Vertical (voir output_format_pretty_fallback_to_vertical) ne s'active que si le nombre d'enregistrements dans un chunk est inférieur ou égal à la valeur spécifiée.

Le basculement vers le format Vertical (voir output_format_pretty_fallback_to_vertical) s'active uniquement si le nombre de colonnes est supérieur à la valeur spécifiée.

Le basculement vers le format Vertical (voir output_format_pretty_fallback_to_vertical) ne sera activé que si la somme des longueurs des colonnes d’une table est au moins égale à la valeur spécifiée, ou si au moins une valeur contient un caractère de retour à la ligne.

Si les données affichées dans les formats Pretty arrivent en plusieurs chunks, même avec un délai, mais que le chunk suivant a les mêmes largeurs de colonnes que le précédent, utilisez des séquences d’échappement ANSI pour revenir à la ligne précédente et remplacer le pied de page du chunk précédent afin de le prolonger avec les données du nouveau chunk. Le résultat est ainsi plus agréable à l’œil.

0 - désactivé, 1 - activé, 'auto' - activé si la sortie se fait dans un terminal.

Jeu de caractères utilisé pour l’affichage des bordures de la grille. Jeux de caractères disponibles : ASCII, UTF-8 (par défaut).

En mode interactif, clickhouse-client bascule automatiquement vers ASCII lorsque le terminal ne prend pas en charge UTF-8 (selon les variables d’environnement LC_ALL, LC_CTYPE et LANG), sauf si ce paramètre est explicitement défini.

Si cette option est activée et si la sortie est un terminal, chaque chiffre correspondant aux milliers, millions, etc. est souligné.

Si ce paramètre est activé et que la sortie est un terminal, les espaces de fin de ligne sont mis en évidence en gris et soulignés.

Si le nom de la colonne est trop long, tronquez-le à cette longueur. La colonne sera tronquée si sa longueur dépasse output_format_pretty_max_column_name_width_cut_to plus output_format_pretty_max_column_name_width_min_chars_to_cut.

Nombre minimal de caractères à supprimer si le nom de la colonne est trop long. Le nom de la colonne sera tronqué s'il dépasse output_format_pretty_max_column_name_width_cut_to plus output_format_pretty_max_column_name_width_min_chars_to_cut.

Largeur maximale de remplissage appliquée à toutes les valeurs d’une colonne dans les formats Pretty.

Limite de lignes pour les formats Pretty.

Largeur maximale de la valeur affichée dans les formats Pretty. Au-delà, elle sera tronquée. La valeur 0 signifie : ne jamais tronquer.

Ne tronquer les valeurs (voir le paramètre output_format_pretty_max_value_width) que lorsqu'il ne s'agit pas d'une valeur isolée dans un bloc. Sinon, les afficher intégralement, ce qui est utile pour la requête SHOW CREATE TABLE.

Si cette option est activée, les formats Pretty afficheront les champs sur plusieurs lignes à l’intérieur des cellules du tableau, de sorte que les bordures du tableau soient préservées. Sinon, ils seront affichés tels quels, ce qui risque de déformer le tableau (l’un des avantages de laisser cette option désactivée est que le copier-coller de valeurs sur plusieurs lignes sera plus facile).

Détermine si les tuples nommés au format Pretty sont affichés sous forme d'objets JSON avec une mise en forme lisible.

Ajoute des numéros de ligne avant chaque ligne pour le format de sortie Pretty

Affiche, à droite du tableau, une indication lisible pour un nombre si le bloc est constitué d’un seul nombre supérieur à cette valeur (sauf 0)

Attend le bloc suivant pendant le nombre de millisecondes spécifié au maximum, puis le fusionne avec le précédent avant l’écriture. Cela évite de produire trop souvent des blocs trop petits, tout en permettant d’afficher les données en mode streaming.

Affiche le bloc en attente dans les formats Pretty si le nombre de millisecondes écoulées depuis la sortie précédente dépasse la valeur spécifiée.

S'il est activé, les espaces de remplissage dans les formats de sortie Pretty sont rendus avec U+00A0 au lieu d'un espace ASCII. La sortie reste visuellement identique avec une police à chasse fixe, mais ces espaces de remplissage sont préservés par les outils qui compressent ou suppriment les suites d'espaces ordinaires. Ne prend effet que lorsque output_format_pretty_grid_charset vaut UTF-8.

Lors de la sérialisation de colonnes Nullable avec les wrappers Google, sérialisez les valeurs par défaut sous forme de wrappers vides. Si cette option est désactivée, les valeurs par défaut et les valeurs NULL ne sont pas sérialisées

Chemin du fichier dans lequel le schéma généré automatiquement sera enregistré aux formats Cap'n Proto ou Protobuf.

Inclure les noms de colonnes dans la requête INSERT

Le nombre maximal de lignes dans une instruction INSERT.

Mettre les noms de colonnes entre des caractères '`'

Le nom de la table dans la requête INSERT générée en sortie

Utiliser l’instruction REPLACE au lieu de l’instruction INSERT

Supprime les octets nuls en fin de valeur FixedString dans les formats de sortie textuels. Par ex., toFixedString('John', 8) s'affiche comme John au lieu de John\0\0\0\0.

Si ce paramètre est défini sur true, la fin de ligne au format TSV sera \r\n au lieu de \n.

Si true, échappe ' par '', sinon avec \'

Écrit des statistiques sur le nombre de lignes et d’octets lus, ainsi que sur le temps écoulé, dans les formats de sortie appropriés.

Activé par défaut