@neo4j/cypher-builder
Version:
A programmatic API for building Cypher queries for Neo4j
175 lines (174 loc) • 8.89 kB
JavaScript
;
/*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*/
var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
var _, done = false;
for (var i = decorators.length - 1; i >= 0; i--) {
var context = {};
for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
for (var p in contextIn.access) context.access[p] = contextIn.access[p];
context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
if (kind === "accessor") {
if (result === void 0) continue;
if (result === null || typeof result !== "object") throw new TypeError("Object expected");
if (_ = accept(result.get)) descriptor.get = _;
if (_ = accept(result.set)) descriptor.set = _;
if (_ = accept(result.init)) initializers.unshift(_);
}
else if (_ = accept(result)) {
if (kind === "field") initializers.unshift(_);
else descriptor[key] = _;
}
}
if (target) Object.defineProperty(target, contextIn.name, descriptor);
done = true;
};
var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
var useValue = arguments.length > 2;
for (var i = 0; i < initializers.length; i++) {
value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
}
return useValue ? value : void 0;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.OptionalCall = exports.Call = void 0;
const compile_cypher_if_exists_1 = require("../utils/compile-cypher-if-exists");
const is_number_1 = require("../utils/is-number");
const pad_block_1 = require("../utils/pad-block");
const Clause_1 = require("./Clause");
const WithCreate_1 = require("./mixins/clauses/WithCreate");
const WithLet_1 = require("./mixins/clauses/WithLet");
const WithMatch_1 = require("./mixins/clauses/WithMatch");
const WithMerge_1 = require("./mixins/clauses/WithMerge");
const WithReturn_1 = require("./mixins/clauses/WithReturn");
const WithUnwind_1 = require("./mixins/clauses/WithUnwind");
const WithWith_1 = require("./mixins/clauses/WithWith");
const WithDelete_1 = require("./mixins/sub-clauses/WithDelete");
const WithOrder_1 = require("./mixins/sub-clauses/WithOrder");
const WithSetRemove_1 = require("./mixins/sub-clauses/WithSetRemove");
const mixin_1 = require("./utils/mixin");
/** Adds a `CALL` subquery
* @param subquery - A clause to be wrapped in a `CALL` clause
* @param variableScope - A list of variables to pass to the scope of the clause: `CALL (var0) {`
* @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/call-subquery/ | Cypher Documentation}
* @group Subqueries
*/
let Call = (() => {
let _classDecorators = [(0, mixin_1.mixin)(WithReturn_1.WithReturn, WithWith_1.WithWith, WithUnwind_1.WithUnwind, WithDelete_1.WithDelete, WithSetRemove_1.WithSetRemove, WithMatch_1.WithMatch, WithCreate_1.WithCreate, WithMerge_1.WithMerge, WithOrder_1.WithOrder, WithLet_1.WithLet)];
let _classDescriptor;
let _classExtraInitializers = [];
let _classThis;
let _classSuper = Clause_1.Clause;
var Call = class extends _classSuper {
static { _classThis = this; }
static {
const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
__esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
Call = _classThis = _classDescriptor.value;
if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
__runInitializers(_classThis, _classExtraInitializers);
}
subquery;
inTransactionsConfig;
variableScope;
_optional = false;
constructor(subquery, variableScope) {
super();
const rootQuery = subquery.getRoot();
this.addChildren(rootQuery);
this.subquery = rootQuery;
this.variableScope = variableScope;
}
inTransactions(config = {}) {
this.inTransactionsConfig = config;
return this;
}
/** Makes the subquery an OPTIONAL CALL
* @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#optional-call | Cypher Documentation}
* @since Neo4j 5.24
*/
optional() {
this._optional = true;
return this;
}
/** @internal */
getCypher(env) {
const subQueryStr = this.subquery.getCypher(env);
const setCypher = this.compileSetCypher(env);
const deleteCypher = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.deleteClause, env, { prefix: "\n" });
const orderByCypher = (0, compile_cypher_if_exists_1.compileCypherIfExists)(this.orderByStatement, env, { prefix: "\n" });
const inTransactionCypher = this.generateInTransactionsStr();
const variableScopeStr = this.generateVariableScopeStr(env);
const nextClause = this.compileNextClause(env);
const optionalStr = this._optional ? "OPTIONAL " : "";
return `${optionalStr}CALL${variableScopeStr} {\n${(0, pad_block_1.padBlock)(subQueryStr)}\n}${inTransactionCypher}${setCypher}${deleteCypher}${orderByCypher}${nextClause}`;
}
generateVariableScopeStr(env) {
if (!this.variableScope) {
return "";
}
if (this.variableScope === "*") {
return ` (*)`;
}
const variablesString = this.variableScope.map((variable) => variable.getCypher(env));
return ` (${variablesString.join(", ")})`;
}
generateInTransactionsStr() {
if (!this.inTransactionsConfig) {
return "";
}
const rows = this.inTransactionsConfig.ofRows;
const error = this.inTransactionsConfig.onError;
const ofRowsStr = rows ? ` OF ${rows} ROWS` : "";
let onErrorStr = "";
if (this.inTransactionsConfig.retry !== undefined && this.inTransactionsConfig.retry !== false) {
onErrorStr = this.generateRetryErrorStr(this.inTransactionsConfig);
}
else if (error) {
onErrorStr = ` ON ERROR ${this.getOnErrorStr(error)}`;
}
const concurrentTransactions = this.inTransactionsConfig.concurrentTransactions;
const concurrentTransactionsStr = typeof concurrentTransactions === "number" ? ` ${concurrentTransactions} CONCURRENT` : "";
return ` IN${concurrentTransactionsStr} TRANSACTIONS${ofRowsStr}${onErrorStr}`;
}
generateRetryErrorStr(transactionConfig) {
const error = transactionConfig.onError;
const hasTime = (0, is_number_1.isNumber)(transactionConfig.retry);
const thenStr = error ? ` THEN ${this.getOnErrorStr(error)}` : "";
const timeStr = hasTime ? ` FOR ${transactionConfig.retry} SECONDS` : "";
return ` ON ERROR RETRY${timeStr}${thenStr}`;
}
getOnErrorStr(err) {
const errorMap = {
continue: "CONTINUE",
break: "BREAK",
fail: "FAIL",
};
if (!errorMap[err]) {
throw new Error(`Incorrect ON ERROR option ${err}`);
}
return errorMap[err];
}
};
return Call = _classThis;
})();
exports.Call = Call;
/**
* @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#optional-call | Cypher Documentation}
* @group Subqueries
* @since Neo4j 5.24
*/
class OptionalCall extends Call {
constructor(subquery, variableScope) {
super(subquery, variableScope);
this.optional();
}
}
exports.OptionalCall = OptionalCall;