@directus/api/dist/database/helpers/schema/types.d.ts

Directus is a real-time API and App dashboard for managing SQL database content

import type { KNEX_TYPES } from '@directus/constants';
import type { Column } from '@directus/schema';
import type { Field, RawField, Relation, Type } from '@directus/types';
import type { Knex } from 'knex';
import type { DatabaseClient } from '../../../types/index.js';
import { DatabaseHelper } from '../types.js';
export type Options = {
    nullable?: boolean;
    default?: any;
    length?: number;
};
export type Sql = {
    sql: string;
    bindings: readonly Knex.Value[];
};
export type SortRecord = {
    alias: string;
    column: Knex.Raw;
};
export declare abstract class SchemaHelper extends DatabaseHelper {
    isOneOfClients(clients: DatabaseClient[]): boolean;
    changeNullable(table: string, column: string, nullable: boolean): Promise<void>;
    generateIndexName(type: 'unique' | 'foreign' | 'index', collection: string, fields: string | string[]): string;
    changeToType(table: string, column: string, type: (typeof KNEX_TYPES)[number], options?: Options): Promise<void>;
    protected changeToTypeByCopy(table: string, column: string, type: (typeof KNEX_TYPES)[number], options: Options): Promise<void>;
    preColumnChange(): Promise<boolean>;
    postColumnChange(): Promise<void>;
    preRelationChange(_relation: Partial<Relation>): void;
    setNullable(column: Knex.ColumnBuilder, field: RawField | Field, existing: Column | null): void;
    processFieldType(field: Field): Type;
    constraintName(existingName: string): string;
    applyLimit(rootQuery: Knex.QueryBuilder, limit: number): void;
    applyOffset(rootQuery: Knex.QueryBuilder, offset: number): void;
    castA2oPrimaryKey(): string;
    formatUUID(uuid: string): string;
    /**
     * @returns Size of the database in bytes
     */
    getDatabaseSize(): Promise<number | null>;
    prepQueryParams(queryParams: Sql): Sql;
    prepBindings(bindings: Knex.Value[]): any;
    addInnerSortFieldsToGroupBy(_groupByFields: (string | Knex.Raw)[], _sortRecords: SortRecord[], _hasRelationalSort: boolean): void;
    getColumnNameMaxLength(): number;
    getTableNameMaxLength(): number;
}