Skip to content

bigfunctions > json_keys

json_keys

Call or Deploy json_keys ?

✅ You can call this json_keys bigfunction directly from your Google Cloud Project (no install required).

  • This json_keys function is deployed in bigfunctions GCP project in 39 datasets for all of the 39 BigQuery regions. You need to use the dataset in the same region as your datasets (otherwise you may have a function not found error).
  • Function is public, so it can be called by anyone. Just copy / paste examples below in your BigQuery console. It just works!
  • You may prefer to deploy the BigFunction in your own project if you want to build and manage your own catalog of functions. This is particularly useful if you want to create private functions (for example calling your internal APIs). Discover the framework

Public BigFunctions Datasets:

Region Dataset
eu bigfunctions.eu
us bigfunctions.us
europe-west1 bigfunctions.europe_west1
asia-east1 bigfunctions.asia_east1
... ...

Description

Signature

json_keys(json_string)

Description

Extract keys from json_string which has only flat (no nested) key-values. Return keys as an array<string>

Examples

select bigfunctions.eu.json_keys('{"created_at": "2022-01-01", "user": "sidali"}')
select bigfunctions.us.json_keys('{"created_at": "2022-01-01", "user": "sidali"}')
select bigfunctions.europe_west1.json_keys('{"created_at": "2022-01-01", "user": "sidali"}')
+------------------------+
| keys                   |
+------------------------+
| ['created_at', 'user'] |
+------------------------+

Need help using json_keys?

The community can help! Engage the conversation on Slack

For professional suppport, don't hesitate to chat with us.

Found a bug using json_keys?

If the function does not work as expected, please

  • report a bug so that it can be improved.
  • or open the discussion with the community on Slack.

For professional suppport, don't hesitate to chat with us.

Use cases

You have a BigQuery table containing a column with JSON strings representing product information. Each JSON string has a flat structure (no nested objects) with keys like "product_name", "price", "category", etc. You want to extract all the keys present in these JSON strings.

Example Table:

| product_info (STRING) | |---|---| | {"product_name": "Laptop", "price": 1200, "category": "electronics"} | | {"product_name": "T-shirt", "category": "clothing", "color": "blue"} | | {"price": 25, "product_name": "Book", "author": "Jane Doe"} |

Query using json_keys:

SELECT bigfunctions.us.json_keys(product_info) AS keys
FROM `your_project.your_dataset.your_table`;

Result:

| keys (ARRAY) | |---|---| | ["product_name", "price", "category"] | | ["product_name", "category", "color"] | | ["price", "product_name", "author"] |

This allows you to dynamically determine the keys present in each JSON string without hardcoding them. You could then use this information for various purposes like:

  • Schema validation: Verify that all expected keys are present in the JSON data.
  • Data transformation: Create new columns based on the extracted keys.
  • Dynamic querying: Construct queries that access fields within the JSON based on the available keys.
  • Data analysis: Analyze the frequency of different keys to understand the structure of your JSON data.

Spread the word

BigFunctions is fully open-source. Help make it a success by spreading the word!

Share on Add a on