Skip to content

Database diagrams editor that allows you to visualize and design your DB with a single query.

2.3 KB
Raw Blame
import { DatabaseType } from './database-type';

export interface DatabaseCapabilities {
    supportsArrays?: boolean;
    supportsCustomTypes?: boolean;
    supportsSchemas?: boolean;
    supportsComments?: boolean;
    supportsCheckConstraints?: boolean;
}

export const DATABASE_CAPABILITIES: Record<DatabaseType, DatabaseCapabilities> =
    {
        [DatabaseType.POSTGRESQL]: {
            supportsArrays: true,
            supportsCustomTypes: true,
            supportsSchemas: true,
            supportsComments: true,
            supportsCheckConstraints: true,
        },
        [DatabaseType.COCKROACHDB]: {
            supportsArrays: true,
            supportsSchemas: true,
            supportsComments: true,
            supportsCheckConstraints: true,
        },
        [DatabaseType.MYSQL]: {
            supportsCheckConstraints: true,
        },
        [DatabaseType.MARIADB]: {
            supportsCheckConstraints: true,
        },
        [DatabaseType.SQL_SERVER]: {
            supportsSchemas: true,
            supportsCheckConstraints: true,
        },
        [DatabaseType.SQLITE]: {
            supportsCheckConstraints: true,
        },
        [DatabaseType.CLICKHOUSE]: {
            supportsSchemas: true,
        },
        [DatabaseType.ORACLE]: {
            supportsSchemas: true,
            supportsComments: true,
            supportsCheckConstraints: true,
        },
        [DatabaseType.GENERIC]: {},
    };

export const getDatabaseCapabilities = (
    databaseType: DatabaseType
): DatabaseCapabilities => {
    return DATABASE_CAPABILITIES[databaseType];
};

export const databaseSupportsArrays = (databaseType: DatabaseType): boolean => {
    return getDatabaseCapabilities(databaseType).supportsArrays ?? false;
};

export const databaseTypesWithCommentSupport: DatabaseType[] = Object.keys(
    DATABASE_CAPABILITIES
).filter(
    (dbType) => DATABASE_CAPABILITIES[dbType as DatabaseType].supportsComments
) as DatabaseType[];

export const supportsCustomTypes = (databaseType: DatabaseType): boolean => {
    return getDatabaseCapabilities(databaseType).supportsCustomTypes ?? false;
};

export const supportsCheckConstraints = (
    databaseType: DatabaseType
): boolean => {
    return (
        getDatabaseCapabilities(databaseType).supportsCheckConstraints ?? false
    );
};