@ragestudio/scylla-odm 0.22.2 → 0.22.4

package/driver/mapping/result-mapper.js

@@ -0,0 +1,123 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *     http://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.
+ */
+
+import vm from "vm"
+import utils from "../utils.js"
+import types from "../types/index.js"
+
+/**
+ * @ignore
+ */
+class ResultMapper {
+	/**
+	 * Gets a generated function to adapt the row to a document.
+	 * @param {ModelMappingInfo} info
+	 * @param {ResultSet} rs
+	 * @returns {Function}
+	 */
+	static getSelectAdapter(info, rs) {
+		const columns = rs.columns
+		if (!columns) {
+			throw new Error("Expected ROWS result obtained VOID")
+		}
+
+		let scriptText =
+			"(function rowAdapter(row, info) {\n" +
+			"  const item = info.newInstance();\n"
+
+		for (const c of columns) {
+			scriptText += `  item['${info.getPropertyName(c.name)}'] = `
+
+			if (!info.getToModelFn(c.name)) {
+				scriptText += `row['${c.name}'];\n`
+			} else {
+				scriptText += `info.getToModelFn('${c.name}')(row['${c.name}']);\n`
+			}
+		}
+
+		scriptText += "  return item;\n})"
+
+		const script = new vm.Script(scriptText, {
+			filename: "gen-result-mapper",
+		})
+		return script.runInThisContext()
+	}
+
+	/**
+	 * Gets a function used to adapt VOID results or conditional updates.
+	 * @param {ResultSet} rs
+	 * @returns {Function}
+	 */
+	static getMutationAdapter(rs) {
+		if (rs.columns === null) {
+			// VOID result
+			return utils.noop
+		}
+
+		if (
+			rs.columns.length === 1 &&
+			rs.columns[0].name === "[applied]" &&
+			rs.columns[0].type.code === types.dataTypes.boolean
+		) {
+			return utils.noop
+		}
+
+		return ResultMapper._getConditionalRowAdapter(rs)
+	}
+
+	static _getConditionalRowAdapter(rs) {
+		return function conditionalRowAdapter(row, info) {
+			const item = info.newInstance()
+
+			// Skip the first column ("[applied]")
+			for (let i = 1; i < rs.columns.length; i++) {
+				const c = rs.columns[i]
+				item[info.getPropertyName(c.name)] = row[c.name]
+			}
+
+			return item
+		}
+	}
+
+	/**
+	 * @param {ModelMappingInfo} info
+	 * @param {ResultSet} rs
+	 * @returns {{canCache: Boolean, fn: Function}}
+	 */
+	static getCustomQueryAdapter(info, rs) {
+		if (rs.columns === null || rs.columns.length === 0) {
+			// VOID result
+			return { canCache: true, fn: utils.noop }
+		}
+
+		if (
+			rs.columns[0].name === "[applied]" &&
+			rs.columns[0].type.code === types.dataTypes.boolean
+		) {
+			// Conditional update results adapter functions should not be cached
+			return {
+				canCache: false,
+				fn: ResultMapper._getConditionalRowAdapter(rs),
+			}
+		}
+
+		return { canCache: true, fn: ResultMapper.getSelectAdapter(info, rs) }
+	}
+}
+
+export default ResultMapper

package/driver/mapping/result.js

