supastash/dist/utils/schema/wipeTables.d.ts

Offline-first sync engine for Supabase in React Native using SQLite

/**
 * Wipes a specific table from the local SQLite database and removes its sync metadata.
 *
 * ⚠️ WARNING: This is a destructive operation. It should only be used in development mode,
 * as it will permanently delete all local data for the specified table.
 *
 * @param tableName - Name of the table to drop.
 *
 * @example
 * configureSupastash({
 *   ...
 *   onSchemaInit: async () => {
 *     await wipeTable("users"); // dev-only: clears the "users" table on app start
 *   }
 * });
 */
export declare function wipeTable(tableName: string): Promise<void>;
/**
 * Drops a specific table from the local SQLite database and removes its sync metadata.
 *
 * ⚠️ WARNING: This is a destructive operation. It should only be used in development mode,
 * as it will permanently delete all local data for the specified table.
 *
 * @param tableName - Name of the table to drop.
 *
 * @example
 * configureSupastash({
 *   ...
 *   onSchemaInit: async () => {
 *     await dropTable("users"); // dev-only: drops the "users" table on app start
 *   }
 * });
 */
export declare function dropTable(tableName: string): Promise<void>;
/**
 * Drops all tables from the local SQLite database and removes their sync metadata.
 *
 * ⚠️ WARNING: This is a destructive operation. It should only be used in development mode,
 * as it will permanently delete all local data for all tables.
 *
 * @example
 */
export declare function dropAllTables(): Promise<void>;
/**
 * Wipes all local tables managed by Supastash and clears associated sync metadata.
 *
 * ⚠️ WARNING: This will irreversibly delete all local tables and their data.
 * Intended only for development or reset scenarios.
 *
 * @example
 * configureSupastash({
 *   ...
 *   onSchemaInit: async () => {
 *     await wipeAllTables(); // dev-only: clears all local tables on app start
 *   }
 * });
 */
export declare function wipeAllTables(): Promise<void>;
/**
 * Wipes old rows from a specified table based on the `created_at` timestamp.
 *
 * This is useful for maintaining a lean local cache by removing stale data
 * during Supastash initialization or periodic syncs.
 *
 * @param tableName - Name of the table to clean up (must have a `created_at` column).
 * @param daysFromNow - Number of days to retain; older rows will be deleted.
 *
 * @example
 * ```ts
 * // Typically used during Supastash schema setup:
 * configureSupastash({
 *   ...,
 *   onSchemaInit: async () => {
 *     await wipeOldDataForATable("users", 30);
 *     // Removes all rows in "users" created more than 30 days ago
 *   }
 * });
 * ```
 */
export declare function wipeOldDataForATable(tableName: string, daysFromNow: number): Promise<void>;
/**
 * Deletes old records (based on `created_at`) from all tables, excluding those specified.
 *
 * Only records older than the given number of days will be removed.
 *
 * @param daysFromNow - Cutoff age in days; records older than this will be deleted.
 * @param excludeTables - Optional array of table names to skip during cleanup.
 *
 * @example
 * configureSupastash({
 *   ...
 *   onSchemaInit: async () => {
 *     await wipeOldDataForAllTables(30, ["app_settings"]); // skips wiping "app_settings"
 *   }
 * });
 */
export declare function wipeOldDataForAllTables(daysFromNow: number, excludeTables?: string[]): Promise<void>;
//# sourceMappingURL=wipeTables.d.ts.map