Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

JSONObjectEachRow

Entrée Sortie Alias

Description

Dans ce format, toutes les données sont représentées dans un unique objet JSON, chaque ligne correspondant à un champ distinct de cet objet, à l'instar du format JSONEachRow.

Exemple d’utilisation

Exemple simple

Soit le JSON suivant :

{
  "row_1": {"num": 42, "str": "hello", "arr":  [0,1]},
  "row_2": {"num": 43, "str": "hello", "arr":  [0,1,2]},
  "row_3": {"num": 44, "str": "hello", "arr":  [0,1,2,3]}
}

Pour utiliser un nom d'objet comme valeur de colonne, vous pouvez utiliser le paramètre spécial format_json_object_each_row_column_for_object_name. La valeur de ce paramètre correspond au nom d'une colonne, utilisée comme clé JSON pour une ligne dans l'objet résultant.

Sortie

Supposons que nous ayons la table test avec deux colonnes :

┌─object_name─┬─number─┐
│ first_obj   │      1 │
│ second_obj  │      2 │
│ third_obj   │      3 │
└─────────────┴────────┘

Affichons-le au format JSONObjectEachRow et utilisons le paramètre format_json_object_each_row_column_for_object_name :

Querysql
SELECT * FROM test SETTINGS format_json_object_each_row_column_for_object_name='object_name'
Responsejson
{
    "first_obj": {"number": 1},
    "second_obj": {"number": 2},
    "third_obj": {"number": 3}
}

Entrée

Supposons que nous ayons enregistré le résultat de l’exemple précédent dans un fichier nommé data.json :

Querysql
SELECT * FROM file('data.json', JSONObjectEachRow, 'object_name String, number UInt64') SETTINGS format_json_object_each_row_column_for_object_name='object_name'
Responseresponse
┌─object_name─┬─number─┐
│ first_obj   │      1 │
│ second_obj  │      2 │
│ third_obj   │      3 │
└─────────────┴────────┘

Cela fonctionne aussi pour l’inférence de schéma :

Querysql
DESCRIBE file('data.json', JSONObjectEachRow) SETTING format_json_object_each_row_column_for_object_name='object_name'
Responseresponse
┌─name────────┬─type────────────┐
│ object_name │ String          │
│ number      │ Nullable(Int64) │
└─────────────┴─────────────────┘

Insertion de données

Querysql
INSERT INTO UserActivity FORMAT JSONEachRow {"PageViews":5, "UserID":"4324182021466249494", "Duration":146,"Sign":-1} {"UserID":"4324182021466249494","PageViews":6,"Duration":185,"Sign":1}

ClickHouse autorise :

  • N’importe quel ordre pour les paires clé-valeur dans l’objet.
  • L’omission de certaines valeurs.

ClickHouse ignore les espaces entre les éléments ainsi que les virgules après les objets. Vous pouvez transmettre tous les objets sur une seule ligne. Il n’est pas nécessaire de les séparer par des sauts de ligne.

Traitement des valeurs omises

ClickHouse remplace les valeurs omises par les valeurs par défaut des types de données correspondants.

Si DEFAULT expr est spécifié, ClickHouse applique des règles de substitution différentes selon le paramètre input_format_defaults_for_omitted_fields.

Considérez le tableau suivant :

Querysql
CREATE TABLE IF NOT EXISTS example_table
(
    x UInt32,
    a DEFAULT x * 2
) ENGINE = Memory;
  • Si input_format_defaults_for_omitted_fields = 0, la valeur par défaut de x et de a est 0 (qui est la valeur par défaut du type de données UInt32).
  • Si input_format_defaults_for_omitted_fields = 1, la valeur par défaut de x est 0, mais celle de a est x * 2.

Sélection de données

Prenons la table UserActivity comme exemple :

┌──────────────UserID─┬─PageViews─┬─Duration─┬─Sign─┐
│ 4324182021466249494 │         5 │      146 │   -1 │
│ 4324182021466249494 │         6 │      185 │    1 │
└─────────────────────┴───────────┴──────────┴──────┘

La requête SELECT * FROM UserActivity FORMAT JSONEachRow renvoie :

{"UserID":"4324182021466249494","PageViews":5,"Duration":146,"Sign":-1}
{"UserID":"4324182021466249494","PageViews":6,"Duration":185,"Sign":1}

Contrairement au format JSON, les séquences UTF-8 non valides ne sont pas remplacées. Les valeurs sont échappées de la même manière qu’en JSON.

Utilisation des structures Nested

Si vous avez une table avec des colonnes du type de données Nested, vous pouvez insérer des données JSON ayant la même structure. Activez cette fonctionnalité avec le paramètre input_format_import_nested_json.

Par exemple, prenons la table suivante :

Querysql
CREATE TABLE json_each_row_nested (n Nested (s String, i Int32) ) ENGINE = Memory

Comme vous pouvez le voir dans la description du type de données Nested, ClickHouse traite chaque composant de la structure imbriquée comme une colonne distincte (n.s et n.i dans notre table). Vous pouvez insérer les données de la manière suivante :

