Utiliser BigQuery avec Python

1. Présentation

BigQuery est l'entrepôt de données analytiques de Google. Entièrement géré, il permet de traiter plusieurs pétaoctets de données à faible coût. BigQuery est une solution NoOps. Vous n'avez donc aucune infrastructure à gérer, et vous n'avez pas besoin de faire appel à un administrateur de base de données. Vous pouvez ainsi vous concentrer sur l'analyse des données pour dégager des insights pertinents, utiliser un langage SQL qui vous est familier et profiter de notre modèle de facturation à l'utilisation.

Dans cet atelier de programmation, vous utiliserez les bibliothèques clientes Google Cloud pour Python afin d'interroger les ensembles de données publics BigQuery avec Python.

Points abordés

Utiliser Cloud Shell
Activer l'API BigQuery
Authentifier les requêtes API
Installer la bibliothèque cliente Python
Interroger les œuvres de Shakespeare
Interroger l'ensemble de données GitHub
Ajuster la mise en cache et les statistiques d'affichage

Prérequis

Un projet Google Cloud
Un navigateur tel que Chrome ou Firefox
Connaissances de base sur Python

Enquête

Comment allez-vous utiliser ce tutoriel ?

Je vais le lire uniquement

Je vais le lire et effectuer les exercices

Quel est votre niveau d'expérience avec Python ?

Débutant

Intermédiaire

Expert

Quel est votre niveau d'expérience avec les services Google Cloud ?

Débutant

Intermédiaire

Expert

2. Préparation

Configuration de l'environnement au rythme de chacun

Connectez-vous à la console Google Cloud, puis créez un projet ou réutilisez un projet existant. (Si vous ne possédez pas encore de compte Gmail ou Google Workspace, vous devez en créer un.)

