README.md

ORMLite Core

This package provides the core functionality for the JDBC and Android packages. Users that are connecting to SQL databases via JDBC should download the ormlite-jdbc package instead which includes these core classes. Android users should download the ormlite-android package instead which also includes these core classes.

• For more information, visit the ORMLite home page.
• Online documentation can be found off the home page. Here's the getting started information. Here are the Javadocs for the code:
• Browse the code on the git repository.
• Maven packages are published via
• I've published a number of example programs.

ORMLite is easy to use and provides the following features:

• Setup your classes by simply adding Java annotations.
• Powerful abstract Database Access Object (DAO) classes.
• Flexible query builder to easily construct simple and complex queries.
• Supports MySQL, Postgres, Microsoft SQL Server, H2, Derby, HSQLDB, and Sqlite and can be extended to additional databases relatively easily.
• Provisional support for DB2, Oracle, ODBC, and Netezza. Contact the author if your database type is not supported.
• Handles "compiled" SQL statements for repetitive query tasks.
• Supports "foreign" objects with the class field being the object but an id stored in the database table.
• Basic support for database transactions.
• Auto generates SQL to create and drop database tables.
• Spring configuration support for DOAs and class configurations.
• Support for configuring of tables and fields without annotations.
• Supports native calls to Android SQLite database APIs.

Enjoy, Gray Watson

Code Example

The following is a quick code example to give you a taste on how to use the library.

// this uses h2 but you can change it to match your database
String databaseUrl = "jdbc:h2:mem:account";
// create a connection source to our database
ConnectionSource connectionSource = new JdbcConnectionSource(databaseUrl);

// instantiate the DAO to handle Account with String id
Dao<Account,String> accountDao = DaoManager.createDao(connectionSource, Account.class);

// if you need to create the 'accounts' table make this call
TableUtils.createTable(connectionSource, Account.class);

// create an instance of Account
String name = "Jim Smith";
Account account = new Account(name, "_secret");

// persist the account object to the database
accountDao.create(account);

// retrieve the account
Account account2 = accountDao.queryForId(name);
// show its password
System.out.println("Account: " + account2.getPassword());

// close the connection source
connectionSource.close();

Logging Information

ORMLite has copied in logging code from SimpleLogging which backends to a number of different logging systems and is configurable via code or configuration. For more details see the logging documentation.

Maven Configuration

For JDBC usage, you should depend on which includes the core classes.

<dependency>
	<groupId>com.j256.ormlite</groupId>
	<artifactId>ormlite-jdbc</artifactId>
	<version>6.1</version>
</dependency>

For Android usage, you should depend on which includes the core classes.

<dependency>
	<groupId>com.j256.ormlite</groupId>
	<artifactId>ormlite-android</artifactId>
	<version>6.1</version>
</dependency>

ChangeLog Release Notes

See the ChangeLog.txt file.