@vulcan-sql/core/src/models/profile.d.ts

Core package of VulcanSQL

export declare type ProfileAllowConstraints = string | Record<string, any> | Array<string | Record<string, any>>;
export interface Profile<C = Record<string, any>> {
    /** This unique name of this profile */
    name: string;
    /** Which driver we should use */
    type: string;
    /** Connection info, which depends on drivers */
    connection?: C;
    /** Cache Layer setting parameters, which depends on drivers */
    cache?: C;
    /** What users have access to this profile */
    allow: ProfileAllowConstraints;
    /** Properties that can be used when involking the dataSource method */
    properties?: Record<string, any>;
}