Function createTable

packages/sql/src/schema/SchemaHelper.ts:965–1015

Returns SQL statements to create a table with all its columns, primary key, indexes, and checks.

(table: DatabaseTable, alter?: boolean)

  /** Returns SQL statements to create a table with all its columns, primary key, indexes, and checks. */
  createTable(table: DatabaseTable, alter?: boolean): string[] {
    let sql = `create table ${table.getQuotedName()} (`;

    const columns = table.getColumns();
    const lastColumn = columns[columns.length - 1].name;

    for (const column of columns) {
      const col = this.createTableColumn(column, table);

      if (col) {
        const comma = column.name === lastColumn ? '' : ', ';
        sql += col + comma;
      }
    }

    const primaryKey = table.getPrimaryKey();
    const createPrimary =
      !table.getColumns().some(c => c.autoincrement && c.primary) || this.hasNonDefaultPrimaryKeyName(table);

    if (createPrimary && primaryKey) {
      const name = this.hasNonDefaultPrimaryKeyName(table) ? `constraint ${this.quote(primaryKey.keyName)} ` : '';
      sql += `, ${name}primary key (${primaryKey.columnNames.map(c => this.quote(c)).join(', ')})`;
    }

    sql += ')';
    sql += this.finalizeTable(
      table,
      this.platform.getConfig().get('charset'),
      this.platform.getConfig().get('collate'),
    );

    const ret: string[] = [];
    this.append(ret, sql);
    this.append(ret, this.appendComments(table));

    for (const index of table.getIndexes()) {
      this.append(ret, this.createIndex(index, table));
    }

    if (!alter) {
      for (const check of table.getChecks()) {
        this.append(ret, this.createCheck(table, check));
      }

      for (const trigger of table.getTriggers()) {
        this.append(ret, this.createTrigger(table, trigger));
      }
    }

    return ret;
  }

  alterTableComment(table: DatabaseTable, comment?: string): string {
    return `alter table ${table.getQuotedName()} comment = ${this.platform.quoteValue(comment ?? '')}`;