awSQL/lib/Select.js

class Select {
    #instance;
    #database;
    #from;
    #columns = [];

    #distinct = false;

    #where;
    #whereValues;
    #order = {
        asc: [],
        desc: []
    };
    #group;

    #aggregator;
    #join;
    #having;
    #havingValues;
    #limit;
    #aggregatorParse;
    constructor(instance, defaultDatabase, from, columns){
        this.#database = defaultDatabase;
        this.#from = from;
        this.#columns = columns||[];
        this.#instance = instance;
    }

    /**
     * Selects a database for this query
     * @param {String} database - Name of the database
     * @returns {this}
     */
    selectDatabase = (database) => {
        this.#database = database;
        return this;
    }

    /**
     * Adds the 'distinct' keyword for this query
     * Should be called on only selected columns.
     * - With 'distinct' only unique values are returned
     * @returns {this}
     */
    distinct = () => {
        this.#distinct = true;
        return this;
    }

    /**
     * Adds a where-clause to the query
     * - Values should be set as ? in the string and given in left-to-right order via the 'values'-array to minimize the risk of sql-injection
     * - If you are using joins, specify the table and column together: table.column
     * @param {String} string - The where-clause as a string with ? representing each values.
     * @param {Array} values - Array containing values replacing the ? in the string (from left to right) 
     * @returns {this}
     */
    where = (string, values=[]) => {
        this.#where = string;
        this.#whereValues = values;
        return this;
    }

    /**
     * Same as a where-clause, but allows for aggregation
     * - Values should be set as ? in the string and given in left-to-right order via the 'values'-array to minimize the risk of sql-injection
     * - If you are using joins, specify the table and column together: table.column
     * @param {String} string - The having-clause with possible aggregation and ? representing each values 
     * @param {Array} values - Array containing values replacing the ? in the string (from left to right) 
     * @returns {this}
     */
    having = (string, values = []) => {
        this.#having = string;
        this.#havingValues = values;
        return this;
    }

    /**
     * Adds a new sort order
     * - Can be used multiple times to order by multiple columns
     * @param {String} column - Column to order by 
     * @param {Boolean} desc - Sorty descending
     * @param {"MIN"|"MAX"|"COUNT"|"SUM"|"AVG"} aggregation - The aggregation type to use 
     * @returns 
     */
    order = (column, desc=false, aggregation) => {
        if (["MIN", "MAX", "COUNT", "SUM", "AVG"].includes(aggregation)){
            switch(aggregation){
                case "MIN":
                    column = `MIN(${column})`;
                    break;
                case "MAX":
                    column = `MAX(${column})`;
                    break;
                case "COUNT":
                    column = `COUNT(${column})`;
                    break;
                case "SUM":
                    column = `SUM(${column})`;
                    break;
                case "AVG":
                    column = `AVG(${column})`;
                    break;
            }
        }
        if (!desc){
            this.#order.asc.push(column);
        }else{
            this.#order.desc.push(column);
        }
        return this;
    }

    /**
     * Counts number of entries of the first selected column
     * @param {Boolean} doParse - Return only an integer, not the full query result
     */
    count = (doParse=false) => {
        this.#aggregator = "COUNT";
        this.#aggregatorParse = doParse;
        return this;
    }

    /**
     * Sums numerical rows of the first selected column
     * @param {Boolean} doParse - Return only an integer, not the full query result
     * @returns 
     */
    sum = (doParse=false) => {
        this.#aggregator ="SUM";
        this.#aggregatorParse = doParse;
        return this;
    }

    /**
     * Averages numerical rows of the first selected column
     * @param {Boolean} doParse - Return only an integer, not the full query result
     * @returns 
     */
    avg = (doParse=false) => {
        this.#aggregator = "AVG";
        this.#aggregatorParse = doParse;
        return this;
    }

    /**
     * Groups rows that have the same values into summary rows
     * @param  {...String} columns - The columns to group by
     */
    group = (...columns) => {
        this.#group = columns;
        return this;
    }

    /**
     * 
     * @param {"LEFT"|"INNER"|"RIGHT"|"FULL OUTER"} type 
     * @param {*} table 
     * @param {*} onOriginalColumn 
     * @param {*} onJoinedColumn 
     * @param  {...any} columns 
     */
    join = (type, table, onOriginalColumn, onJoinedColumn, ...columns) => {
        this.#join = {
            type,
            on: `%%FROM%%.${onOriginalColumn}=${table}.${onJoinedColumn}`,
            columns,
            table
        }
        return this;
    }

    /**
     * Limits the query and specifies an offset
     * @param {Number} number - Limits the query by specified rows 
     * @param {*} offset - Offset to start at
     * @returns 
     */
    limit = (number, offset) => {
        this.#limit = {
            number,
            offset
        }
        return this;
    }

    /**
     * Paginates the query
     * @param {Number} page - The page to get (Minimum 1)
     * @param {Number} itemsPerPage - How many items a page should have 
     * @returns 
     */
    pagination = (page, itemsPerPage) => {
        if (page<1) page=1;
        this.#limit = {
            number: itemsPerPage,
            offset: itemsPerPage*(page-1)
        }
        return this;
    }

    /**
     * Executes the prepared query
     * @returns 
     */
    execute = async () => {
        if (!this.#instance.isConnected()) throw new Error(`Can't execute query: Instance has no connection`);
        if (!this.#database) throw new Error(`Can't execute query: Database not selected`);

        const values = [];
        let columnString;
        if (this.#join && this.#columns.length>0){
            columnString = `${this.#columns.toString()},${this.#join.columns.toString()}`
        }else{
            columnString = this.#columns.length>0?this.#columns.toString():"*"
        }
        const distinctString = this.#distinct?"DISTINCT ":"";
        

        const whereString = this.#where?` WHERE ${this.#where}`:"";
        this.#where&&values.push(...this.#whereValues);
        const havingString = this.#having?` HAVING ${this.#having}`:"";
        this.#having&&values.push(...this.#havingValues);

        const orderString = (this.#order.asc.length>0||this.#order.desc.length>0)?` ORDER BY ${this.#order.asc.length>0?this.#order.asc.toString()+" ASC,":""}${this.#order.desc.length>0?this.#order.desc.toString()+" DESC":""}`:"";

        const groupString = this.#group?` GROUP BY ${this.#group.toString()}`:"";

        const joinString = this.#join?` ${this.#join.type} JOIN ${this.#database}.${this.#join.table} ON ${this.#join.on.replace("%%FROM%%", this.#from)}`:"";

        const limitString = this.#limit?` LIMIT ${this.#limit.number}${this.#limit.offset?` OFFSET ${this.#limit.offset}`:""}`:"";

        const queryString = `SELECT ${this.#aggregator?this.#aggregator+"(":""}${distinctString}${columnString}${this.#aggregator?")":""} FROM ${this.#database}.${this.#from}${joinString}${whereString}${havingString}${limitString}${groupString}${orderString};`;
        
        if (this.#aggregatorParse){
            const result = await this.#instance.queryRaw(queryString, values);
            return result[0][Object.keys(result[0])];
        }
        return await this.#instance.queryRaw(queryString, values);
    }
}

module.exports = Select;