Get Started

If you are new to androrm or the world of object relational mapping (ORM), the get started guide is probably what you are looking for. If that one has convinced you, check out the installation guide or kick-start with our tutorial.

Developer?

You are looking for more detailed information about classes and functions? Check out the javadoc for the whole project or get more information in the contribute section.

All other folks...

...just have a look in the side menu. There you'll find information about basic model functions, detailed descriptions of all field types and (maybe the best part) how to write queries. Spoiler alert! No SQL here.

What you might recognize is, that the whole androrm API resembles django.This indeed was intentional. I think django is just a great web-framework and even this site here was written using it. So, if you are familiar with their way of doing things, you won't have any problems, to use androrm for your android app. Enjoy!

And if you should ever have any trouble working with androrm, please do not hesitate to contact us under contact@androrm.com.


Beginners

If you are new to androrm or even new to the whole world of ORM, then you should find everything you need for a good start in this section. It offers documents, that show you, how androrm works and why you can benefit from using it and also helps you to set up your application in the best way.


Defining Models

In this section, you will learn everything about how to factor your model classes in order to work with androrm and to benefit of the ORM.


Making Queries

After you set up all your model classes, you probably also want to do something with them. Androrm gives you full support for queries, that span as many of you classes, as you like. It only requires you, to define all relational fields correctly. You will be surprised, how easy your life can be with androrm.

androrm on github

Django is a registered trademark of the Django Foundation. Android is a registered trademark of Google Inc.