Runtime and adapters

Runtime startup should be driven by generated metadata.

In these docs, runtime means normal application database access after the schema has already been prepared through rollout or local upgrade steps.

Preferred openers

final inMemory = GeneratedComonOrmClient.openInMemory();
final sqlite = await GeneratedComonOrmClientSqlite.open();
final postgres = await GeneratedComonOrmClientPostgresql.open();
final flutterSqlite = await GeneratedComonOrmClientFlutterSqlite.open(
  databasePath: 'app.db',
);

The adapter-specific openers come from generated schema metadata. That keeps runtime behavior aligned with the generated client and avoids loading schema.prisma on normal startup.

Typical app shapes

Backend singleton or shared app service

class AppDatabase {
  AppDatabase._();

  static final AppDatabase instance = AppDatabase._();

  GeneratedComonOrmClient? _client;

  Future<GeneratedComonOrmClient> client() async {
    return _client ??= await GeneratedComonOrmClientPostgresql.open();
  }

  Future<void> close() async {
    await _client?.close();
    _client = null;
  }
}

Flutter local SQLite startup

await upgradeSqliteFlutterDatabase(
  databasePath: 'app.db',
  migrator: migrator,
);

final db = await GeneratedComonOrmClientFlutterSqlite.open(
  databasePath: 'app.db',
);

Fast local tests

final db = GeneratedComonOrmClient.openInMemory();

Explicit adapter path

If you want direct control over adapter construction, open from generated runtime schema metadata:

final adapter = await PostgresqlDatabaseAdapter.openFromGeneratedSchema(
  schema: GeneratedComonOrmClient.runtimeSchema,
);

final db = GeneratedComonOrmClient(adapter: adapter);

The same pattern exists for SQLite and Flutter SQLite adapters.

Generated runtime metadata

Generated clients expose runtime metadata so adapters and tests stay aligned with the generated code.

Typical generated surface:

• GeneratedComonOrmClient.runtimeSchema
• GeneratedComonOrmClient.runtimeSchemaView
• GeneratedComonOrmClient.createInMemoryAdapter()
• GeneratedComonOrmClient.openInMemory()

Important split

• runtime openers are for normal application usage
• schema apply, bootstrap, and migration planning are tooling or explicit setup concerns
• Flutter local upgrades should run before the normal runtime opens the database

Continue with

• Choosing a runtime for adapter selection
• Testing for in-memory and test-friendly setup
• Migrations for rollout and recovery guidance