Getting started

Dzmitry Plashchynski edited this page Jul 7, 2016 · 22 revisions

Let’s get started with ActiveAndroid. The first thing you need to do, if you haven’t already done so, is download the ActiveAndroid library. or the latest stable ActiveAndroid jar file. If you downloaded the library and not the jar, you'll have to build the jar file by running ant in the root folder. Your ActiveAndroid.jar, which is what we need, will be in the dist folder.

Adding The JAR

Now that you have the ActiveAndroid library you can add it to your project’s build path. If you’re using Eclipse:

  1. If you haven’t done so already, create an Android project.
  2. Copy ActiveAndroid.jar to the libs-folder of your new project.
  3. Right click on your project and select Build Path > Configure Build Path…
  4. Click the Add External Jars… button and choose the ActiveAndroid jar file.

If you're using Android Studio:

  1. If you haven’t done so already, create an Android project.
  2. Drag the jar to the libs folder of project.
  3. Right click on the jar, and select "Add as a Library…"

Installing From Maven

First, clone the source from Git and install the package to your local repository:
Note: Maven 3.1.1 or later is required

  1. git clone
  2. cd ActiveAndroid
  3. mvn clean install

After the project builds successfully, add the following dependency to your pom.xml

    <version>(insert latest version)</version>

Installing with Gradle

Modify your build.gradle to include:

repositories {
    maven { url "" }

compile 'com.michaelpardo:activeandroid:3.1.0-SNAPSHOT'

Configuring Your Project

Now that you have ActiveAndroid added to you project, you can begin your two-step configuration process! The first thing we’ll need to do is add some global settings. ActiveAndroid will look for these in the AndroidManifest.xml file. Open the AndroidManifest.xml file located at the root directory of your project. Let’s add some configuration options.

  • AA_DB_NAME (optional)
  • AA_DB_VERSION (optional – defaults to 1)

The configuration strings for my project look like this

<manifest ...>
    <application android:name="" ...>


        <meta-data android:name="AA_DB_NAME" android:value="Pickrand.db" />
        <meta-data android:name="AA_DB_VERSION" android:value="5" />


Notice also that the application name points to the ActiveAndroid application class. This step is required for ActiveAndroid to work.

If you are using a custom Application class, just extend instead of

public class MyApplication extends { ...

But what if you're already doing this to utilize another library? Simply initialize ActiveAndroid in the Application class. You may call ActiveAndroid.dispose(); if you want to reset the framework for debugging purposes. (Don’t forget to call initialize again.)

public class MyApplication extends SomeLibraryApplication {
    public void onCreate() {

If you want to build a database dynamically.You can use the configuration class.

public class MyApplication extends SomeLibraryApplication {
    public void onCreate() {
        Configuration dbConfiguration = new Configuration.Builder(this).setDatabaseName("xxx.db").create();

In our example we have two tables: Category and Item.
In step two you will create classes for those tables.
Don’t worry though, this part is easy too.

We'll go into more detail about setting up the database model later, but here are our classes.

@Table(name = "Categories")
public class Category extends Model { 
    @Column(name = "Name")
    public String name;

@Table(name = "Items")
public class Item extends Model {
    @Column(name = "Name")
    public String name;

    @Column(name = "Category")
    public Category category;

That’s it for configuration. Next, let's learn about creating your database model.