Documentation
    Preparing search index...

    Interface BackendInterface

    interface BackendInterface {
        aggregate(
            query: Query<any>,
            operation: "sum" | "avg" | "distinct" | "min" | "max" | "count",
            property?: string,
        ): Promise<any>;
        create(
            dataObject: DataObjectClass<any>,
            desiredUid: string | undefined,
        ): Promise<DataObjectClass<any>>;
        delete(
            dataObject: DataObjectClass<any>,
            hardDelete?: boolean,
        ): Promise<DataObjectClass<any>>;
        find(
            dataObject: DataObjectClass<any>,
            filters: Filter[] | Filters | undefined,
            pagination: SortAndLimit | undefined,
            parent: any,
        ): Promise<QueryResultType<DataObjectClass<any>>>;
        generateCreateSql(
            collection: string,
            properties: any[],
        ): { downSql: string; upSql: string };
        generateDeltaSql(
            collection: string,
            delta: SchemaDelta,
        ): { downSql: string[]; upSql: string[] };
        query(query: Query<any>): Promise<QueryResultType<DataObjectClass<any>>>;
        read(param: string | DataObjectClass<any>): Promise<DataObjectClass<any>>;
        update(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • query: Query<any>
      • operation: "sum" | "avg" | "distinct" | "min" | "max" | "count"
      • Optionalproperty: string

      Returns Promise<any>

    • Parameters

      • collection: string
      • properties: any[]

      Returns { downSql: string; upSql: string }

    • Parameters

      Returns { downSql: string[]; upSql: string[] }