feat: Query filters for datastore (#936)

* First change - tests still passing * Enhanced test to test new properties * linting fixes * Update comment on operators. * Added 3 system tests * Count fix
googleapis · Jun 13, 2022 · 51725fa · 51725fa
1 parent faaec0d
commit 51725fa
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 4 deletions.
diff --git a/src/entity.ts b/src/entity.ts
@@ -1193,6 +1193,9 @@ export namespace entity {
       '<': 'LESS_THAN',
       '<=': 'LESS_THAN_OR_EQUAL',
       HAS_ANCESTOR: 'HAS_ANCESTOR',
+      '!=': 'NOT_EQUAL',
+      IN: 'IN',
+      NOT_IN: 'NOT_IN',
     };
 
     const SIGN_TO_ORDER = {

diff --git a/src/query.ts b/src/query.ts
@@ -22,7 +22,16 @@ import {Transaction} from './transaction';
 import {CallOptions} from 'google-gax';
 import {RunQueryStreamOptions} from '../src/request';
 
-export type Operator = '=' | '<' | '>' | '<=' | '>=' | 'HAS_ANCESTOR';
+export type Operator =
+  | '='
+  | '<'
+  | '>'
+  | '<='
+  | '>='
+  | 'HAS_ANCESTOR'
+  | '!='
+  | 'IN'
+  | 'NOT_IN';
 
 export interface OrderOptions {
   descending?: boolean;
@@ -154,8 +163,7 @@ class Query {
 
   /**
    * Datastore allows querying on properties. Supported comparison operators
-   * are `=`, `<`, `>`, `<=`, and `>=`. "Not equal" and `IN` operators are
-   * currently not supported.
+   * are `=`, `<`, `>`, `<=`, `>=`, `!=`, `HAS_ANCESTOR`, `IN` and `NOT_IN`.
    *
    * *To filter by ancestors, see {module:datastore/query#hasAncestor}.*
    *

diff --git a/system-test/datastore.ts b/system-test/datastore.ts
@@ -725,6 +725,33 @@ describe('Datastore', () => {
       assert.strictEqual(entities!.length, 6);
     });
 
+    it('should filter queries with NOT_EQUAL', async () => {
+      const q = datastore
+        .createQuery('Character')
+        .hasAncestor(ancestor)
+        .filter('appearances', '!=', 9);
+      const [entities] = await datastore.runQuery(q);
+      assert.strictEqual(entities!.length, 6);
+    });
+
+    it('should filter queries with IN', async () => {
+      const q = datastore
+        .createQuery('Character')
+        .hasAncestor(ancestor)
+        .filter('appearances', 'IN', [9, 25]);
+      const [entities] = await datastore.runQuery(q);
+      assert.strictEqual(entities!.length, 3);
+    });
+
+    it('should filter queries with NOT_IN', async () => {
+      const q = datastore
+        .createQuery('Character')
+        .hasAncestor(ancestor)
+        .filter('appearances', 'NOT_IN', [9, 25]);
+      const [entities] = await datastore.runQuery(q);
+      assert.strictEqual(entities!.length, 5);
+    });
+
     it('should filter queries with defined indexes', async () => {
       const q = datastore
         .createQuery('Character')

diff --git a/test/query.ts b/test/query.ts
@@ -75,7 +75,10 @@ describe('Query', () => {
         .filter('name', '=', 'Title')
         .filter('count', '>', 20)
         .filter('size', '<', 10)
-        .filter('something', '>=', 11);
+        .filter('something', '>=', 11)
+        .filter('neProperty', '!=', 12)
+        .filter('inProperty', 'IN', 13)
+        .filter('notInProperty', 'NOT_IN', 14);
 
       assert.strictEqual(query.filters[0].name, 'date');
       assert.strictEqual(query.filters[0].op, '<=');
@@ -96,6 +99,18 @@ describe('Query', () => {
       assert.strictEqual(query.filters[4].name, 'something');
       assert.strictEqual(query.filters[4].op, '>=');
       assert.strictEqual(query.filters[4].val, 11);
+
+      assert.strictEqual(query.filters[5].name, 'neProperty');
+      assert.strictEqual(query.filters[5].op, '!=');
+      assert.strictEqual(query.filters[5].val, 12);
+
+      assert.strictEqual(query.filters[6].name, 'inProperty');
+      assert.strictEqual(query.filters[6].op, 'IN');
+      assert.strictEqual(query.filters[6].val, 13);
+
+      assert.strictEqual(query.filters[7].name, 'notInProperty');
+      assert.strictEqual(query.filters[7].op, 'NOT_IN');
+      assert.strictEqual(query.filters[7].val, 14);
     });
 
     it('should remove any whitespace surrounding the filter name', () => {