I am trying to programmatically create a FilterExpression in Python for a DynamoDB query based on user provided parameter(s) for a specific Attribute (let's call it 'ATTRIBUTE1
').
All user provided parameters which I need to filter for are in a list. For example: ['Parameter1', 'Parameter2']
Which would then take the form Attr('ATTRIBUTE1').eq(PARAMETER1)&Attr.('ATTRIBUTE1').eq(PARAMETER2)
How can I programmatically create an Attr for my FilterExpression like the above which is based on a changing number of user provided parameter(s)?
Sometimes I might have ['Parameter1']
and another time I might have ['Parameter1', 'Parameter2', 'Parameter3']
which need to turn into Attr('ATTRIBUTE1').eq('Parameter1')
and Attr('ATTRIBUTE1').eq('Parameter1')&Attr('ATTRIBUTE1').eq('Parameter2')&Attr('ATTRIBUTE1').eq('Parameter3')
, respectively.
I haven't been able to find a solution for this yet and would appreciate any guidance. Thanks in advance.
Here's a compact way I was able to get this working:
from functools import reduce
from boto3.dynamodb.conditions import Key, And
response = table.scan(FilterExpression=reduce(And, ([Key(k).eq(v) for k, v in filters.items()])))
For example, filters
would be a dict
like:
{
'Status': 'Approved',
'SubmittedBy': 'JackCasey'
}
You can try the following. I run through the loop of query params to build the dynamodb conditions.
if event.get('queryStringParameters'):
query_params = event.get('queryStringParameters')
for query_param, value in query_params.items():
if query_param == 'attribute1':
filter_expression_list.append(Attr('attribute1').gte(value))
if query_param == 'attribute2':
filter_expression_list.append(Attr('attribute2').eq(value))
if query_param == 'attribute3':
filter_expression_list.append(Attr('attribute3').eq(value))
FilterExpression = get_filter_expression(filter_expression_list)
Update:
Can use the following code to get the filter expression. This will handle the case when there are 2 or more than 2 expressions
def get_filter_expression(filter_expression_list):
filter_expression = None
first = True
for filter in filter_expression_list:
if first:
filter_expression = filter
first = False
else:
filter_expression = filter_expression & filter
return filter_expression
Combination of FilterExpression in a string form and ExpressionAttributeValues can work, consider following example:
attrs = ["attribute1", "attribute2", "attribute3"]
user_input = ["parameter1", "paramater2", "parameter3"]
ExpressionAttributeValues = {}
FilterExpression = "";
for index, input in enumerate(attrs):
if(len(attrs)-1 == index): FilterExpression += input+"=:"+input
else: FilterExpression += input+" = :"+input + " AND ";
for index, input in enumerate(user_input):
AttrName = ":" + attrs[index]
ExpressionAttributeValues[AttrName] = {
"S" : input
}
print(ExpressionAttributeValues)
print(FilterExpression)
then you can use these two in your query, more on here http://boto3.readthedocs.io/en/latest/reference/services/dynamodb.html#client
A compact, Pythonic approach might be to manage the criteria in a dictionary, avoid the looping in favor of comprehensions, and use the string format method:
criteria = {'my_key1': 'my_value1', 'my_key2': 'my_value2'}
FilterExpression = ' AND '.join(['{0}=:{0}'.format(k) for k, v in criteria.items()])
ExpressionAttributeValues = {':{}'.format(k): {'S': v} for k, v in criteria.items()}
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With