couchset 0.0.0 → 0.0.5

package/dist/query/query.cluster.d.ts

@@ -0,0 +1,14 @@
+import { QueryResult } from 'couchbase';
+/**
+ * Query couchbase db
+ * @param query
+ *
+    const query = `
+      SELECT airportname, city FROM \`travel-sample\`
+      WHERE type=$1
+        AND city=$2
+    `;
+    const options = {parameters: ['airport', 'San Jose']};
+ * @param options
+ */
+export declare function QueryCluster(query: string, options?: any): Promise<QueryResult>;

package/dist/query/query.cluster.js

@@ -0,0 +1,80 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryCluster = void 0;
+var connection_1 = __importDefault(require("../connection"));
+/**
+ * Query couchbase db
+ * @param query
+ *
+    const query = `
+      SELECT airportname, city FROM \`travel-sample\`
+      WHERE type=$1
+        AND city=$2
+    `;
+    const options = {parameters: ['airport', 'San Jose']};
+ * @param options
+ */
+function QueryCluster(query, options) {
+    return __awaiter(this, void 0, void 0, function () {
+        var cluster, result, error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    cluster = connection_1.default.Instance.cluster;
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, cluster.query(query, options)];
+                case 2:
+                    result = _a.sent();
+                    return [2 /*return*/, result];
+                case 3:
+                    error_1 = _a.sent();
+                    console.error('Query failed: ', error_1);
+                    throw error_1;
+                case 4: return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.QueryCluster = QueryCluster;
+//# sourceMappingURL=query.cluster.js.map

package/dist/query/query.cluster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.cluster.js","sourceRoot":"","sources":["../../src/query/query.cluster.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,6DAAgD;AAEhD;;;;;;;;;;;GAWG;AACH,SAAsB,YAAY,CAAC,KAAa,EAAE,OAAa;;;;;;oBACrD,OAAO,GAAG,oBAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC;;;;oBAElC,qBAAM,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,EAAA;;oBAA5C,MAAM,GAAG,SAAmC;oBAClD,sBAAO,MAAM,EAAC;;;oBAEd,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,OAAK,CAAC,CAAC;oBACvC,MAAM,OAAK,CAAC;;;;;CAEnB;AATD,oCASC","sourcesContent":["import {QueryResult} from 'couchbase';\n\nimport CouchbaseConnection from '../connection';\n\n/**\n * Query couchbase db\n * @param query\n *  \n    const query = `\n      SELECT airportname, city FROM \\`travel-sample\\`\n      WHERE type=$1\n        AND city=$2\n    `;\n    const options = {parameters: ['airport', 'San Jose']};\n * @param options\n */\nexport async function QueryCluster(query: string, options?: any): Promise<QueryResult> {\n    const cluster = CouchbaseConnection.Instance.cluster;\n    try {\n        const result = await cluster.query(query, options);\n        return result;\n    } catch (error) {\n        console.error('Query failed: ', error);\n        throw error;\n    }\n}\n"]}

package/dist/query/query.d.ts

@@ -0,0 +1,321 @@
+import { BaseQuery } from './base-query';
+import { IConditionExpr, IGroupBy, IIndexOnParams, IIndexWithParams, ILetExpr, IndexType, ISelectType, LogicalWhereExpr, SortType } from './interface/query.types';
+export declare class QueryBuilder extends BaseQuery {
+    /**
+     * SELECT Expression.
+     */
+    private selectExpr?;
+    /**
+     * WHERE Expression.
+     */
+    private whereExpr?;
+    /**
+     * ORDER BY Expression.
+     */
+    private orderExpr?;
+    /**
+     * LIMIT Expression.
+     */
+    private limitExpr?;
+    /**
+     * OFFSET Expression.
+     */
+    private offSetExpr?;
+    /**
+     * LET Expression.
+     */
+    private letExpr?;
+    /**
+     * GROUP BY Expression.
+     */
+    private groupByExpr?;
+    /**
+     * LETTING Expression.
+     */
+    private lettingExpr?;
+    /**
+     * HAVING Expression.
+     */
+    private havingExpr?;
+    /**
+     * Plain JOIN Expression.
+     */
+    private plainJoinExpr?;
+    /**
+     * USE Expression.
+     */
+    private useKeysExpr?;
+    /**
+     * Available query types.
+     */
+    private queryType?;
+    /**
+     * INDEX ON Expression.
+     */
+    private indexOn?;
+    /**
+     * Types of supported index statements.
+     */
+    private indexType?;
+    /**
+     * Index name.
+     */
+    private indexName?;
+    /**
+     * INDEX USING GSI Expression.
+     */
+    private indexUsingGSI?;
+    /**
+     * INDEX USING GSI Expression.
+     */
+    private indexWith?;
+    /**
+     * @summary Create an instance of QueryBuilder.
+     * @name QueryBuilder
+     * @class
+     * @public
+     *
+     * @param conditions List of SELECT clause conditions
+     * @param collection Collection name
+     * @returns QueryBuilder
+     *
+     * @example
+     * ```ts
+     *  const query = new QueryBuilder({$select: [{$field: 'address'}], $where: {$nill: [{ address: { $like: '%57-59%' } }, { free_breakfast: true }, { free_lunch: [1] }]}}, 'travel-sample');
+     * ```
+     */
+    constructor(conditions: IConditionExpr, collection: string);
+    /**
+     * Add result selectors to SELECT clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const query = new QueryBuilder({}, 'travel-sample');
+     *   const result = query.select([{$field: 'address'}]).build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `travel-sample`
+     */
+    select(value?: ISelectType[] | string | undefined): QueryBuilder;
+    /**
+     * Add index type and name to INDEX clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const result = new QueryBuilder({}, 'travel-sample').index('DROP', 'travel_sample_id_test').build();
+     *   console.log(result)
+     * ```
+     * > DROP INDEX `travel-sample`.`travel_sample_id_test`
+     */
+    index(type: IndexType, name: string): QueryBuilder;
+    /**
+     * Add items to ON clause in INDEX clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const on = [{ name: 'travel-sample.callsing', sort: 'ASC' }];
+     *   const result = new QueryBuilder({}, 'travel-sample').index('CREATE', 'travel_sample_id_test').on(on).build();
+     *   console.log(result)
+     * ```
+     * > CREATE INDEX `travel_sample_id_test` ON `travel-sample`(`travel-sample.callsing`['ASC'])
+     */
+    on(value: IIndexOnParams[]): QueryBuilder;
+    /**
+     * Create INDEX using General Secondary Index(GSI).
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const result = new QueryBuilder({}, 'travel-sample').index('CREATE', 'travel_sample_id_test').usingGSI().build();
+     *   console.log(result)
+     * ```
+     * > CREATE INDEX `travel_sample_id_test` USING GSI)
+     */
+    usingGSI(): QueryBuilder;
+    /**
+     * Add items to WITH clause in INDEX clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const withExpr = {nodes: ['192.168.1.1:8078'],defer_build: true,num_replica: 2};
+     *   const result = new QueryBuilder({}, 'travel-sample').index('CREATE', 'travel_sample_id_test').with(withExpr).build();
+     *   console.log(result)
+     * ```
+     * > CREATE INDEX `travel_sample_id_test` WITH {'nodes': ['192.168.1.1:8078'],'defer_build': true,'num_replica': 2})
+     */
+    with(value: IIndexWithParams): QueryBuilder;
+    /**
+     * Add WHERE expression to SELECT clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const expr_where = {$or: [{ address: { $like: '%57-59%' } }, { free_breakfast: true }]};
+     *   const query = new QueryBuilder({}, 'travel-sample');
+     *   const result = query.select([{$field: 'address'}]).where(expr_where).build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `travel-sample WHERE (address LIKE '%57-59%' OR free_breakfast = true)`
+     */
+    where(value: LogicalWhereExpr): QueryBuilder;
+    /**
+     * Add JOIN expression to SELECT clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```tS
+     *   const query = new QueryBuilder({}, 'beer-sample brewery');
+     *   const result = query.select([{$field: 'address'}]).plainJoin('JOIN `beer-sample` beer ON beer.brewery_id = LOWER(REPLACE(brewery.name, " ", "_"))').build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `beer-sample brewery` JOIN `beer-sample` beer ON beer.brewery_id = LOWER(REPLACE(brewery.name, " ", "_")) LIMIT 1`
+     */
+    plainJoin(value: string): QueryBuilder;
+    /**
+     * Add ORDER BY expression to SELECT clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const query = new QueryBuilder({}, 'travel-sample');
+     *   const result = query.select([{$field: 'address'}]).orderBy({ size: 'DESC' }).build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `travel-sample ORDER BY size = 'DESC'`
+     */
+    orderBy(value: Record<string, SortType>): QueryBuilder;
+    /**
+     * Add LIMIT expression to SELECT clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const query = new QueryBuilder({}, 'travel-sample');
+     *   const result = query.select([{$field: 'address'}]).limit(10).build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `travel-sample LIMIT 10`
+     */
+    limit(value: number): QueryBuilder;
+    /**
+     * Add OFFSET expression to SELECT clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const query = new QueryBuilder({}, 'travel-sample');
+     *   const result = query.select([{$field: 'address'}]).offset(10).build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `travel-sample OFFSET 10`
+     */
+    offset(value: number): QueryBuilder;
+    /**
+     * Add LET expression to SELECT clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const letExpr = [{ key: 'amount_val', value: 10 }];
+     *   const query = new QueryBuilder({}, 'travel-sample');
+     *   const result = query.select([{$field: 'address'}]).let(letExpr).build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `travel-sample LET amount_val = 10`
+     */
+    let(value: ILetExpr[]): QueryBuilder;
+    /**
+     * Add GROUP BY expression to GROUP BY clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const groupByExpr = [{ expr: 'COUNT(amount_val)', as: 'amount' }];
+     *   const query = new QueryBuilder({}, 'travel-sample');
+     *   const result = query.select([{$field: 'address'}]).groupBy(groupByExpr).build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `travel-sample GROUP BY COUNT(amount) AS amount`
+     */
+    groupBy(value: IGroupBy[]): QueryBuilder;
+    /**
+     * Add LETTING expression to GROUP BY clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const groupByExpr = [{ expr: 'COUNT(amount_val)', as: 'amount' }];
+     *   const letExpr = [{ key: 'amount_val', value: 10 }];
+     *   const query = new QueryBuilder({}, 'travel-sample');
+     *   const result = query.select([{$field: 'address'}]).groupBy(groupByExpr).let(letExpr).build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `travel-sample GROUP BY COUNT(amount) AS amount LETTING amount = 10`
+     */
+    letting(value: ILetExpr[]): QueryBuilder;
+    /**
+     * Add HAVING expression to GROUP BY clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const groupByExpr = [{ expr: 'COUNT(amount_val)', as: 'amount' }];
+     *   const having = {address: {$like: '%58%'}};
+     *   const query = new QueryBuilder({}, 'travel-sample');
+     *   const result = query.select([{$field: 'address'}]).groupBy(groupByExpr).having(having).build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `travel-sample GROUP BY COUNT(amount) AS amount HAVING address LIKE '%58%'`
+     */
+    having(value: LogicalWhereExpr): QueryBuilder;
+    /**
+     * Add USE KEYS expression to SELECT clause.
+     * @method
+     * @public
+     *
+     * @example
+     * ```ts
+     *   const query = new QueryBuilder({}, 'travel-sample');
+     *   const result = query.select([{$field: 'address'}]).useKeys(['airlineR_8093']).build()
+     *   console.log(result)
+     * ```
+     * > SELECT address FROM `travel-sample USE KEYS ['airlineR_8093']`
+     */
+    useKeys(value: string[]): QueryBuilder;
+    /**
+     * Converts the conditional parameters passed to the constructor to the properties of the N1QL QueryBuilder.
+     * @method
+     * @public
+     *
+     */
+    compileFromConditions(conditionals: IConditionExpr): void;
+    /**
+     * Build a n1ql query from the defined parameters.
+     * @method
+     * @public
+     *
+     */
+    build(): string;
+    get conditions(): IConditionExpr;
+    set conditions(value: IConditionExpr);
+    get collection(): string;
+    set collection(value: string);
+}