Added OperatorType.IN for use with DynamoDB filter expressions

barchart · May 25, 2023 · c28604d · c28604d
1 parent 8488b84
commit c28604d
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.releases/4.25.0.md b/.releases/4.25.0.md
@@ -0,0 +1,3 @@
+**New Features**
+
+* Added `OperatorType.IN` for use with DynamoDB filter expressions.
diff --git a/aws/dynamo/query/definitions/OperatorType.js b/aws/dynamo/query/definitions/OperatorType.js
@@ -181,6 +181,16 @@ module.exports = (() => {
 			return operatorTypeBeginsWith;
 		}
 
+		/**
+		 * Attribute matches one of the operand values.
+		 *
+		 * @public
+		 * @returns {OperatorType}
+		 */
+		static get IN() {
+			return operatorTypeIn;
+		}
+
 		/**
 		 * Attribute exists.
 		 *
@@ -224,5 +234,7 @@ module.exports = (() => {
 	const operatorTypeAttributeExists = new OperatorType('Attribute Exists', (f, o) => `attribute_exists(${f})`, 0, [ ]);
 	const operatorTypeAttributeNotExists = new OperatorType('Attribute Not Exists', (f, o) => `attribute_not_exists(${f})`, 0, [ KeyType.HASH, KeyType.RANGE ]);
 
+	const operatorTypeIn = new OperatorType('In', (f, o) => `${f} IN (${o.join(',')})`, 2, [ KeyType.RANGE ]);
+
 	return OperatorType;
 })();