Implement $exists

Author: erikdubbelboer

filter/converter.go

@@ -150,6 +150,24 @@ func (c *Converter) convertFilter(filter map[string]any, paramIndex int) (string
 							v[operator] = c.arrayDriver(v[operator])
 						}
 						values = append(values, v[operator])
+					case "$exists":
+						// $exists only works on jsonb columns, so we need to check if the key is in the JSONB data first.
+						isNestedColumn := c.nestedColumn != ""
+						for _, exemption := range c.nestedExemptions {
+							if exemption == key {
+								isNestedColumn = false
+								break
+							}
+						}
+						if !isNestedColumn {
+							// There is no way in Postgres to check if a column exists on a table.
+							return "", nil, fmt.Errorf("$exists operator not supported on non-nested jsonb columns")
+						}
+						neg := ""
+						if v[operator] == false {
+							neg = "NOT "
+						}
+						inner = append(inner, fmt.Sprintf("(%sjsonb_path_match(%s, 'exists($.%s)'))", neg, c.nestedColumn, key))
 					default:
 						value := v[operator]
 						op, ok := BasicOperatorMap[operator]

filter/converter_test.go

@@ -208,6 +208,22 @@ func TestConverter_Convert(t *testing.T) {
 			nil,
 			fmt.Errorf("empty objects not allowed"),
 		},
+		{
+			"$exists on normal column",
+			nil,
+			`{"name": {"$exists": false}}`,
+			``,
+			nil,
+			fmt.Errorf("$exists operator not supported on non-nested jsonb columns"),
+		},
+		{
+			"$exists jsonb column",
+			filter.WithNestedJSONB("meta"),
+			`{"name": {"$exists": false}}`,
+			`(NOT jsonb_path_match(meta, 'exists($.name)'))`,
+			nil,
+			nil,
+		},
 	}
 
 	for _, tt := range tests {

fuzz/fuzz_test.go

@@ -33,6 +33,7 @@ func FuzzConverter(f *testing.F) {
 		`{"name": {}}`,
 		`{"$or": []}`,
 		`{"status": {"$in": []}}`,
+		`{"name": {"$exists": false}}`,
 	}
 	for _, tc := range tcs {
 		f.Add(tc)

integration/postgres_test.go

@@ -297,6 +297,18 @@ func TestIntegration_BasicOperators(t *testing.T) {
 			[]int{},
 			nil,
 		},
+		{
+			`jsonb exists`,
+			`{"pet": {"$exists": false}}`,
+			[]int{9},
+			nil,
+		},
+		{
+			`jsonb exists`,
+			`{"pet": {"$exists": true}}`,
+			[]int{1, 2, 3, 4, 5, 6, 7, 8, 10},
+			nil,
+		},
 	}
 
 	for _, tt := range tests {