À propos de cet article

L'autre jour, j'ai écrit du code pour faire fonctionner Dynamo DB sur AWS en utilisant Python. Pour rappel, je résumerai le script de base de l'époque et l'idée propre à Dynamo DB. Ce n'est pas exhaustif, mais je vais mentionner le minimum plus alpha. J'espère que cela aide les étrangers.

À propos de Dynamo DB

Aucune base de données SQL fournie par AWS.
Amazon DynamoDB (base de données NoSQL gérée) | AWS
Rapide sous forme de valeur-clé. --JSON peut également être enregistré en tant que valeur, mais ce n'est pas un DB de type objet. --Pour la cohérence des résultats, le contenu mis à jour peut ne pas être à temps lors de la lecture immédiatement après la mise à jour (Attention!)

Construction de l'environnement Python

Comme d'habitude, utilisez Boto3, le SDK d'AWS pour Python.
- AWS SDK for Python (Boto3)
Lors du développement sur une machine locale, il est nécessaire d'obtenir la clé d'accès AWS et de définir les informations d'identification dans l'AWS CLI à l'avance.
Configuration de DynamoDB (service Web) --Amazon DynamoDB --Il est également nécessaire de définir les informations d'authentification lors de l'utilisation de Cloud9. Notez que si vous ne désactivez pas le basculement des informations d'identification temporaires dans vos préférences, vous aurez des problèmes plus tard. (J'écrirai un article si j'ai une chance.)

Quelle classe dois-je utiliser pour faire fonctionner Dynamo DB?

DynamoDB — Boto3 Docs documentation

En premier...