@@ -0,0 +1,139 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *     http://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.
+ */
+
+import util from "util"
+import utils from "../utils.js"
+const inspectMethod = util.inspect.custom || "inspect"
+
+/**
+ * Represents the result of an execution as an iterable of objects in the Mapper.
+ * @alias module:mapping~Result
+ */
+class Result {
+	/**
+	 * Creates a new instance of Result.
+	 * @param {ResultSet} rs
+	 * @param {ModelMappingInfo} info
+	 * @param {Function} rowAdapter
+	 */
+	constructor(rs, info, rowAdapter) {
+		this._rs = rs
+		this._info = info
+		this._rowAdapter = rowAdapter
+
+		/**
+		 * When there is a single cell containing the result of the a LWT operation, hide the result from the user.
+		 * @private
+		 */
+		this._isEmptyLwt =
+			rs.columns !== null &&
+			rs.columns.length === 1 &&
+			this._rs.rowLength === 1 &&
+			rs.columns[0].name === "[applied]"
+
+		/**
+		 * Gets the amount of the documents contained in this Result instance.
+		 * <p>
+		 *   When the results are paged, it returns the length of the current paged results not the total amount of
+		 *   rows in the table matching the query.
+		 * </p>
+		 * @type {Number}
+		 */
+		this.length = this._isEmptyLwt ? 0 : rs.rowLength || 0
+
+		/**
+		 * A string token representing the current page state of query.
+		 * <p>
+		 *   When provided, it can be used in the following executions to continue paging and retrieve the remained of the
+		 *   result for the query.
+		 * </p>
+		 * @type {String}
+		 * @default null
+		 */
+		this.pageState = rs.pageState
+	}
+
+	/**
+	 * When this instance is the result of a conditional update query, it returns whether it was successful.
+	 * Otherwise, it returns <code>true</code>.
+	 * <p>
+	 *   For consistency, this method always returns <code>true</code> for non-conditional queries (although there is
+	 *   no reason to call the method in that case). This is also the case for conditional DDL statements
+	 *   (CREATE KEYSPACE... IF NOT EXISTS, CREATE TABLE... IF NOT EXISTS), for which the server doesn't return
+	 *   information whether it was applied or not.
+	 * </p>
+	 */
+	wasApplied() {
+		return this._rs.wasApplied()
+	}
+
+	/**
+	 * Gets the first document in this result or null when the result is empty.
+	 */
+	first() {
+		if (!this._rs.rowLength || this._isEmptyLwt) {
+			return null
+		}
+		return this._rowAdapter(this._rs.rows[0], this._info)
+	}
+
+	/**
+	 * Returns a new Iterator object that contains the document values.
+	 */
+	*[Symbol.iterator]() {
+		if (this._isEmptyLwt) {
+			// Empty iterator
+			return
+		}
+
+		for (let i = 0; i < this._rs.rows.length; i++) {
+			yield this._rowAdapter(this._rs.rows[i], this._info)
+		}
+	}
+
+	/**
+	 * Converts the current instance to an Array of documents.
+	 * @return {Array<Object>}
+	 */
+	toArray() {
+		if (this._isEmptyLwt || !this._rs.rows) {
+			return utils.emptyArray
+		}
+
+		return this._rs.rows.map((row) => this._rowAdapter(row, this._info))
+	}
+
+	/**
+	 * Executes a provided function once per result element.
+	 * @param {Function} callback Function to execute for each element, taking two arguments: currentValue and index.
+	 * @param {Object} [thisArg] Value to use as <code>this</code> when executing callback.
+	 */
+	forEach(callback, thisArg) {
+		let index = 0
+		thisArg = thisArg || this
+		for (const doc of this) {
+			callback.call(thisArg, doc, index++)
+		}
+	}
+
+	[inspectMethod]() {
+		return this.toArray()
+	}
+}
+
+export default Result

package/driver/mapping/table-mappings.js

