velocious 1.0.430 → 1.0.432

package/src/database/drivers/base-column.js

@@ -0,0 +1,182 @@
+// @ts-check
+
+import TableColumn from "../table-data/table-column.js"
+import TableData from "../table-data/index.js"
+
+export default class VelociousDatabaseDriversBaseColumn {
+  /**
+   * Table.
+    @type {import("./base-table.js").default | undefined} */
+  table = undefined
+
+  /**
+   * Runs get auto increment.
+   * @abstract
+   * @returns {boolean} - Whether auto increment.
+   */
+  getAutoIncrement() {
+    throw new Error("getAutoIncrement not implemented")
+  }
+
+  /**
+   * Runs get default.
+   * @abstract
+   * @returns {?} - The default.
+   */
+  getDefault() {
+    throw new Error("getDefault not implemented")
+  }
+
+  /**
+   * Runs get index by name.
+   * @param {string} indexName - Index name.
+   * @returns {Promise<import("./base-columns-index.js").default | undefined>} - Resolves with the index by name.
+   */
+  async getIndexByName(indexName) {
+    const indexes = await this.getIndexes()
+    const index = indexes.find((index) => index.getName() == indexName)
+
+    return index
+  }
+
+  /**
+   * Runs change nullable.
+   * @param {boolean} nullable Whether the column should be nullable or not.
+   * @returns {Promise<void>} - Resolves when complete.
+   */
+  async changeNullable(nullable) {
+    const tableData = new TableData(this.getTable().getName())
+    const column = this.getTableDataColumn()
+
+    column.setNull(nullable)
+
+    tableData.addColumn(column)
+
+    const sqls = await this.getDriver().alterTableSQLs(tableData)
+
+    for (const sql of sqls) {
+      await this.getDriver().query(sql)
+    }
+  }
+
+  /**
+   * Runs get driver.
+   * @returns {import("./base.js").default} - The driver.
+   */
+  getDriver() {
+    return this.getTable().getDriver()
+  }
+
+  /**
+   * Runs get indexes.
+   * @abstract
+   * @returns {Promise<Array<import("./base-columns-index.js").default>>} - Resolves with the indexes.
+   */
+  getIndexes() {
+    throw new Error("getIndexes not implemented")
+  }
+
+  /**
+   * Runs get max length.
+   * @abstract
+   * @returns {number | undefined} - The max length.
+   */
+  getMaxLength() {
+    throw new Error("getMaxLength not implemented")
+  }
+
+  /**
+   * Runs get notes.
+   * @returns {string | undefined} - The notes.
+   */
+  getNotes() {
+    return undefined
+  }
+
+  /**
+   * Runs get name.
+   * @abstract
+   * @returns {string} - The name.
+   */
+  getName() {
+    throw new Error("getName not implemented")
+  }
+
+  /**
+   * Runs get null.
+   * @abstract
+   * @returns {boolean} - Whether null.
+   */
+  getNull() {
+    throw new Error("getNull not implemented")
+  }
+
+  /**
+   * Runs get options.
+   * @returns {import("../query-parser/options.js").default} - The options options.
+   */
+  getOptions() {
+    return this.getDriver().options()
+  }
+
+  /**
+   * Runs get primary key.
+   * @abstract
+   * @returns {boolean} - Whether primary key.
+   */
+  getPrimaryKey() {
+    throw new Error("getPrimaryKey not implemented")
+  }
+
+  /**
+   * Runs get table.
+   * @returns {import("./base-table.js").default} - The table.
+   */
+  getTable() {
+    if (!this.table) throw new Error("No table set on column")
+
+    return this.table
+  }
+
+  /**
+   * Runs get table data column.
+   * @returns {TableColumn} The table column data for this column. This is used for altering tables and such.
+   */
+  getTableDataColumn() {
+    return new TableColumn(this.getName(), {
+      autoIncrement: this.getAutoIncrement(),
+      default: this.getDefault(),
+      isNewColumn: false,
+      maxLength: this.getMaxLength(),
+      notes: this.getNotes(),
+      null: this.getNull(),
+      primaryKey: this.getPrimaryKey(),
+      type: this.getType()
+    })
+  }
+
+  /**
+   * Runs get type hint from notes.
+   * @returns {string | undefined} - The type hint from notes.
+   */
+  getTypeHintFromNotes() {
+    const notes = this.getNotes()
+
+    if (!notes || typeof notes != "string") return
+
+    const match = notes.match(/velocious:type=([a-z0-9_-]+)/i)
+
+    if (!match) return
+
+    return match[1].toLowerCase()
+  }
+
+  /**
+   * Runs get type.
+   * @abstract
+   * @returns {string} - The type.
+   */
+  getType() {
+    throw new Error("getType not implemented")
+  }
+}

