mcpField
A
android-room-database

android-room-database

github.com/krutikjainData & databases14148 installsUpdated 31w ago
Repository

About android-room-database

A skill for Android Room database work, covering entities, DAOs, transactions, migrations, and tests for local persistence. It is for Android developers planning database schemas, queries, and safe schema evolution.

Key features

  1. 01Design entities, keys, indexes, and relations
  2. 02Plan DAO queries and transaction boundaries
  3. 03Manage schema exports and migrations
  4. 04Test queries and migrations
  5. 05Separate persistence and domain models

Use cases

  1. 01Design an app's local data model
  2. 02Plan migrations for entity changes
  3. 03Verify migration from old schemas
  4. 04Test DAO queries and transaction behavior

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/krutikjain/android-agent-skills --skill android-room-database

After installing, type/android-room-databasein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

agents/
openai.yaml
references/
official-links.md
patterns.md
scenarios.md
scripts/
run_examples.sh

Details

From the project README

Android Room Database

When To Use

  • Use this skill when the request is about: room database android, dao query migration android, room schema export.
  • Primary outcome: Model Room entities, DAOs, transactions, migrations, schema exports, and test-safe local persistence.
  • Reach for this skill when the hard part is schema design, DAO queries, transactions, migrations, or Room testing. Hand off to android-rxjava-to-coroutines-migration only if the main work is reactive API migration rather than the database contract itself.
  • Handoff skills when the scope expands:
  • android-local-persistence-datastore
  • android-testing-unit

Workflow

  1. Start with the persistence contract: entities, keys, indexes, relations, and whether the data is source-of-truth, cache, or offline-first state.
  2. Model DAO access patterns explicitly, including transaction boundaries, query shape, paging, and invalidation behavior.
  3. Plan schema evolution before changing entities: exported schemas, migration steps, auto-migration eligibility, and destructive-fallback policy.
  4. Validate migration and query behavior with deterministic tests rather than assuming Room annotations are enough.
  5. Hand off DataStore, sync, or reactive API questions only after the Room boundary is correct.

Guardrails

  • Export schemas and treat them as part of the contract, not optional tooling noise.
  • Keep entities persistence-focused; map to domain/UI models instead of leaking table shape upward.
  • Use explicit transactions for multi-step writes that must remain consistent.
  • Test migrations against real old schemas before trusting them in release builds.

Anti-Patterns

  • Treating Room entities as the app's domain model everywhere.
  • Editing schemas without exporting or validating migration paths.
  • Writing broad SELECT * queries when the screen only needs a narrow projection.
  • Collapsing database, sync, and reactive-stream migration problems into one undifferentiated task.

Review Focus

  • Entity keys, indexes, relations, and schema ownership.
  • DAO query shape, transactions, and invalidation behavior.
  • Migration safety, schema exports, and test coverage.
  • Clear boundaries between Room models and higher-level app models.

Examples

Happy path
  • Scenario: Persist task items and reminder flags with schema-aware entities.
  • Command: cd examples/orbittasks-compose && ./gradlew :app:testDebugUnitTest
Edge case
  • Scenario: Recover from a failed schema change with an explicit migration path.
  • Command: python3 scripts/eval_triggers.py --skill android-room-database
Failure recovery
  • Scenario: Keep Room requests separate from DataStore, networking, and modernization prompts.
  • Command: cd examples/orbittasks-xml && ./gradlew :app:testDebugUnitTest

Done Checklist

  • Entities, DAOs, and transactions match the real persistence contract.
  • Schema export and migration strategy are explicit.
  • Query and migration tests cover the risky paths.
  • Non-Room concerns are handed off instead of mixed into the database task.

Official References

Comments

Markdown supported