@google-cloud/datastore
Version:
Cloud Datastore Client Library for Node.js
151 lines • 4.51 kB
JavaScript
;
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
Object.defineProperty(exports, "__esModule", { value: true });
exports.PropertyFilter = exports.EntityFilter = void 0;
exports.and = and;
exports.or = or;
exports.isFilter = isFilter;
const entity_1 = require("./entity");
const OP_TO_OPERATOR = new Map([
['=', 'EQUAL'],
['>', 'GREATER_THAN'],
['>=', 'GREATER_THAN_OR_EQUAL'],
['<', 'LESS_THAN'],
['<=', 'LESS_THAN_OR_EQUAL'],
['HAS_ANCESTOR', 'HAS_ANCESTOR'],
['!=', 'NOT_EQUAL'],
['IN', 'IN'],
['NOT_IN', 'NOT_IN'],
]);
var CompositeOperator;
(function (CompositeOperator) {
CompositeOperator["AND"] = "AND";
CompositeOperator["OR"] = "OR";
})(CompositeOperator || (CompositeOperator = {}));
/**
* And filters are composed of many other filters and when they are applied
* then query results are only returned when they pass through all these other
* filters.
*
* @param {EntityFilter[]} filters The list of filters that make up the AND filter.
* @returns {CompositeFilter} A composite AND filter.
*
*/
function and(filters) {
return new CompositeFilter(filters, CompositeOperator.AND);
}
/**
* Or filters are composed of many other filters and when they are applied
* then query results are returned when they pass through any of these other
* filters.
*
* @param {EntityFilter[]} filters The list of filters that make up the OR filter.
* @returns {CompositeFilter} A composite OR filter.
*
*/
function or(filters) {
return new CompositeFilter(filters, CompositeOperator.OR);
}
/**
* A Filter is a class that contains data for a filter that can be translated
* into a proto when needed.
*
* @see {@link https://cloud.google.com/datastore/docs/concepts/queries#filters| Filters Reference}
*
*/
class EntityFilter {
}
exports.EntityFilter = EntityFilter;
/**
* A PropertyFilter is a filter that gets applied to a query directly.
*
* @see {@link https://cloud.google.com/datastore/docs/concepts/queries#property_filters| Property filters Reference}
*
* @class
*/
class PropertyFilter extends EntityFilter {
name;
op;
val;
/**
* Build a Property Filter object.
*
* @param {string} Property The property name that the filter will be applied to.
* @param {Operator} operator The comparison operator that the filter applies.
* @param {any} val The value that the filter compares the property to.
*/
constructor(name, op, val) {
super();
this.name = name;
this.op = op;
this.val = val;
}
/**
* Gets the proto for the filter.
*
*/
// eslint-disable-next-line
toProto() {
return {
propertyFilter: {
property: {
name: this.name,
},
op: OP_TO_OPERATOR.get(this.op),
value: entity_1.entity.encodeValue(this.val, this.name),
},
};
}
}
exports.PropertyFilter = PropertyFilter;
/**
* A CompositeFilter is a filter that combines other filters and applies that
* combination to a query.
*
* @see {@link https://cloud.google.com/datastore/docs/concepts/queries#composite_filters| Composite filters Reference}
*
* @class
*/
class CompositeFilter extends EntityFilter {
filters;
op;
/**
* Build a Composite Filter object.
*
* @param {EntityFilter[]} filters The filters that make up the composite filter.
*/
constructor(filters, op) {
super();
this.filters = filters;
this.op = op;
}
/**
* Gets the proto for the filter.
*
*/
// eslint-disable-next-line
toProto() {
return {
compositeFilter: {
filters: this.filters.map(filter => filter.toProto()),
op: this.op,
},
};
}
}
function isFilter(filter) {
return filter instanceof EntityFilter;
}
//# sourceMappingURL=filter.js.map