Querysql
INSERT INTO json_each_row_nested FORMAT JSONEachRow {"n.s": ["abc", "def"], "n.i": [1, 23]}

Pour insérer des données sous forme d’objet JSON hiérarchique, définissez input_format_import_nested_json=1.

{
    "n": {
        "s": ["abc", "def"],
        "i": [1, 23]
    }
}

Sans ce paramètre, ClickHouse lève une exception.

Querysql
SELECT name, value FROM system.settings WHERE name = 'input_format_import_nested_json'
Responseresponse
┌─name────────────────────────────┬─value─┐
│ input_format_import_nested_json │ 0     │
└─────────────────────────────────┴───────┘
Querysql
INSERT INTO json_each_row_nested FORMAT JSONEachRow {"n": {"s": ["abc", "def"], "i": [1, 23]}}
Responseresponse
Code: 117. DB::Exception: Unknown field found while parsing JSONEachRow format: n: (at row 1)
Querysql
SET input_format_import_nested_json=1
INSERT INTO json_each_row_nested FORMAT JSONEachRow {"n": {"s": ["abc", "def"], "i": [1, 23]}}
SELECT * FROM json_each_row_nested
Responseresponse
┌─n.s───────────┬─n.i────┐
│ ['abc','def'] │ [1,23] │
└───────────────┴────────┘

Paramètres de format

Paramètre Description Par défaut Remarques
input_format_import_nested_json associer les données JSON imbriquées à des tables imbriquées (fonctionne avec le format JSONEachRow). false
input_format_json_read_bools_as_numbers permettre d’interpréter les bools comme des nombres dans les formats d’entrée JSON. true
input_format_json_read_bools_as_strings permet d'interpréter les booléens comme des chaînes dans les formats d'entrée JSON. true
input_format_json_read_numbers_as_strings permet d'interpréter les nombres comme des chaînes dans les formats d'entrée JSON. true
input_format_json_read_arrays_as_strings permet d'interpréter les tableaux JSON comme des chaînes dans les formats d'entrée JSON. true
input_format_json_read_objects_as_strings permet d’analyser les objets JSON comme des chaînes dans les formats d’entrée JSON. true
input_format_json_named_tuples_as_objects analyser les colonnes de tuples nommés comme des objets JSON. true
input_format_json_try_infer_numbers_from_strings essayer d’inférer des nombres à partir de champs de type chaîne lors de l’inférence du schéma. false
input_format_json_try_infer_named_tuples_from_objects essayer d’inférer un tuple nommé à partir d’objets JSON lors de l’inférence de schéma. true
input_format_json_infer_incomplete_types_as_strings utiliser le type String pour les clés qui ne contiennent que des NULL ou des objets/tableaux vides lors de l’inférence de schéma dans les formats d’entrée JSON. true
input_format_json_defaults_for_missing_elements_in_named_tuple insérer des valeurs par défaut pour les éléments manquants dans un objet JSON lors de l’analyse d’un tuple nommé. true
input_format_json_ignore_unknown_keys_in_named_tuple ignorer les clés inconnues dans l’objet JSON des tuples nommés. false
input_format_json_compact_allow_variable_number_of_columns autoriser un nombre variable de colonnes dans le format JSONCompact/JSONCompactEachRow, ignorer les colonnes supplémentaires et utiliser les valeurs par défaut pour les colonnes manquantes. false
input_format_json_throw_on_bad_escape_sequence lever une exception si la chaîne JSON contient une séquence d’échappement invalide. Si cette option est désactivée, les séquences d’échappement invalides resteront telles quelles dans les données. true
input_format_json_empty_as_default traite les champs vides dans l’entrée JSON comme des valeurs par défaut. false. Pour les expressions par défaut complexes, il faut également activer input_format_defaults_for_omitted_fields.
output_format_json_quote_64bit_integers contrôle la mise entre guillemets des entiers 64 bits dans le format de sortie JSON. true
output_format_json_quote_64bit_floats contrôle la mise entre guillemets des Float 64 bits dans le format de sortie JSON. false
output_format_json_quote_denormals active les sorties '+nan', '-nan', '+inf', '-inf' au format de sortie JSON. false
output_format_json_quote_decimals contrôle la mise entre guillemets des valeurs décimales dans le format de sortie JSON. false
output_format_json_escape_forward_slashes contrôle l’échappement des slashs dans les sorties de chaînes de caractères au format de sortie JSON. true
output_format_json_named_tuples_as_objects sérialise les colonnes de tuples nommés sous forme d’objets JSON. true
output_format_json_array_of_rows renvoie un tableau JSON de toutes les lignes au format JSONEachRow(Compact). false
output_format_json_validate_utf8 active la validation des séquences UTF-8 dans les formats de sortie JSON (notez que cela n’a pas d’incidence sur les formats JSON/JSONCompact/JSONColumnsWithMetadata, qui valident toujours l’UTF-8). false
Navigation