Lavorare con i dati JSON in GoogleSQL

BigQuery supporta in modo nativo i dati JSON utilizzando il tipo di dati JSON.

Questo documento descrive come creare una tabella con una colonna JSON, inserire dati JSON in una tabella BigQuery ed eseguire query sui dati JSON.

Panoramica

JSON è un formato ampiamente usato che consente dati semistrutturati, poiché non richiede uno schema. Le applicazioni possono utilizzare un approccio "schema su lettura", in cui l'applicazione importa i dati e quindi esegue query in base a ipotesi sullo schema di questi dati. Questo approccio è diverso dal tipo STRUCT in BigQuery, che richiede uno schema fisso applicato in modo forzato a tutti i valori archiviati in una colonna di tipo STRUCT.

Utilizzando il tipo di dati JSON, puoi caricare JSON semi-strutturato in BigQuery senza fornire in anticipo uno schema per i dati JSON. In questo modo puoi archiviare ed eseguire query su dati che non sempre rispettano schemi e tipi di dati fissi. Importando i dati JSON come tipo di dati JSON, BigQuery può codificare ed elaborare singolarmente ogni campo JSON. Puoi quindi eseguire query sui valori dei campi e degli elementi dell'array all'interno dei dati JSON utilizzando l'operatore di accesso ai campi, che rende le query JSON intuitive ed economiche.

Limitazioni

  • Se utilizzi un job di caricamento collettivo per importare i dati JSON in una tabella, i dati di origine devono essere in formato CSV, Avro o JSON. Non sono supportati altri formati di caricamento batch.
  • Il tipo di dati JSON ha un limite di annidamento di 500.
  • Non puoi utilizzare l'SQL precedente per eseguire query su una tabella contenente tipi JSON.
  • I criteri di accesso a livello di riga non possono essere applicati a JSON colonne.

Per scoprire di più sulle proprietà del tipo di dati JSON, consulta la sezione Tipo JSON.

Crea una tabella con una colonna JSON

Puoi creare una tabella vuota con una colonna JSON utilizzando SQL o lo strumento a riga di comando bq.

SQL

Utilizza l'istruzione CREATE TABLE e dichiara una colonna con il tipo JSON.

  1. Nella console Google Cloud, vai alla pagina BigQuery.

    Vai a BigQuery

  2. Nell'Editor query, inserisci la seguente istruzione:

    CREATE TABLE mydataset.table1(
  id INT64,
  cart JSON
);

  3. Fai clic su Esegui.

Per saperne di più su come eseguire le query, consulta Eseguire una query interattiva.

bq

Utilizza il comando bq mk e fornisci uno schema di tabella con un tipo di dati JSON.

bq mk --table mydataset.table1 id:INT64,cart:JSON

Non puoi eseguire il partizionamento o il clustering di una tabella su colonne JSON, perché gli operatori di uguaglianza e confronto non sono definiti nel tipo JSON.

Crea valori JSON

Puoi creare i valori JSON nei seguenti modi:

  • Utilizza SQL per creare un valore letterale JSON.
  • Utilizza la funzione PARSE_JSON per convertire un valore STRING in un valore JSON.
  • Utilizza la funzione TO_JSON per convertire un valore SQL in un valore JSON.
  • Utilizza la funzione JSON_ARRAY per creare un array JSON dai valori SQL.
  • Utilizza la funzione JSON_OBJECT per creare un oggetto JSON da coppie chiave-valore.

Crea un valore JSON

L'esempio seguente inserisce i valori JSON in una tabella:

INSERT INTO mydataset.table1 VALUES
(1, JSON '{"name": "Alice", "age": 30}'),
(2, JSON_ARRAY(10, ['foo', 'bar'], [20, 30])),
(3, JSON_OBJECT('foo', 10, 'bar', ['a', 'b']));

Converti un tipo STRING in un tipo JSON

L'esempio seguente converte un valore STRING in formato JSON utilizzando la funzione PARSE_JSON. L'esempio converte una colonna da una tabella esistente a un tipo JSON e archivia i risultati in una nuova tabella.

CREATE OR REPLACE TABLE mydataset.table_new
AS (
  SELECT
    id, SAFE.PARSE_JSON(cart) AS cart_json
  FROM
    mydataset.old_table
);

Il prefisso SAFE utilizzato in questo esempio garantisce che eventuali errori di conversione vengano restituiti come valori NULL.

Converti i dati schematizzati in JSON