@@ -0,0 +1,133 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *     http://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.
+ */
+
+/**
+ * Contains a set of methods to represent a row into a document and a document into a row.
+ * @alias module:mapping~TableMappings
+ * @interface
+ */
+class TableMappings {
+	/**
+	 * Method that is called by the mapper to create the instance of the document.
+	 * @return {Object}
+	 */
+	newObjectInstance() {
+		return {}
+	}
+
+	/**
+	 * Gets the name of the column based on the document property name.
+	 * @param {String} propName The name of the property.
+	 * @returns {String}
+	 */
+	getColumnName(propName) {
+		return propName
+	}
+
+	/**
+	 * Gets the name of the document property based on the column name.
+	 * @param {String} columnName The name of the column.
+	 * @returns {String}
+	 */
+	getPropertyName(columnName) {
+		return columnName
+	}
+}
+
+/**
+ * A [TableMappings]{@link module:mapping~TableMappings} implementation that converts CQL column names in all-lowercase
+ * identifiers with underscores (snake case) to camel case (initial lowercase letter) property names.
+ * <p>
+ *   The conversion is performed without any checks for the source format, you should make sure that the source
+ *   format is snake case for CQL identifiers and camel case for properties.
+ * </p>
+ * @alias module:mapping~UnderscoreCqlToCamelCaseMappings
+ * @implements {module:mapping~TableMappings}
+ */
+class UnderscoreCqlToCamelCaseMappings extends TableMappings {
+	/**
+	 * Creates a new instance of {@link UnderscoreCqlToCamelCaseMappings}
+	 */
+	constructor() {
+		super()
+	}
+
+	/**
+	 * Converts a property name in camel case to snake case.
+	 * @param {String} propName Name of the property to convert to snake case.
+	 * @return {String}
+	 */
+	getColumnName(propName) {
+		return propName
+			.replace(
+				/[a-z][A-Z]/g,
+				(match, offset) => match.charAt(0) + "_" + match.charAt(1),
+			)
+			.toLowerCase()
+	}
+
+	/**
+	 * Converts a column name in snake case to camel case.
+	 * @param {String} columnName The column name to convert to camel case.
+	 * @return {String}
+	 */
+	getPropertyName(columnName) {
+		return columnName.replace(/_[a-z]/g, (match, offset) =>
+			offset === 0 ? match : match.substr(1).toUpperCase(),
+		)
+	}
+}
+
+/**
+ * Default implementation of [TableMappings]{@link module:mapping~TableMappings} that doesn't perform any conversion.
+ * @alias module:mapping~DefaultTableMappings
+ * @implements {module:mapping~TableMappings}
+ */
+class DefaultTableMappings extends TableMappings {
+	/**
+	 * Creates a new instance of {@link DefaultTableMappings}.
+	 */
+	constructor() {
+		super()
+	}
+
+	/**  @override */
+	getColumnName(propName) {
+		return super.getColumnName(propName)
+	}
+
+	/** @override */
+	getPropertyName(columnName) {
+		return super.getPropertyName(columnName)
+	}
+
+	/**
+	 * Creates a new object instance, using object initializer.
+	 */
+	newObjectInstance() {
+		return super.newObjectInstance()
+	}
+}
+
+export { TableMappings, UnderscoreCqlToCamelCaseMappings, DefaultTableMappings }
+
+export default {
+	TableMappings,
+	UnderscoreCqlToCamelCaseMappings,
+	DefaultTableMappings,
+}

package/driver/mapping/tree.js

