@ragestudio/scylla-odm 0.22.2 → 0.22.3

package/driver/metadata/materialized-view.js

@@ -0,0 +1,49 @@
+/*
+ * 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 DataCollection from "./data-collection.js"
+/**
+ * Creates a new MaterializedView.
+ * @param {String} name Name of the View.
+ * @classdesc Describes a CQL materialized view.
+ * @alias module:metadata~MaterializedView
+ * @augments {module:metadata~DataCollection}
+ * @constructor
+ */
+function MaterializedView(name) {
+	DataCollection.call(this, name)
+	/**
+	 * Name of the table.
+	 * @type {String}
+	 */
+	this.tableName = null
+	/**
+	 * View where clause.
+	 * @type {String}
+	 */
+	this.whereClause = null
+	/**
+	 * Determines if all the table columns where are included in the view.
+	 * @type {boolean}
+	 */
+	this.includeAllColumns = false
+}
+
+util.inherits(MaterializedView, DataCollection)
+
+export default MaterializedView

package/driver/metadata/schema-function.js

@@ -0,0 +1,98 @@
+/*
+ * 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 SchemaFunction.
+ * @classdesc Describes a CQL function.
+ * @alias module:metadata~SchemaFunction
+ * @constructor
+ */
+function SchemaFunction() {
+	/**
+	 * Name of the cql function.
+	 * @type {String}
+	 */
+	this.name = null
+	/**
+	 * Name of the keyspace where the cql function is declared.
+	 */
+	this.keyspaceName = null
+	/**
+	 * Signature of the function.
+	 * @type {Array.<String>}
+	 */
+	this.signature = null
+	/**
+	 * List of the function argument names.
+	 * @type {Array.<String>}
+	 */
+	this.argumentNames = null
+	/**
+	 * List of the function argument types.
+	 * @type {Array.<{code, info}>}
+	 */
+	this.argumentTypes = null
+	/**
+	 * Body of the function.
+	 * @type {String}
+	 */
+	this.body = null
+	/**
+	 * Determines if the function is called when the input is null.
+	 * @type {Boolean}
+	 */
+	this.calledOnNullInput = null
+	/**
+	 * Name of the programming language, for example: java, javascript, ...
+	 * @type {String}
+	 */
+	this.language = null
+	/**
+	 * Type of the return value.
+	 * @type {{code: number, info: (Object|Array|null)}}
+	 */
+	this.returnType = null
+	/**
+	 * Indicates whether or not this function is deterministic.  This means that
+	 * given a particular input, the function will always produce the same output.
+	 * @type {Boolean}
+	 */
+	this.deterministic = null
+	/**
+	 * Indicates whether or not this function is monotonic on all of its
+	 * arguments.  This means that it is either entirely non-increasing or
+	 * non-decreasing.  Even if the function is not monotonic on all of its
+	 * arguments, it's possible to specify that it is monotonic on one of
+	 * its arguments, meaning that partial applications of the function over
+	 * that argument will be monotonic.
+	 *
+	 * Monotonicity is required to use the function in a GROUP BY clause.
+	 * @type {Boolean}
+	 */
+	this.monotonic = null
+	/**
+	 * The argument names that the function is monotonic on.
+	 *
+	 * If {@link monotonic} is true, this will return all argument names.
+	 * Otherwise, this will return either one argument or an empty array.
+	 * @type {Array.<String>}
+	 */
+	this.monotonicOn = null
+}
+
+export default SchemaFunction

package/driver/metadata/schema-index.js

@@ -0,0 +1,166 @@
+/*
+ * 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"
+import types from "../types/index.js"
+
+/** @private */
+const kind = {
+	custom: 0,
+	keys: 1,
+	composites: 2,
+}
+/**
+ * Creates a new Index instance.
+ * @classdesc Describes a CQL index.
+ * @param {String} name
+ * @param {String} target
+ * @param {Number|String} kind
+ * @param {Object} options
+ * @alias module:metadata~Index
+ * @constructor
+ */
+function Index(name, target, kind, options) {
+	/**
+	 * Name of the index.
+	 * @type {String}
+	 */
+	this.name = name
+	/**
+	 * Target of the index.
+	 * @type {String}
+	 */
+	this.target = target
+	/**
+	 * A numeric value representing index kind (0: custom, 1: keys, 2: composite);
+	 * @type {Number}
+	 */
+	this.kind = typeof kind === "string" ? getKindByName(kind) : kind
+	/**
+	 * An associative array containing the index options
+	 * @type {Object}
+	 */
+	this.options = options
+}
+
+/**
+ * Determines if the index is of composites kind
+ * @returns {Boolean}
+ */
+Index.prototype.isCompositesKind = function () {
+	return this.kind === kind.composites
+}
+
+/**
+ * Determines if the index is of keys kind
+ * @returns {Boolean}
+ */
+Index.prototype.isKeysKind = function () {
+	return this.kind === kind.keys
+}
+
+/**
+ * Determines if the index is of custom kind
+ * @returns {Boolean}
+ */
+Index.prototype.isCustomKind = function () {
+	return this.kind === kind.custom
+}
+
+/**
+ * Parses Index information from rows in the 'system_schema.indexes' table
+ * @deprecated It will be removed in the next major version.
+ * @param {Array.<Row>} indexRows
+ * @returns {Array.<Index>}
+ */
+Index.fromRows = function (indexRows) {
+	if (!indexRows || indexRows.length === 0) {
+		return utils.emptyArray
+	}
+	return indexRows.map(function (row) {
+		const options = row["options"]
+		return new Index(
+			row["index_name"],
+			options["target"],
+			getKindByName(row["kind"]),
+			options,
+		)
+	})
+}
+
+/**
+ * Parses Index information from rows in the legacy 'system.schema_columns' table.
+ * @deprecated It will be removed in the next major version.
+ * @param {Array.<Row>} columnRows
+ * @param {Object.<String, {name, type}>} columnsByName
+ * @returns {Array.<Index>}
+ */
+Index.fromColumnRows = function (columnRows, columnsByName) {
+	const result = []
+	for (let i = 0; i < columnRows.length; i++) {
+		const row = columnRows[i]
+		const indexName = row["index_name"]
+		if (!indexName) {
+			continue
+		}
+		const c = columnsByName[row["column_name"]]
+		let target
+		const options = JSON.parse(row["index_options"])
+		if (options !== null && options["index_keys"] !== undefined) {
+			target = util.format("keys(%s)", c.name)
+		} else if (
+			options !== null &&
+			options["index_keys_and_values"] !== undefined
+		) {
+			target = util.format("entries(%s)", c.name)
+		} else if (
+			c.type.options.frozen &&
+			(c.type.code === types.dataTypes.map ||
+				c.type.code === types.dataTypes.list ||
+				c.type.code === types.dataTypes.set)
+		) {
+			target = util.format("full(%s)", c.name)
+		} else {
+			target = c.name
+		}
+		result.push(
+			new Index(
+				indexName,
+				target,
+				getKindByName(row["index_type"]),
+				options,
+			),
+		)
+	}
+	return result
+}
+
+/**
+ * Gets the number representing the kind based on the name
+ * @param {String} name
+ * @returns {Number}
+ * @private
+ */
+function getKindByName(name) {
+	if (!name) {
+		return kind.custom
+	}
+	return kind[name.toLowerCase()]
+}
+
+export default Index