L'esempio seguente converte le coppie chiave-valore in JSON utilizzando la funzione JSON_OBJECT.

WITH Fruits AS (
SELECT 0 AS id, 'color' AS k, 'Red' AS v UNION ALL
SELECT 0, 'fruit', 'apple' UNION ALL
SELECT 1, 'fruit','banana' UNION ALL
SELECT 1, 'ripe', 'true'
)

SELECT JSON_OBJECT(ARRAY_AGG(k), ARRAY_AGG(v)) AS json_data
FROM Fruits
GROUP BY id

Il risultato è il seguente:

+----------------------------------+
| json_data                        |
+----------------------------------+
| {"color":"Red","fruit":"apple"}  |
| {"fruit":"banana","ripe":"true"} |
+----------------------------------+

Converti un tipo SQL in un tipo JSON

L'esempio seguente converte un valore SQL STRUCT in un valore JSON utilizzando la funzione TO_JSON:

SELECT TO_JSON(STRUCT(1 AS id, [10,20] AS coordinates)) AS pt;

Il risultato è il seguente:

+--------------------------------+
| pt                             |
+--------------------------------+
| {"coordinates":[10,20],"id":1} |
+--------------------------------+

Importa dati JSON

Puoi importare dati JSON in una tabella BigQuery nei seguenti modi:

Carica da file CSV

L'esempio seguente presuppone che tu abbia un file CSV denominato file1.csv che contiene i seguenti record:

1,20
2,"""This is a string"""
3,"{""id"": 10, ""name"": ""Alice""}"

Tieni presente che la seconda colonna contiene dati JSON codificati come stringa. Ciò comporta l'uso corretto di caratteri di escape per le virgolette per il formato CSV. Nel formato CSV, le virgolette vengono convertite in caratteri di escape utilizzando la sequenza di due caratteri "".

Per caricare questo file con lo strumento a riga di comando bq, utilizza il comando bq load:

bq load --source_format=CSV mydataset.table1 file1.csv id:INTEGER,json_data:JSON

bq show mydataset.table1

Last modified          Schema         Total Rows   Total Bytes
----------------- -------------------- ------------ -------------
 22 Dec 22:10:32   |- id: integer       3            63
                   |- json_data: json

Carica da file JSON delimitati da nuova riga

L'esempio seguente presuppone che tu abbia un file denominato file1.jsonl che contiene i seguenti record:

{"id": 1, "json_data": 20}
{"id": 2, "json_data": "This is a string"}
{"id": 3, "json_data": {"id": 10, "name": "Alice"}}

Per caricare questo file con lo strumento a riga di comando bq, utilizza il comando bq load:

bq load --source_format=NEWLINE_DELIMITED_JSON mydataset.table1 file1.jsonl id:INTEGER,json_data:JSON

bq show mydataset.table1

Last modified          Schema         Total Rows   Total Bytes
----------------- -------------------- ------------ -------------
 22 Dec 22:10:32   |- id: integer       3            63
                   |- json_data: json

Utilizzare l'API Storage Write

Puoi utilizzare l'API Storage Write per importare dati JSON. L'esempio seguente utilizza il client Python dell'API Storage Write.

Definisci un buffer di protocollo in cui conservare i flussi di dati serializzati. I dati JSON sono codificati come stringa. Nell'esempio seguente, il campo json_col contiene i dati JSON.

message SampleData {
  optional string string_col = 1;
  optional int64 int64_col = 2;
  optional string json_col = 3;
}

Formatta i dati JSON per ogni riga come un valore STRING:

row.json_col = '{"a": 10, "b": "bar"}'
row.json_col = '"This is a string"' # The double-quoted string is the JSON value.
row.json_col = '10'

Aggiungi le righe al flusso di scrittura come mostrato nell'esempio di codice. La libreria client gestisce la serializzazione nel formato di buffer del protocollo.

Usa l'API Streaming legacy

L'esempio seguente carica i dati JSON da un file locale e li trasmette in flussi a BigQuery utilizzando l'API legacy per i flussi di dati.

from google.cloud import bigquery
import json

# TODO(developer): Replace these variables before running the sample.
project_id = 'MY_PROJECT_ID'
table_id = 'MY_TABLE_ID'

client = bigquery.Client(project=project_id)
table_obj = client.get_table(table_id)

# The column json_data is represented as a string.
rows_to_insert = [
    {"id": 1, "json_data": json.dumps(20)},
    {"id": 2, "json_data": json.dumps("This is a string")},
    {"id": 3, "json_data": json.dumps({"id": 10, "name": "Alice"})}
]

