https://github.com/ktvipin27/roominspector

An in-app database inspector for Room databases.
https://github.com/ktvipin27/roominspector

android-app android-database android-debug android-debug-database android-library android-room room-database room-persistence-library sqlite

Last synced: about 1 month ago
JSON representation

An in-app database inspector for Room databases.

• Host: GitHub
• URL: https://github.com/ktvipin27/roominspector
• Owner: ktvipin27
• License: apache-2.0
• Created: 2020-05-12T06:09:25.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-24T05:03:49.000Z (almost 3 years ago)
• Last Synced: 2024-10-09T15:00:19.148Z (about 1 month ago)
• Topics: android-app, android-database, android-debug, android-debug-database, android-library, android-room, room-database, room-persistence-library, sqlite
• Language: Kotlin
• Homepage: https://medium.com/@ktvipin27/inspect-your-room-database-with-room-inspector-b8d961bf311d
• Size: 46.4 MB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.ktvipin27/room-inspector/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.ktvipin27/room-inspector) 

[![API](https://img.shields.io/badge/API-19%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=19) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/zerobranch/android-remote-debugger/blob/master/LICENSE)

An in-app database inspector for [Android Room](https://developer.android.com/topic/libraries/architecture/room) databases.

Read in detail [here](https://medium.com/@ktvipin27/inspect-your-room-database-with-room-inspector-b8d961bf311d).



Built with ❤︎ by [Vipin KT](https://twitter.com/ktvipin27)

## Features

* View tables

* Add rows

* Update rows

* Delete rows

* Delete tables

* Drop tables

* Export tables

* Custom queries

## Installation

Add this in your app's build.gradle file:

Groovy DSL

  

```groovy

  dependencies {

       implementation 'io.github.ktvipin27:room-inspector:1.0.3'

  }

```

Kotlin DSL

  

```kotlin

  dependencies {

       implementation("io.github.ktvipin27:room-inspector:1.0.3")

  }

```

## Usage

To inspect your Room database with RoomInspector, just call the `inspect()` method by passing your database class and database name.

Kotlin

```kotlin

  RoomInspector.inspect(context, MyDatabase::class.java, MyDatabase.DB_NAME)

```

Java

```java

  RoomInspector.inspect(context, MyDatabase.class, MyDatabase.DB_NAME)

```

## License    

    Copyright 2021 Vipin KT

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.