package/src/database/drivers/base-columns-index.js

@@ -0,0 +1,81 @@
+// @ts-check
+
+import {digg} from "diggerize"
+
+export default class VelociousDatabaseDriversBaseColumnsIndex {
+  /**
+   * Runs constructor.
+   * @param {import("./base-table.js").default} table - Table.
+   * @param {object} data - Data payload.
+   */
+  constructor(table, data) {
+    this.data = data
+    this.table = table
+  }
+
+  /**
+   * Runs get column names.
+   * @abstract
+   * @returns {string[]} - The column names.
+   */
+  getColumnNames() { throw new Error("'getColumnNames' not implemented") }
+
+  /**
+   * Runs get driver.
+   * @returns {import("./base.js").default} - The driver.
+   */
+  getDriver() {
+    return this.getTable().getDriver()
+  }
+
+  /**
+   * Runs get name.
+   * @returns {string} - The name.
+   */
+  getName()  {
+    return digg(this, "data", "index_name")
+  }
+
+  /**
+   * Runs get options.
+   * @returns {import("../query-parser/options.js").default} - The options options.
+   */
+  getOptions() {
+    return this.getDriver().options()
+  }
+
+  /**
+   * Runs get table.
+   * @returns {import("./base-table.js").default} - The table.
+   */
+  getTable() {
+    if (!this.table) throw new Error("No table set on column")
+
+    return this.table
+  }
+
+  /**
+   * Runs get table data index.
+   * @abstract
+   * @returns {import("../table-data/table-index.js").default} - The table data index.
+   */
+  getTableDataIndex() {
+    throw new Error("'getTableDataIndex' not implemented")
+  }
+
+  /**
+   * Runs is primary key.
+   * @returns {boolean} - Whether primary key.
+   */
+  isPrimaryKey() {
+    return digg(this, "data", "is_primary_key")
+  }
+
+  /**
+   * Runs is unique.
+   * @returns {boolean} - Whether unique.
+   */
+  isUnique() {
+    return digg(this, "data", "is_unique")
+  }
+}

package/src/database/drivers/base-foreign-key.js

@@ -0,0 +1,104 @@
+// @ts-check
+
+import TableForeignKey from "../table-data/table-foreign-key.js"
+
+export default class VelociousDatabaseDriversBaseForeignKey {
+  /**
+   * Table.
+    @type {import("./base-table.js").default | undefined} */
+  table = undefined
+
+  /**
+   * Runs constructor.
+   * @param {Record<string, ?>} data - Data payload.
+   */
+  constructor(data) {
+    this.data = data
+  }
+
+  /**
+   * Runs get column name.
+   * @abstract
+   * @returns {string} - The column name.
+   */
+  getColumnName() {
+    throw new Error(`'getColumnName' not implemented`)
+  }
+
+  /**
+   * Runs get driver.
+   * @returns {import("./base.js").default} - The driver.
+   */
+  getDriver() {
+    return this.getTable().getDriver()
+  }
+
+  /**
+   * Runs get name.
+   * @abstract
+   * @returns {string} - The name.
+   */
+  getName() {
+    throw new Error(`'getName' not implemented`)
+  }
+
+  /**
+   * Runs get options.
+   * @returns {import("../query-parser/options.js").default} - The options options.
+   */
+  getOptions() {
+    return this.getDriver().options()
+  }
+
+  /**
+   * Runs get referenced column name.
+   * @abstract
+   * @returns {string} - The referenced column name.
+   */
+  getReferencedColumnName() {
+    throw new Error(`'getReferencedColumnName' not implemented`)
+  }
+
+  /**
+   * Runs get referenced table name.
+   * @abstract
+   * @returns {string} - The referenced table name.
+   */
+  getReferencedTableName() {
+    throw new Error(`'getReferencedTableName' not implemented`)
+  }
+
+  /**
+   * Runs get table.
+   * @returns {import("./base-table.js").default} - The table.
+   */
+  getTable() {
+    if (!this.table) throw new Error("No table set on column")
+
+    return this.table
+  }
+
+  /**
+   * Runs get table name.
+   * @abstract
+   * @returns {string} - The table name.
+   */
+  getTableName() {
+    throw new Error("'getTableName' not implemented")
+  }
+
+  /**
+   * Runs get table data foreign key.
+   * @returns {TableForeignKey} - The table data foreign key.
+   */
+  getTableDataForeignKey() {
+    return new TableForeignKey({
+      columnName: this.getColumnName(),
+      name: this.getName(),
+      tableName: this.getTableName(),
+      referencedColumnName: this.getReferencedColumnName(),
+      referencedTableName: this.getReferencedTableName()
+    })
+  }
+}
+

package/src/database/drivers/base-table.js

