Circle V2 API Docs
    Preparing search index...

    Variable entitySettingsTableConst

    entitySettingsTable: Omit<
        PgTableWithColumns<
            {
                columns: {
                    createdAt: PgColumn<
                        {
                            baseColumn: never;
                            columnType: "PgTimestampString";
                            data: Generated;
                            dataType: "string";
                            driverParam: string;
                            enumValues: undefined;
                            generated: undefined;
                            hasDefault: true;
                            hasRuntimeDefault: false;
                            identity: undefined;
                            isAutoincrement: false;
                            isPrimaryKey: false;
                            name: "created_at";
                            notNull: true;
                            tableName: "entity_settings";
                        },
                        {},
                        { $type: Generated },
                    >;
                    entityId: PgColumn<
                        {
                            baseColumn: never;
                            columnType: "PgInteger";
                            data: EntityId;
                            dataType: "number";
                            driverParam: string
                            | number;
                            enumValues: undefined;
                            generated: undefined;
                            hasDefault: false;
                            hasRuntimeDefault: false;
                            identity: undefined;
                            isAutoincrement: false;
                            isPrimaryKey: false;
                            name: "entity_id";
                            notNull: true;
                            tableName: "entity_settings";
                        },
                        {},
                        { $type: EntityId },
                    >;
                    id: PgColumn<
                        {
                            baseColumn: never;
                            columnType: "PgSerial";
                            data: Generated;
                            dataType: "number";
                            driverParam: number;
                            enumValues: undefined;
                            generated: undefined;
                            hasDefault: true;
                            hasRuntimeDefault: false;
                            identity: undefined;
                            isAutoincrement: false;
                            isPrimaryKey: true;
                            name: "id";
                            notNull: true;
                            tableName: "entity_settings";
                        },
                        {},
                        { $type: Generated },
                    >;
                    settingKey: PgColumn<
                        {
                            baseColumn: never;
                            columnType: "PgText";
                            data: | "emrIntegrationEnabled"
                            | "sessionNoteGenerationEnabled"
                            | "chartReviewEnabled"
                            | "formFillingEnabled";
                            dataType: "string";
                            driverParam: string;
                            enumValues: [string, ...string[]];
                            generated: undefined;
                            hasDefault: false;
                            hasRuntimeDefault: false;
                            identity: undefined;
                            isAutoincrement: false;
                            isPrimaryKey: false;
                            name: "setting_key";
                            notNull: true;
                            tableName: "entity_settings";
                        },
                        {},
                        {
                            $type: | "emrIntegrationEnabled"
                            | "sessionNoteGenerationEnabled"
                            | "chartReviewEnabled"
                            | "formFillingEnabled";
                        },
                    >;
                    updatedAt: PgColumn<
                        {
                            baseColumn: never;
                            columnType: "PgTimestampString";
                            data: Generated;
                            dataType: "string";
                            driverParam: string;
                            enumValues: undefined;
                            generated: undefined;
                            hasDefault: true;
                            hasRuntimeDefault: false;
                            identity: undefined;
                            isAutoincrement: false;
                            isPrimaryKey: false;
                            name: "updated_at";
                            notNull: true;
                            tableName: "entity_settings";
                        },
                        {},
                        { $type: Generated },
                    >;
                    updatedBy: PgColumn<
                        {
                            baseColumn: never;
                            columnType: "PgUUID";
                            data: UserId;
                            dataType: "string";
                            driverParam: string;
                            enumValues: undefined;
                            generated: undefined;
                            hasDefault: true;
                            hasRuntimeDefault: false;
                            identity: undefined;
                            isAutoincrement: false;
                            isPrimaryKey: false;
                            name: "updated_by";
                            notNull: false;
                            tableName: "entity_settings";
                        },
                        {},
                        { $type: UserId },
                    >;
                    value: PgColumn<
                        {
                            baseColumn: never;
                            columnType: "PgJsonb";
                            data: boolean;
                            dataType: "json";
                            driverParam: unknown;
                            enumValues: undefined;
                            generated: undefined;
                            hasDefault: false;
                            hasRuntimeDefault: false;
                            identity: undefined;
                            isAutoincrement: false;
                            isPrimaryKey: false;
                            name: "value";
                            notNull: true;
                            tableName: "entity_settings";
                        },
                        {},
                        { $type: boolean },
                    >;
                };
                dialect: "pg";
                name: "entity_settings";
                schema: undefined;
            },
        >,
        "enableRLS",
    > = ...

    Org-level feature gates managed by CSMs (superadmins). Each row is an explicit override of the in-code registry default for that setting. Absence of a row means the entity uses the default. See ./entity-settings.registry for the registry.

    Settings

    Member Visibility