@@ -0,0 +1,160 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *     http://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.
+ */
+
+import EventEmitter from "events"
+
+/**
+ * Represents a tree node where the key is composed by 1 or more strings.
+ * @ignore
+ */
+class Node extends EventEmitter {
+	/**
+	 * Creates a new instance of {@link Node}.
+	 * @param {Array<String>} key
+	 * @param {Object} value
+	 * @param {Array} [edges]
+	 */
+	constructor(key, value, edges) {
+		super()
+		this.key = key
+		this.value = value
+		this.edges = edges || []
+	}
+}
+
+/**
+ * A radix tree where each node contains a key, a value and edges.
+ * @ignore
+ */
+class Tree extends Node {
+	constructor() {
+		super([], null)
+		this.length = 0
+	}
+
+	/**
+	 * Gets the existing item in the tree or creates a new one with the value provided by valueHandler
+	 * @param {Iterator} keyIterator
+	 * @param {Function} valueHandler
+	 * @return {Object}
+	 */
+	getOrCreate(keyIterator, valueHandler) {
+		if (typeof keyIterator.next !== "function") {
+			keyIterator = keyIterator[Symbol.iterator]()
+		}
+		let node = this
+		let isMatch = false
+		let item = keyIterator.next()
+		while (true) {
+			let newBranch
+			// Check node keys at position 1 and above
+			for (let i = 1; i < node.key.length; i++) {
+				if (item.done || node.key[i] !== item.value) {
+					// We should branch out
+					newBranch = this._createBranch(
+						node,
+						i,
+						item.done,
+						valueHandler,
+					)
+					break
+				}
+				item = keyIterator.next()
+			}
+
+			if (item.done) {
+				isMatch = true
+				break
+			}
+
+			if (newBranch !== undefined) {
+				break
+			}
+
+			const edges = node.edges
+			let nextNode
+			for (let i = 0; i < edges.length; i++) {
+				const e = edges[i]
+				if (e.key[0] === item.value) {
+					// its a match
+					nextNode = e
+					item = keyIterator.next()
+					break
+				}
+			}
+
+			if (nextNode === undefined) {
+				// Current node is the root for a new leaf
+				break
+			} else {
+				node = nextNode
+			}
+		}
+
+		if (!isMatch) {
+			// Create using "node" as the root
+			const value = valueHandler()
+			node.edges.push(
+				new Node(iteratorToArray(item.value, keyIterator), value),
+			)
+			this._onItemAdded()
+			return value
+		}
+		if (node.value === null && node.edges.length > 0) {
+			node.value = valueHandler()
+		}
+		return node.value
+	}
+
+	_createBranch(node, index, useNewValue, valueHandler) {
+		const newBranch = new Node(
+			node.key.slice(index),
+			node.value,
+			node.edges,
+		)
+		node.key = node.key.slice(0, index)
+		node.edges = [newBranch]
+		if (useNewValue) {
+			// The previous node value has moved to a leaf
+			// The node containing the new leaf should use the new value
+			node.value = valueHandler()
+			this._onItemAdded()
+		} else {
+			// Clear the value as it was copied in the branch
+			node.value = null
+		}
+		return newBranch
+	}
+
+	_onItemAdded() {
+		this.length++
+		this.emit("add", this.length)
+	}
+}
+
+function iteratorToArray(value, iterator) {
+	const values = [value]
+	let item = iterator.next()
+	while (!item.done) {
+		values.push(item.value)
+		item = iterator.next()
+	}
+	return values
+}
+
+export default Tree

package/driver/metadata/aggregate.js

@@ -0,0 +1,79 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *     http://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.
+ */
+
+/**
+ * Creates a new Aggregate.
+ * @classdesc Describes a CQL aggregate.
+ * @alias module:metadata~Aggregate
+ * @constructor
+ */
+function Aggregate() {
+	/**
+	 * Name of the aggregate.
+	 * @type {String}
+	 */
+	this.name = null
+	/**
+	 * Name of the keyspace where the aggregate is declared.
+	 */
+	this.keyspaceName = null
+	/**
+	 * Signature of the aggregate.
+	 * @type {Array.<String>}
+	 */
+	this.signature = null
+	/**
+	 * List of the CQL aggregate argument types.
+	 * @type {Array.<{code, info}>}
+	 */
+	this.argumentTypes = null
+	/**
+	 * State Function.
+	 * @type {String}
+	 */
+	this.stateFunction = null
+	/**
+	 * State Type.
+	 * @type {{code, info}}
+	 */
+	this.stateType = null
+	/**
+	 * Final Function.
+	 * @type {String}
+	 */
+	this.finalFunction = null
+	this.initConditionRaw = null
+	/**
+	 * Initial state value of this aggregate.
+	 * @type {String}
+	 */
+	this.initCondition = null
+	/**
+	 * Type of the return value.
+	 * @type {{code: number, info: (Object|Array|null)}}
+	 */
+	this.returnType = null
+	/**
+	 * Indicates whether or not this aggregate is deterministic.  This means that
+	 * given a particular input, the aggregate will always produce the same output.
+	 * @type {Boolean}
+	 */
+	this.deterministic = null
+}
+
+export default Aggregate