# Throw errors if encountered.
# https://cloud.google.com/python/docs/reference/bigquery/latest/google.cloud.bigquery.client.Client#google_cloud_bigquery_client_Client_insert_rows

errors = client.insert_rows(table=table_obj, rows=rows_to_insert)
if errors == []:
    print("New rows have been added.")
else:
    print("Encountered errors while inserting rows: {}".format(errors))

Per ulteriori informazioni, consulta Invio di flussi di dati in BigQuery.

Esegui query sui dati JSON

Questa sezione descrive come utilizzare GoogleSQL per estrarre valori da JSON. JSON è sensibile alle maiuscole e supporta UTF-8 nei campi e nei valori.

Gli esempi in questa sezione utilizzano la seguente tabella:

CREATE OR REPLACE TABLE mydataset.table1(id INT64, cart JSON);

INSERT INTO mydataset.table1 VALUES
(1, JSON """{
        "name": "Alice",
        "items": [
            {"product": "book", "price": 10},
            {"product": "food", "price": 5}
        ]
    }"""),
(2, JSON """{
        "name": "Bob",
        "items": [
            {"product": "pen", "price": 20}
        ]
    }""");

Estrai i valori come JSON

Dato un tipo JSON in BigQuery, puoi accedere ai campi in un'espressione JSON utilizzando l'operatore di accesso ai campi. L'esempio seguente restituisce il campo name della colonna cart.

SELECT cart.name
FROM mydataset.table1;

+---------+
|  name   |
+---------+
| "Alice" |
| "Bob"   |
+---------+

Per accedere a un elemento dell'array, utilizza l'operatore JSON come pedice. L'esempio seguente restituisce il primo elemento dell'array items:

SELECT
  cart.items[0] AS first_item
FROM mydataset.table1

+-------------------------------+
|          first_item           |
+-------------------------------+
| {"price":10,"product":"book"} |
| {"price":20,"product":"pen"}  |
+-------------------------------+

Puoi anche utilizzare l'operatore JSON per fare riferimento ai membri di un oggetto JSON per nome:

SELECT cart['name']
FROM mydataset.table1;

+---------+
|  name   |
+---------+
| "Alice" |
| "Bob"   |
+---------+

Per le operazioni a pedice, l'espressione all'interno delle parentesi può essere qualsiasi stringa arbitraria o espressione intera, incluse espressioni non costanti:

DECLARE int_val INT64 DEFAULT 0;

SELECT
  cart[CONCAT('it','ems')][int_val + 1].product AS item
FROM mydataset.table1;

+--------+
|  item  |
+--------+
| "food" |
| NULL   |
+--------+

Gli operatori di accesso ai campi e pedice restituiscono entrambi i tipi JSON, quindi puoi concatenare espressioni che li utilizzano o passare il risultato ad altre funzioni che accettano i tipi JSON.

Questi operatori sono zucchero sintattico per la funzione JSON_QUERY. Ad esempio, l'espressione cart.name è equivalente a JSON_QUERY(cart, "$.name").

Se nell'oggetto JSON non viene trovato un membro con il nome specificato o se l'array JSON non contiene un elemento con la posizione specificata, questi operatori restituiscono SQL NULL.

SELECT
  cart.address AS address,
  cart.items[1].price AS item1_price
FROM
  mydataset.table1;

+---------+-------------+
| address | item1_price |
+---------+-------------+
| NULL    | NULL        |
| NULL    | 5           |
+---------+-------------+

Gli operatori di uguaglianza e confronto non sono definiti nel tipo di dati JSON. Pertanto, non puoi utilizzare i valori JSON direttamente in clausole come GROUP BY o ORDER BY. Utilizza invece la funzione JSON_VALUE per estrarre i valori dei campi come stringhe SQL, come descritto nella sezione successiva.

Estrai i valori come stringhe

La funzione JSON_VALUE estrae un valore scalare e lo restituisce come stringa SQL. Restituisce SQL NULL se cart.name non punta a un valore scalare nel JSON.

SELECT JSON_VALUE(cart.name) AS name
FROM mydataset.table1;

+-------+
| name  |
+-------+
| Alice |
+-------+

Puoi utilizzare la funzione JSON_VALUE in contesti che richiedono uguaglianza o confronto, ad esempio le clausole WHERE e GROUP BY. L'esempio seguente mostra una clausola WHERE che applica un filtro in base a un valore JSON:

SELECT
  cart.items[0] AS first_item
