如何检查 DynamoDB 表是否存在？

Question

我是 boto3 的新用户，我正在使用 DynamoDB。

我浏览了 DynamoDB api，但找不到任何方法可以告诉我表是否已经存在。

处理此问题的最佳方法是什么？

我应该尝试创建一个新表并使用 try catch 包装它吗？

Answer 1

通过阅读文档，我可以看到有三种方法可以检查表是否存在。

1. 如果表已经存在，CreateTable API 会抛出错误ResourceInUseException。用 try 包裹 create_table 方法来捕获它
2. 您可以使用ListTables API 获取与当前帐户和端点关联的表名列表。检查您在响应中获得的表名列表中是否存在该表名。
3. 如果您请求的表名不存在，DescribeTable API 将抛出错误ResourceNotFoundException。

对我来说，如果您只想创建一个表，第一个选项听起来更好。

编辑： 我看到有些人发现很难捕捉到异常。我会在下面放一些代码让你知道如何处理boto3中的异常。

示例 1

import boto3

dynamodb_client = boto3.client('dynamodb')

try:
    response = dynamodb_client.create_table(
        AttributeDefinitions=[
            {
                'AttributeName': 'Artist',
                'AttributeType': 'S',
            },
            {
                'AttributeName': 'SongTitle',
                'AttributeType': 'S',
            },
        ],
        KeySchema=[
            {
                'AttributeName': 'Artist',
                'KeyType': 'HASH',
            },
            {
                'AttributeName': 'SongTitle',
                'KeyType': 'RANGE',
            },
        ],
        ProvisionedThroughput={
            'ReadCapacityUnits': 5,
            'WriteCapacityUnits': 5,
        },
        TableName='test',
    )
except dynamodb_client.exceptions.ResourceInUseException:
    # do something here as you require
    pass

示例 2

import boto3

dynamodb_client = boto3.client('dynamodb')


table_name = 'test'
existing_tables = dynamodb_client.list_tables()['TableNames']

if table_name not in existing_tables:
    response = dynamodb_client.create_table(
        AttributeDefinitions=[
            {
                'AttributeName': 'Artist',
                'AttributeType': 'S',
            },
            {
                'AttributeName': 'SongTitle',
                'AttributeType': 'S',
            },
        ],
        KeySchema=[
            {
                'AttributeName': 'Artist',
                'KeyType': 'HASH',
            },
            {
                'AttributeName': 'SongTitle',
                'KeyType': 'RANGE',
            },
        ],
        ProvisionedThroughput={
            'ReadCapacityUnits': 5,
            'WriteCapacityUnits': 5,
        },
        TableName=table_name,
    )

示例 3

import boto3

dynamodb_client = boto3.client('dynamodb')

try:
    response = dynamodb_client.describe_table(TableName='test')
except dynamodb_client.exceptions.ResourceNotFoundException:
    # do something here as you require
    pass

Answer 2

import boto3

from botocore.exceptions import ClientError

TABLE_NAME = "myTableName"
dynamodb = boto3.resource('dynamodb', endpoint_url="https://dynamodb.us-east-1.amazonaws.com")

table = dynamodb.Table(TABLE_NAME)

try:
    response = client.describe_table(TableName=TABLE_NAME)

except ClientError as ce:
if ce.response['Error']['Code'] == 'ResourceNotFoundException':
    print "Table " + TABLE_NAME + " does not exist. Create the table first and try again."
else:
    print "Unknown exception occurred while querying for the " + TABLE_NAME + " table. Printing full error:"
    pprint.pprint(ce.response)

Answer 3

如果您不想使用boto3.client 而只想使用boto3.resource，则另一种方法：

import boto3

database = boto3.resource('dynamodb', endpoint_url="http://localhost:8000")    

table_name  = 'MyTable'
table_names = [table.name for table in database.tables.all()]

if table_name in table_names:
    print('table', table_name, 'exists')

Answer 4

您可以使用describe table API 来判断该表是否存在。

示例代码：

from __future__ import print_function # Python 2/3 compatibility
import os
os.environ["TZ"] = "UTC"
import boto3

client = boto3.client('dynamodb', region_name='us-west-2', endpoint_url="http://localhost:8000")



response = client.describe_table(
    TableName='Movies'
)    

print(response)

如果表存在：-

• 您会收到回复

如果表不存在：-

• 你会得到ResourceNotFoundException

  botocore.errorfactory.ResourceNotFoundException：发生错误（ResourceNotF oudException) 调用 DescribeTable 操作时：无法对 一个不存在的表

另一种方式：-

等到此表存在。该方法调用 轮询的 DynamoDB.Waiter.table_exists.wait()。 DynamoDB.Client.describe_table() 每 20 秒一次，直到成功 状态达到。检查失败 25 次后返回错误。

table.wait_until_exists()

Answer 5

您可以使用任何 boto3 Table 实例对象的.table_status attr。如果存在（CREATING、UPDATING、DELETING、ACTIVE）或抛出异常botocore.exceptions.ClientError: Requested resource not found: Table: <YOUR_TABLE_NAME> not found，它将返回其状态。您可以将这些条件包装到 try / 中，以获取有关当前表状态的完整信息。

import boto3
from botocore.exceptions import ClientError

dynamodb = boto3.resource('dynamodb', region_name='us-west-2')
table = dynamodb.Table('your_table_name_str')

try:
  is_table_existing = table.table_status in ("CREATING", "UPDATING",
                                             "DELETING", "ACTIVE")
except ClientError:
  is_table_existing = False
  print "Table %s doesn't exist." % table.name

Answer 6

请注意，这取决于您使用的是客户端还是资源。如果您使用boto3.client()，则可以使用接受的答案建议的 3 种方法。如果您使用boto3.resource()，则只能使用dynamodb_resource.create_table()并检查异常。

try:
    table = dynamodb_resource.create_table(
        ...
    )
    table.meta.client.get_waiter('table_exists').wait(TableName=your_table_name)
except ResourceInUseException:
    # do sth here