colintheshots/realm-browser

Android Database Browser for realm-java

Description

Android Realm Browser

This is a fork of dmytrodanylyk/realm-browser which was originally created by Danylyk Dmytro.

Integration

The project is available via JitPack.io.

Step 1. Add the JitPack repository to your build file

allprojects {
        repositories {
        ...
        maven { url "https://jitpack.io" }
        }
    }
}

Step 2. Add the dependency

dependencies {
    debugCompile 'com.github.jonasrottmann.realm-browser:realm-browser:v0.0.8'
    testCompile 'com.github.jonasrottmann.realm-browser:realm-browser-no-op:v0.0.8'
    releaseCompile 'com.github.jonasrottmann.realm-browser:realm-browser-no-op:v0.0.8'
}

‼️ Make sure to use any version of this realm-browser from v0.0.8 and up only with a realm version in your project from 0.88.0 and up.

‼️ This library is not yet compatible with the newly (in Realm 0.89.0) introduced interface RealmModel. You have to stick with extending RealmObject for now.

Usage

To initialize the Realm Browser add all classes which you want to see using the method below. Those classes must extend RealmObject.

RealmBrowser.getInstance().addRealmModel(Example.class, ...);

If you want to see all your databases call:

RealmBrowser.startRealmFilesActivity(context);

If you want to see all your table list call:

RealmBrowser.startRealmModelsActivity(context, "<name of the database file>")

To display a notification from which the Realm Browser can be started.

RealmBrowser.showRealmFilesNotification(context);

For a full working example check out the sample app.

License

The MIT License (MIT)

Original Work: Copyright (c) 2015 Danylyk Dmytro

Modified Work: Copyright (c) 2015 Rottmann, Jonas

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.