Le nom du projet est le nom à afficher pour les participants au projet. Il s'agit d'une chaîne de caractères qui n'est pas utilisée par les API Google, et que vous pouvez modifier à tout moment.
L'ID du projet doit être unique sur l'ensemble des projets Google Cloud et doit être immuable (vous ne pouvez pas le modifier une fois que vous l'avez défini). Cloud Console génère automatiquement une chaîne unique dont la composition importe peu, en général. Dans la plupart des ateliers de programmation, vous devrez référencer l'ID du projet (généralement identifié comme PROJECT_ID), donc s'il ne vous convient pas, générez-en un autre au hasard ou définissez le vôtre, puis vérifiez s'il est disponible. Il est ensuite "gelé" une fois le projet créé.
La troisième valeur est le numéro de projet, utilisé par certaines API. Pour en savoir plus sur ces trois valeurs, consultez la documentation.

Vous devez ensuite activer la facturation dans Cloud Console afin d'utiliser les ressources/API Cloud. L'exécution de cet atelier de programmation est très peu coûteuse, voire sans frais. Pour arrêter les ressources afin d'éviter qu'elles ne vous soient facturées après ce tutoriel, suivez les instructions de nettoyage indiquées à la fin de l'atelier. Les nouveaux utilisateurs de Google Cloud peuvent participer au programme d'essai sans frais pour bénéficier d'un crédit de 300$.

Démarrer Cloud Shell

Bien que Google Cloud puisse être utilisé à distance depuis votre ordinateur portable, nous allons nous servir de Google Cloud Shell pour cet atelier de programmation, un environnement de ligne de commande exécuté dans le cloud.

Activer Cloud Shell

Dans Cloud Console, cliquez sur Activer Cloud Shell .

Si vous n'avez jamais démarré Cloud Shell auparavant, un écran intermédiaire s'affiche en dessous de la ligne de flottaison, décrivant de quoi il s'agit. Si tel est le cas, cliquez sur Continuer. Cet écran ne s'affiche qu'une seule fois. Voici à quoi il ressemble :

Le provisionnement et la connexion à Cloud Shell ne devraient pas prendre plus de quelques minutes.

Cette machine virtuelle contient tous les outils de développement dont vous avez besoin. Elle comprend un répertoire d'accueil persistant de 5 Go et s'exécute sur Google Cloud, ce qui améliore nettement les performances du réseau et l'authentification. Vous pouvez réaliser une grande partie, voire la totalité, des activités de cet atelier dans un simple navigateur ou sur votre Chromebook.

Une fois connecté à Cloud Shell, vous êtes en principe authentifié et le projet est défini avec votre ID de projet.

Exécutez la commande suivante dans Cloud Shell pour vérifier que vous êtes authentifié :

gcloud auth list

Résultat de la commande

 Credentialed Accounts
ACTIVE  ACCOUNT
*       <my_account>@<my_domain.com>

To set the active account, run:
    $ gcloud config set account `ACCOUNT`

Exécutez la commande suivante dans Cloud Shell pour vérifier que la commande gcloud connaît votre projet :

gcloud config list project

Résultat de la commande

[core]
project = <PROJECT_ID>

Si vous obtenez un résultat différent, exécutez cette commande :

gcloud config set project <PROJECT_ID>

Résultat de la commande

Updated property [core/project].

3. Activer l'API

L'API BigQuery doit être activée par défaut dans tous les projets Google Cloud. Vous pouvez vérifier si c'est le cas avec la commande suivante dans Cloud Shell : Vous devriez être listé dans BigQuery :

gcloud services list

BigQuery devrait s'afficher :

NAME                              TITLE
bigquery.googleapis.com           BigQuery API

...

Si l'API BigQuery n'est pas activée, vous pouvez utiliser la commande suivante dans Cloud Shell pour l'activer :

gcloud services enable bigquery.googleapis.com

4. Authentifier les requêtes API

Pour envoyer des requêtes à l'API BigQuery, vous devez utiliser un compte de service. Ce compte de service appartient à votre projet. Il permet à la bibliothèque cliente Python de Google Cloud d'envoyer des requêtes à l'API BigQuery. Comme tout autre compte utilisateur, un compte de service est représenté par une adresse e-mail. Dans cette section, vous allez utiliser le SDK Cloud pour créer un compte de service, puis créer les identifiants nécessaires pour vous authentifier en tant que compte de service.

Tout d'abord, définissez une variable d'environnement PROJECT_ID :

export PROJECT_ID=$(gcloud config get-value core/project)

Créez ensuite un compte de service pour accéder à l'API BigQuery à l'aide de la commande suivante :

gcloud iam service-accounts create my-bigquery-sa \
  --display-name "my bigquery service account"

Créez ensuite des identifiants permettant à votre code Python de se connecter avec ce nouveau compte de service, et enregistrez-les dans un fichier JSON ~/key.json à l'aide de la commande suivante :

gcloud iam service-accounts keys create ~/key.json \
  --iam-account my-bigquery-sa@${PROJECT_ID}.iam.gserviceaccount.com

Enfin, définissez la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS, qui permet à la bibliothèque cliente BigQuery Python (abordée à l'étape suivante) de trouver vos identifiants. La variable d'environnement doit être définie sur le chemin d'accès complet au fichier JSON d'identifiants que vous avez créé, à l'aide de la commande suivante :

export GOOGLE_APPLICATION_CREDENTIALS=~/key.json

Pour en savoir plus sur l'authentification de l'API BigQuery, consultez la documentation.

5. Configurer le contrôle des accès

BigQuery utilise Identity and Access Management (IAM) pour gérer l'accès aux ressources. BigQuery propose plusieurs rôles prédéfinis (utilisateur, propriétaire des données, lecteur de données, etc.) que vous pouvez attribuer au compte de service que vous avez créé à l'étape précédente. Pour en savoir plus sur le contrôle des accès, consultez la documentation BigQuery.

Avant de pouvoir interroger des ensembles de données publics, vous devez vous assurer que le compte de service dispose au moins du rôle roles/bigquery.user. Dans Cloud Shell, exécutez la commande suivante pour attribuer le rôle utilisateur au compte de service :

gcloud projects add-iam-policy-binding ${PROJECT_ID} \
  --member "serviceAccount:my-bigquery-sa@${PROJECT_ID}.iam.gserviceaccount.com" \
  --role "roles/bigquery.user"

Vous pouvez exécuter la commande suivante pour vérifier que le compte de service dispose du rôle utilisateur :

gcloud projects get-iam-policy $PROJECT_ID

Le résultat suivant doit s'afficher :

bindings:
- members:
  - serviceAccount:my-bigquery-sa@<PROJECT_ID>.iam.gserviceaccount.com
  role: roles/bigquery.user
...

6. Installer la bibliothèque cliente

Installez la bibliothèque cliente BigQuery Python :

pip3 install --user --upgrade google-cloud-bigquery

Vous êtes maintenant prêt à coder avec l'API BigQuery.

7. Interroger les œuvres de Shakespeare

Un ensemble de données public est un ensemble de données stocké dans BigQuery et mis à la disposition du grand public. Vous pouvez interroger de nombreux autres ensembles de données publics. Si certains ensembles de données sont hébergés par Google, la plupart le sont par des tiers. Pour en savoir plus, consultez la page Ensembles de données publics.

En plus des ensembles de données publics, BigQuery propose un nombre limité d'exemples de tables que vous pouvez interroger. Ces tables sont contenues dans l'ensemble de données bigquery-public-data:samples. La table shakespeare de l'ensemble de données samples contient un index de mots des œuvres de Shakespeare. Il indique le nombre de fois où chaque mot apparaît dans chaque corpus.

Dans cette étape, vous allez interroger la table shakespeare.

Tout d'abord, dans Cloud Shell, créez une application Python simple que vous utiliserez pour exécuter les exemples de l'API Translation.

mkdir bigquery-demo
cd bigquery-demo
touch app.py

Ouvrez l'éditeur de code en haut à droite de Cloud Shell :

Accédez au fichier app.py dans le dossier bigquery-demo et remplacez le code par ce qui suit.

from google.cloud import bigquery

client = bigquery.Client()

query = """
    SELECT corpus AS title, COUNT(word) AS unique_words
    FROM `bigquery-public-data.samples.shakespeare`
    GROUP BY title
    ORDER BY unique_words
    DESC LIMIT 10
"""
results = client.query(query)

for row in results:
    title = row['title']
    unique_words = row['unique_words']
    print(f'{title:<20} | {unique_words}')

Prenez une ou deux minutes pour étudier le code et voir comment la table est interrogée.

Retournez dans Cloud Shell et exécutez l'application :

python3 app.py

Une liste de mots et de leurs occurrences devrait s'afficher :

hamlet               | 5318
kinghenryv           | 5104
cymbeline            | 4875
troilusandcressida   | 4795
kinglear             | 4784
kingrichardiii       | 4713
2kinghenryvi         | 4683
coriolanus           | 4653
2kinghenryiv         | 4605
antonyandcleopatra   | 4582

8. Interroger l'ensemble de données GitHub

Pour vous familiariser davantage avec BigQuery, vous allez maintenant exécuter une requête sur l'ensemble de données public GitHub. Vous trouverez les messages de commit les plus courants sur GitHub. Vous utiliserez également la console Web de BigQuery pour prévisualiser et exécuter des requêtes ad hoc.

Pour voir à quoi ressemblent les données, ouvrez l'ensemble de données GitHub dans l'interface utilisateur Web de BigQuery :

Ouvrez le tableau github_repos.

Cliquez sur le bouton "Aperçu" pour voir à quoi ressemblent les données :

Accédez au fichier app.py dans le dossier bigquery_demo et remplacez le code par ce qui suit.

from google.cloud import bigquery

client = bigquery.Client()

query = """
    SELECT subject AS subject, COUNT(*) AS num_duplicates
    FROM bigquery-public-data.github_repos.commits
    GROUP BY subject
    ORDER BY num_duplicates
    DESC LIMIT 10
"""
results = client.query(query)

for row in results:
    subject = row['subject']
    num_duplicates = row['num_duplicates']
    print(f'{subject:<20} | {num_duplicates:>9,}')

Prenez une ou deux minutes pour étudier le code et voir comment la table est interrogée pour obtenir les messages de commit les plus courants.

Retournez dans Cloud Shell et exécutez l'application :

python3 app.py

Une liste des messages de commit et de leurs occurrences devrait s'afficher :

Update README.md     | 1,685,515
Initial commit       | 1,577,543
update               |   211,017
                     |   155,280
Create README.md     |   153,711
Add files via upload |   152,354
initial commit       |   145,224
first commit         |   110,314
Update index.html    |    91,893
Update README        |    88,862

9. Mise en cache et statistiques

BigQuery met en cache les résultats des requêtes. Par conséquent, les requêtes suivantes prennent moins de temps. Il est possible de désactiver la mise en cache avec les options de requête. BigQuery suit également les statistiques sur les requêtes, telles que l'heure de création, l'heure de fin et le nombre total d'octets traités.

Dans cette étape, vous allez désactiver la mise en cache et afficher des statistiques sur les requêtes.

Accédez au fichier app.py dans le dossier bigquery_demo et remplacez le code par ce qui suit.

from google.cloud import bigquery

client = bigquery.Client()

query = """
    SELECT subject AS subject, COUNT(*) AS num_duplicates
    FROM bigquery-public-data.github_repos.commits
    GROUP BY subject
    ORDER BY num_duplicates
    DESC LIMIT 10
"""
job_config = bigquery.job.QueryJobConfig(use_query_cache=False)
results = client.query(query, job_config=job_config)

for row in results:
    subject = row['subject']
    num_duplicates = row['num_duplicates']
    print(f'{subject:<20} | {num_duplicates:>9,}')

print('-'*60)
print(f'Created: {results.created}')
print(f'Ended:   {results.ended}')
print(f'Bytes:   {results.total_bytes_processed:,}')

Quelques points à noter concernant le code : Tout d'abord, la mise en cache est désactivée en introduisant QueryJobConfig et en définissant use_query_cache sur "false". Ensuite, vous avez accédé aux statistiques sur la requête à partir de l'objet Job.

Retournez dans Cloud Shell et exécutez l'application :

python3 app.py

Comme avant, vous devriez voir une liste des messages de commit et de leurs occurrences. Vous devriez également voir des statistiques sur la requête à la fin :

Update README.md     | 1,685,515
Initial commit       | 1,577,543
update               |   211,017
                     |   155,280
Create README.md     |   153,711
Add files via upload |   152,354
initial commit       |   145,224
first commit         |   110,314
Update index.html    |    91,893
Update README        |    88,862
------------------------------------------------------------
Created: 2020-04-03 13:30:08.801000+00:00
Ended:   2020-04-03 13:30:15.334000+00:00
Bytes:   2,868,251,894

10. Charger des données dans BigQuery

Si vous souhaitez interroger vos propres données, vous devez les charger dans BigQuery. BigQuery est compatible avec le chargement de données à partir de nombreuses sources, y compris Cloud Storage, d'autres services Google et d'autres sources accessibles en lecture. Vous pouvez même diffuser vos données à l'aide d'insertions en flux continu. Pour en savoir plus, consultez la page Charger des données dans BigQuery.

Dans cette étape, vous allez charger un fichier JSON stocké dans Cloud Storage dans une table BigQuery. Le fichier JSON se trouve à l'adresse gs://cloud-samples-data/bigquery/us-states/us-states.json.

Si vous souhaitez en savoir plus sur le contenu du fichier JSON, vous pouvez utiliser l'outil de ligne de commande gsutil pour le télécharger dans Cloud Shell :

gsutil cp gs://cloud-samples-data/bigquery/us-states/us-states.json .

Vous pouvez constater qu'il contient la liste des États américains, et que chaque État est un document JSON sur une ligne distincte :

head us-states.json

{"name": "Alabama", "post_abbr": "AL"}
{"name": "Alaska", "post_abbr":  "AK"}
...

Pour charger ce fichier JSON dans BigQuery, accédez au fichier app.py dans le dossier bigquery_demo et remplacez le code par le code suivant.

from google.cloud import bigquery

client = bigquery.Client()

gcs_uri = 'gs://cloud-samples-data/bigquery/us-states/us-states.json'

dataset = client.create_dataset('us_states_dataset')
table = dataset.table('us_states_table')

job_config = bigquery.job.LoadJobConfig()
job_config.schema = [
    bigquery.SchemaField('name', 'STRING'),
    bigquery.SchemaField('post_abbr', 'STRING'),
]
job_config.source_format = bigquery.SourceFormat.NEWLINE_DELIMITED_JSON

load_job = client.load_table_from_uri(gcs_uri, table, job_config=job_config)

print('JSON file loaded to BigQuery')

Prenez une ou deux minutes pour étudier comment le code charge le fichier JSON et crée une table avec un schéma sous un ensemble de données.

Retournez dans Cloud Shell et exécutez l'application :

python3 app.py

Un ensemble de données et une table sont créés dans BigQuery.

Pour vérifier que l'ensemble de données a bien été créé, accédez à la console BigQuery. Un nouvel ensemble de données et un nouveau tableau devraient s'afficher. Passez à l'onglet "Aperçu" du tableau pour afficher vos données :

11. Félicitations !

Vous avez appris à utiliser BigQuery avec Python.

Nettoyage

Pour éviter que les ressources utilisées dans ce tutoriel soient facturées sur votre compte Google Cloud, procédez comme suit :

Dans la console Cloud, accédez à la page Gérer les ressources.
Dans la liste des projets, sélectionnez votre projet, puis cliquez sur Supprimer.
Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.

En savoir plus

Google BigQuery : https://cloud.google.com/bigquery/docs/
Python sur Google Cloud : https://cloud.google.com/python/
Bibliothèques clientes Cloud pour Python : https://googleapis.github.io/google-cloud-python/

Licence

Ce document est publié sous une licence Creative Commons Attribution 2.0 Generic.

Utiliser BigQuery avec Python Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

1. Présentation

Points abordés

Prérequis

Enquête

Comment allez-vous utiliser ce tutoriel ?

Quel est votre niveau d'expérience avec Python ?

Quel est votre niveau d'expérience avec les services Google Cloud ?

2. Préparation

Configuration de l'environnement au rythme de chacun

Démarrer Cloud Shell

Activer Cloud Shell

3. Activer l'API

4. Authentifier les requêtes API

5. Configurer le contrôle des accès

6. Installer la bibliothèque cliente

7. Interroger les œuvres de Shakespeare

8. Interroger l'ensemble de données GitHub

9. Mise en cache et statistiques

10. Charger des données dans BigQuery

11. Félicitations !

Nettoyage

En savoir plus

Licence

Utiliser BigQuery avec Python