FROM
  mydataset.table1
WHERE
  JSON_VALUE(cart.name) = 'Alice';

+-------------------------------+
| first_item                    |
+-------------------------------+
| {"price":10,"product":"book"} |
+-------------------------------+

In alternativa, puoi utilizzare la funzione STRING che estrae una stringa JSON e restituisce quel valore come STRING SQL. Ad esempio:

SELECT STRING(JSON '"purple"') AS color;

+--------+
| color  |
+--------+
| purple |
+--------+

Oltre a STRING, potrebbe essere necessario estrarre i valori JSON e restituirli come un altro tipo di dati SQL. Sono disponibili le seguenti funzioni di estrazione dei valori:

Per ottenere il tipo di valore JSON, puoi utilizzare la funzione JSON_TYPE.

Converti JSON in modo flessibile

Puoi convertire un valore JSON in un valore SQL scalare in modo flessibile e senza errori con le funzioni LAX Conversion.

L'esempio seguente mostra la potenza di queste funzioni. LAX_IN64 deduce ed elabora automaticamente l'input in modo corretto. 

SELECT LAX_INT64(JSON '"10"') AS id;

+----+
| id |
+----+
| 10 |
+----+

Oltre a LAX_IN64, puoi convertire in modo flessibile altri tipi di SQL in JSON con le seguenti funzioni:

Estrai array da JSON

JSON può contenere array JSON, che non sono direttamente equivalenti a un tipo ARRAY<JSON> in BigQuery. Puoi utilizzare le seguenti funzioni per estrarre un ARRAY BigQuery da JSON:

  • JSON_QUERY_ARRAY: estrae un array e lo restituisce come ARRAY<JSON> di JSON.
  • JSON_VALUE_ARRAY: estrae un array di valori scalari e lo restituisce come ARRAY<STRING> di valori scalari.

L'esempio seguente utilizza JSON_QUERY_ARRAY per estrarre gli array JSON.

SELECT JSON_QUERY_ARRAY(cart.items) AS items
FROM mydataset.table1;

+----------------------------------------------------------------+
| items                                                          |
+----------------------------------------------------------------+
| [{"price":10,"product":"book"}","{"price":5,"product":"food"}] |
| [{"price":20,"product":"pen"}]                                 |
+----------------------------------------------------------------+

Per suddividere un array nei suoi singoli elementi, utilizza l'operatore UNNEST, che restituisce una tabella con una riga per ogni elemento dell'array. L'esempio seguente seleziona il membro product da ciascun membro dell'array items:

SELECT
  id,
  JSON_VALUE(item.product) AS product
FROM
  mydataset.table1, UNNEST(JSON_QUERY_ARRAY(cart.items)) AS item
ORDER BY id;

+----+---------+
| id | product |
+----+---------+
|  1 | book    |
|  1 | food    |
|  2 | pen     |
+----+---------+

L'esempio successivo è simile, ma utilizza la funzione ARRAY_AGG per aggregare i valori in un array SQL.

SELECT
  id,
  ARRAY_AGG(JSON_VALUE(item.product)) AS products
FROM
  mydataset.table1, UNNEST(JSON_QUERY_ARRAY(cart.items)) AS item
GROUP BY id
ORDER BY id;

+----+-----------------+
| id | products        |
+----+-----------------+
|  1 | ["book","food"] |
|  2 | ["pen"]         |
+----+-----------------+

Per ulteriori informazioni sugli array, consulta la pagina relativa all'utilizzo degli array in GoogleSQL.

JSON null

Il tipo JSON ha un valore null speciale diverso da SQL NULL. Un null JSON non viene trattato come un valore SQL NULL, come mostrato nell'esempio seguente.

SELECT JSON 'null' IS NULL;

+-------+
| f0_   |
+-------+
| false |
+-------+

Quando estrai un campo JSON con un valore null, il comportamento dipende dalla funzione:

  • La funzione JSON_QUERY restituisce un null JSON, perché è un valore JSON valido.
  • La funzione JSON_VALUE restituisce l'SQL NULL, perché JSON null non è un valore scalare.

L'esempio seguente mostra i diversi comportamenti:

SELECT
  json.a AS json_query, -- Equivalent to JSON_QUERY(json, '$.a')
  JSON_VALUE(json, '$.a') AS json_value
FROM (SELECT JSON '{"a": null}' AS json);

+------------+------------+
| json_query | json_value |
+------------+------------+
| null       | NULL       |
+------------+------------+