@palmares/databases
Version:
Add support for working with databases with palmares framework
69 lines • 2.06 kB
TypeScript
import type { DatabaseAdapter } from '..';
export declare function adapterRemoveQuery<TFunctionQueryData extends AdapterRemoveQuery['queryData']>(args: {
/**
* This query is used to remove a certain data from the database.
*
* An example of how you can implement it on sequelize
* @example
* ```typescript
* queryData: async (_, args) => {
* async function remove() {
* return args.modelOfEngineInstance.destroy({
* where: args.search,
* transaction: args.transaction,
* });
* }
*
* const deleted = await args.modelOfEngineInstance.findAll({
* where: args.search,
* transaction: args.transaction,
* });
* await remove();
*
* return deleted.map((data: any) => data.toJSON());
*
* }
*/
queryData: TFunctionQueryData;
}): typeof AdapterRemoveQuery & {
new (): AdapterRemoveQuery & {
queryData: TFunctionQueryData;
};
};
export declare class AdapterRemoveQuery {
/**
* This query is used to remove a certain data from the database.
*
* An example of how you can implement it on sequelize
* @example
* ```typescript
* queryData: async (_, args) => {
* async function remove() {
* return args.modelOfEngineInstance.destroy({
* where: args.search,
* transaction: args.transaction,
* });
* }
*
* if (args.shouldReturnData) {
* const deleted = await args.modelOfEngineInstance.findAll({
* where: args.search,
* transaction: args.transaction,
* });
* await remove();
*
* return deleted.map((data: any) => data.toJSON());
* }
*
* await remove();
* return [];
* }
*/
queryData(_engine: DatabaseAdapter, _args: {
modelOfEngineInstance: any;
search: any;
shouldNotDelete?: boolean;
transaction?: any;
}): Promise<any[]>;
}
//# sourceMappingURL=remove.d.ts.map