--Pour Boto3, principalement Resource class et [Client] pour travailler avec Dynamo DB Il existe deux classes](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#client), quelle que soit la classe que vous utilisez pour ajouter des éléments à la table. Et la recherche est possible. «Je ne peux pas dire grand-chose parce que je ne suis pas familier avec cela, mais quand je me réfère au site suivant, il dit que" la classe client est moins abstraite ".

[Récit quand AWS Chalice n'a pas créé correctement la stratégie IAM requise](https://michimani.net/post/aws-about-auto-generate-iam-policy-in-chalice/#awc-chalice -% e3% 81% ae% e3% 82% bd% e3% 83% bc% e3% 82% b9% e3% 82% b3% e3% 83% bc% e3% 83% 89% e8% a7% a3% e6% 9e% 90% e3% 81% classe-client-af-% e3% 81% a7% e3% 81% ae% e5% ae% 9f% e8% a3% 85% e6% 99% 82% e3% 81 % ae% e3% 81% bf% e6% 9c% 89% e5% 8a% b9) --Pour ajouter un point, le site ci-dessus indique que si vous écrivez du code dans la classe Client, Chalice (* Infrastructure sans serveur AWS pour Python) peut générer automatiquement la stratégie IAM requise, mais dans mon environnement, la classe Client Mais il n'a pas été généré automatiquement. (* Ceci est une histoire uniquement lorsque vous utilisez Chalice.)

Comment créer une instance dans la classe Resource

Impression que Resource class est plus facile à implémenter.

import boto3

dynamodb = boto3.resource('dynamodb')
table = dynamodb.Table('name')

Comment créer une instance dans la classe Client

La Classe client couvre la plupart des API pour chaque service et est "basique". impression

import boto3

client = boto3.client('dynamodb')
#Le nom de la table est spécifié lors de l'utilisation de la table.

Mémo de script

―― Puisqu'il s'agit d'un mémo au moment de la vérification personnelle, dans quelle mesure sera-t-il pour votre référence ...

Définition / contenu de la table

--Contient des informations sur la station (préfecture et coordonnées). --Définissez prefecture comme clé de partition et id comme clé de tri comme clé primaire.

La clé primaire (Remarque: la clé de partition et la clé de tri) et les attributs sont tous de type caractère.
"Mise en garde! 》 Dans cet article, des chaînes de caractères japonais sont utilisées pour la clé de partition, mais c'est juste pour faciliter l'explication. ――Je pense qu'il est courant d'utiliser des chaînes de caractères alphanumériques et des chaînes numériques.

Code de pièce commun (à l'aide de la classe Resource)

import boto3
from boto3.dynamodb.conditions import Key, Attr

dynamodb = boto3.resource('dynamodb')
table = dynamodb.Table('table_name')

put_item

Décrivez l'élément que vous souhaitez ajouter dans l'élément dans le type de dictionnaire.
Le contenu de la clé primaire est obligatoire. L'attribut est arbitraire
Autrement dit, si la clé de partition et la clé de tri sont définies comme clé primaire, la clé de partition et la clé de tri doivent être décrites dans Élément. Si un seul est décrit, une erreur se produira. --Key --Value type DB, il n'est donc pas nécessaire d'aligner les attributs avec d'autres éléments.
Dans le cas de l'exemple suivant, il n'y a pas de problème bien que les informations de coordonnées, etc. ne soient pas décrites dans Item. Il n'est pas enregistré comme nul.

response = table.put_item(
    Item = {
        'prefecture':'Iwate',
        'id':'5',
        'stationName':'Morioka'
    }
)

print(response)
# {'ResponseMetadata': {'RequestId': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNO', 'HTTPStatusCode': 200, 'HTTPHeaders': {'server': 'Server', 'date': 'Mon, 28 Sep 2020 14:24:47 GMT', 'content-type': 'application/x-amz-json-1.0', 'content-length': '2', 'connection': 'keep-alive', 'x-amzn-requestid': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNO', 'x-amz-crc32': '2745614147'}, 'RetryAttempts': 0}}

Mise à jour de l'article avec put_item

--Si un élément avec la même clé primaire existe déjà sur la table, l'élément sera mis à jour.

À ce moment-là, tous les attributs sont écrasés.

response = table.put_item(
    Item = {
        'prefecture':'Hokkaido',
        'id':'13',
        'stationName':'Himekawa (mis à jour)',
        'hoge': 'fuga'
    }
)

print(response)
# {'ResponseMetadata': {'RequestId': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNO', 'HTTPStatusCode': 200, 'HTTPHeaders': {'server': 'Server', 'date': 'Mon, 28 Sep 2020 15:02:47 GMT', 'content-type': 'application/x-amz-json-1.0', 'content-length': '2', 'connection': 'keep-alive', 'x-amzn-requestid': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNO', 'x-amz-crc32': '2745614147'}, 'RetryAttempts': 0}}

get_item --Si vous avez uniquement défini la clé de partition comme clé primaire, définissez la clé de partition sur Clé.

Si vous avez défini à la fois la clé de partition et la clé de tri comme clé primaire, définissez la clé de partition et la clé de tri sur Clé. (Un exemple de code est ce modèle)
Dans ce cas, vous ne pouvez pas rechercher uniquement par la clé de partition. --Si vous souhaitez rechercher uniquement par la clé de partition, utilisez la méthode de requête décrite plus loin.

response = table.get_item(
    Key={
        'prefecture':'Hokkaido',
        'id':'1'
    }
)

print(response['Item'])
# {'stationName': 'Hakodate', 'prefecture': 'Hokkaido', 'id': '1', 'latitude': '41.773709', 'stationId': '1110101', 'longitude': '140.726413'}

query

Exemple d'utilisation ①

Même si la clé de partition et la clé de tri sont définies comme clé limary, la méthode de requête peut être utilisée pour rechercher en utilisant uniquement la clé de partition.

response = table.query(
    KeyConditionExpression = Key('prefecture').eq('Hokkaido')
)

print(response['Items'])
# [{'stationName': 'Hakodate', 'prefecture': 'Hokkaido', 'id': '1', 'latitude': '41.773709', 'stationId': '1110101', 'longitude': '140.726413'}, {'stationName': 'Rivière Akai', 'prefecture': 'Hokkaido', 'id': '10', 'latitude': '42.003267', 'stationId': '1110110', 'longitude': '140.642678'}, {'stationName': 'Komagatake', 'prefecture': 'Hokkaido', 'id': '11', 'latitude': '42.038809', 'stationId': '1110111', 'longitude': '140.610476'}, {'stationName': 'Higashiyama', 'prefecture': 'Hokkaido', 'id': '12', 'latitude': '42.06172', 'stationId': '1110112', 'longitude': '140.605222'}]

Exemple d'utilisation ②

Vous pouvez décrire les conditions de recherche pour la clé de partition et la clé de tri dans le paramètre KeyConditionExpression.
Pour savoir comment écrire KeyConditionExpression, consultez ce document ↓
- DynamoDB customization reference — Boto3 Docs documentation
Le paramètre ScanIndexForward est True par défaut. Lorsque True, la réponse est dans l'ordre croissant. S'il est défini sur False, l'ordre sera décroissant.
En utilisant le paramètre Limit, par exemple, seul le dernier est acquis. Etc. (lorsque l'heure est définie dans la clé de tri)

response = table.query(
    KeyConditionExpression = Key('prefecture').eq('Hokkaido')&Key('id').begins_with('1'),
    ScanIndexForward = False,
    Limit = 2,
)

print(response['Items'])
# [{'stationName': 'Choshiguchi', 'prefecture': 'Hokkaido', 'id': '16', 'latitude': '42.015471', 'stationId': '1110116', 'longitude': '140.720656'}, {'stationName': 'Ryuyama Onsen', 'prefecture': 'Hokkaido', 'id': '15', 'latitude': '42.003483', 'stationId': '1110115', 'longitude': '140.716358'}]

Si vous avez un GSI (Global Secondary Index)

--GSI (Global Secondary Index) vous permet de définir une nouvelle clé de partition / clé de tri en plus de la clé de partition de table / clé de tri. --Il existe également un LSI (Local Secondary Index), mais LSI définit la clé de partition telle quelle et uniquement la clé de tri. ――Cette page est facile à comprendre.

J'ai résumé l'index clé de DynamoDB --Qiita --Cliquez ici pour savoir comment créer GSI ↓
Étape 6: Créer un index secondaire global-Amazon DynamoDB