@@ -0,0 +1,156 @@
+// @ts-check
+
+import {digg} from "diggerize"
+import TableData from "../table-data/index.js"
+
+export default class VelociousDatabaseDriversBaseTable {
+  /**
+   * Driver.
+    @type {import("./base.js").default | undefined} */
+  driver = undefined
+
+  /**
+   * Runs get column by name.
+   * @param {string} columnName - Column name.
+   * @returns {Promise<import("./base-column.js").default | undefined>} - Resolves with the column by name.
+   */
+  async getColumnByName(columnName) {
+    const columnes = await this.getColumns()
+    const column = columnes.find((column) => column.getName() == columnName)
+
+    return column
+  }
+
+  /**
+   * Runs get column by name or fail.
+   * @param {string} columnName - Column name.
+   * @returns {Promise<import("./base-column.js").default>} - Resolves with the column by name or fail.
+   */
+  async getColumnByNameOrFail(columnName) {
+    const column = await this.getColumnByName(columnName)
+
+    if (!column) throw new Error(`Couldn't find a column by that name "${columnName}"`)
+
+    return column
+  }
+
+  /**
+   * Runs get columns.
+   * @abstract
+   * @returns {Promise<Array<import("./base-column.js").default>>} - Resolves with the columns.
+   */
+  getColumns() {
+    throw new Error("getColumns not implemented")
+  }
+
+  /**
+   * Runs get driver.
+   * @returns {import("./base.js").default} - The driver.
+   */
+  getDriver() {
+    if (!this.driver) throw new Error("No driver set on table")
+
+    return this.driver
+  }
+
+  /**
+   * Runs get foreign keys.
+   * @abstract
+   * @returns {Promise<import("./base-foreign-key.js").default[]>} - Resolves with the foreign keys.
+   */
+  getForeignKeys() {
+    throw new Error("'getForeignKeys' not implemented")
+  }
+
+  /**
+   * Runs get indexes.
+   * @abstract
+   * @returns {Promise<import("./base-columns-index.js").default[]>} - Resolves with the indexes.
+   */
+  getIndexes() {
+    throw new Error("'getForeignKeys' not implemented")
+  }
+
+  /**
+   * Runs get name.
+   * @abstract
+   * @returns {string} - The name.
+   */
+  getName() {
+    throw new Error("getName not implemented")
+  }
+
+  /**
+   * Runs get options.
+   * @returns {import("../query-parser/options.js").default} - The options options.
+   */
+  getOptions() {
+    return this.getDriver().options()
+  }
+
+  /**
+   * Runs get table data.
+   * @returns {Promise<TableData>} - Resolves with the table data.
+   */
+  async getTableData() {
+    const tableData = new TableData(this.getName())
+    const tableDataColumns = []
+
+    for (const column of await this.getColumns()) {
+      const tableDataColumn = column.getTableDataColumn()
+
+      tableData.addColumn(tableDataColumn)
+      tableDataColumns.push(tableDataColumn)
+    }
+
+    for (const foreignKey of await this.getForeignKeys()) {
+      tableData.addForeignKey(foreignKey.getTableDataForeignKey())
+
+      const tableDataColumn = tableDataColumns.find((tableDataColumn) => tableDataColumn.getName() == foreignKey.getColumnName())
+
+      if (!tableDataColumn) throw new Error(`Couldn't find table data column for foreign key: ${foreignKey.getColumnName()}`)
+
+      tableDataColumn.setForeignKey(foreignKey)
+    }
+
+    for (const index of await this.getIndexes()) {
+      tableData.addIndex(index.getTableDataIndex())
+    }
+
+    return tableData
+  }
+
+  /**
+   * Runs rows count.
+   * @returns {Promise<number>} - Resolves with the rows count.
+   */
+  async rowsCount() {
+    const result = await this.getDriver().query(`SELECT COUNT(*) AS count FROM ${this.getOptions().quoteTableName(this.getName())}`)
+
+    return digg(result, 0, "count")
+  }
+
+  /**
+   * Runs truncate.
+   * @param {{cascade: boolean}} [args] - Truncate options.
+   * @returns {Promise<Array<Record<string, ?>>>} - Resolves with the truncate.
+   */
+  async truncate(args) {
+    this.getDriver()._assertNotReadOnly()
+    const databaseType = this.getDriver().getType()
+    let sql
+
+    if (databaseType == "sqlite") {
+      sql = `DELETE FROM ${this.getOptions().quoteTableName(this.getName())}`
+    } else {
+      sql = `TRUNCATE TABLE ${this.getOptions().quoteTableName(this.getName())}`
+
+      if (args?.cascade && databaseType == "pgsql") {
+        sql += " CASCADE"
+      }
+    }
+
+    return await this.getDriver().query(sql)
+  }
+}
+