Tearing Down Document Storage

Polecat provides methods for cleaning up data, primarily useful during testing and development.

Cleaning All Documents

Delete all data from all document tables:

await store.Advanced.CleanAllDocumentsAsync();

This executes DELETE FROM on every pc_doc_* table.

Cleaning a Specific Type

Delete all documents of a specific type:

await store.Advanced.CleanAsync<User>();

Cleaning All Event Data

Delete all events, streams, and progression data:

await store.Advanced.CleanAllEventDataAsync();

This cleans:

• pc_events -- All event records
• pc_streams -- All stream metadata
• pc_event_progression -- All daemon progression

Usage in Tests

Cleaning is most commonly used in integration test setup:

public class MyTests : IAsyncLifetime
{
    private IDocumentStore _store = null!;

    public async Task InitializeAsync()
    {
        _store = DocumentStore.For(opts => { ... });

        // Clean slate for each test
        await _store.Advanced.CleanAllDocumentsAsync();
        await _store.Advanced.CleanAllEventDataAsync();
    }

    public async Task DisposeAsync()
    {
        await _store.DisposeAsync();
    }
}

WARNING

These methods permanently delete data. They should only be used in development and testing environments, never in production.