wajahatkarim3 / roomexplorer

🔎 A quick and easy in-app database viewer and manager library for your Room databases.

  The article on why and how this library was created is now published. You can read it on this link here. →.

🔎 RoomExplorer

A quick and easy database viewer and manager library for your Room databases.

_{Built with ❤︎ by Wajahat Karim and contributors}

✔️ Changelog

Changes exist in the releases tab.

🎯 Features

• View all your tables data in tabular format
• Insert rows to your tables
• Update rows
• Delete rows
• Delete tables
• Drop tables
• Write your own custom queries and view the results. (Create statements, joins, etc)
• Change data in the tables and see how you application responds

💻 Installation

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

dependencies {
  implementation 'com.wajahatkarim:roomexplorer:1.0.1'
}

Or add RoomExplorer as a new dependency inside your pom.xml

<dependency> 
  <groupId>com.wajahatkarim</groupId>
  <artifactId>roomexplorer</artifactId> 
  <version>1.0.1</version>
  <type>pom</type> 
</dependency>

❔ How to Use

To view your Room databases in Room Explorer, just call this line and pass your database class and database name in the show() method.

   RoomExplorer.show(context, MyRoomDB::class.java, "MyRoomDBName")

👨 Developed By

Wajahat Karim

• Website (http://wajahatkarim.com)
• Twitter (http://twitter.com/wajahatkarim)
• Medium (http://www.medium.com/@wajahatkarim3)
• LinkedIn (http://www.linkedin.com/in/wajahatkarim)

👍 How to Contribute

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

📃 License

Copyright 2019 Wajahat Karim

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.

roomexplorer's Issues

Room Explorer View With Night Mode

When night mode is on in the phone settings, the Room Explorer View is not visible. Still clickable but not visible at initial.

Tested in Samsung SM-J701 Android 9, Api 28

Room-Explorer-Night-Mode-Issue.mp4

Jcenter is shutting down

Since JCentre is going to shut down, this library needs to be uploaded to maven or other suitable library hosting platforms.
More on this article https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/