Wrap your database into Java 8!

Speedment accelerates your development speed and makes programming so easy and fun!

When you use Speedment for database querying, you do not have to learn a new APIs or use complex ORMs. Everything is standard Java 8 and works out of the box!

This site covers the Speedment Open Source project available under the Apache 2 license. If you are interested in the enterprise product with support for commercial databases and in-memory acceleration, check out www.speedment.com!

Documentation

You can read the the API quick start here!

Tutorials

• Tutorial 1 - Get started with the UI
• Tutorial 2 - Hello Speedment
• Tutorial 3 - Build a Social Network
• Tutorial 4 - Log errors in a database
• Tutorial 5 - Using Speedment with Java EE
• Tutorial 6 - Writing your own extensions
• Tutorial 7 - Plug-in a Custom TypeMapper

Examples

Here are a few examples of how you could use Speedment from your code:

Easy initialization

A HareApplication class is generated from the database.

Speedment speedment = new HareApplication().withPassword("myPwd729").build();
Manager<Hare> hares = speedment.managerOf(Hare.class);

Optimised predicate short-circuit

Search for Hares by a certain age:

// Searches are optimized in the background!
Optional<Hare> harry = hares.stream()
    .filter(NAME.equal("Harry").and(AGE.lessThan(5)))
    .findAny();

Results in the following SQL query:

SELECT * FROM `Hare` 
    WHERE `Hare`.`name` = "Harry"
    AND `Hare`.`age` < 5
    LIMIT 1;

Easy persistence

Entities can be persisted in a database using the "Active Record Pattern"

Hare dbHarry = hares.newEmptyEntity()
    .setName("Harry")
    .setColor("Gray")
    .setAge(3)
    .persist();

JPA-style persistance if you prefer that over the "Active Record Pattern".

Hare harry = hares.newEmptyEntity()
    .setName("Harry")
    .setColor("Gray")
    .setAge(3);

Hare dbHarry = EntityManager.get(speedment).persist(harry);

Entities are linked

No need for complicated joins!

Optional<Carrot> carrot = hares.stream()
    .filter(NAME.equal("Harry"))
    .flatMap(Hare::findCarrots) // Carrot is a foreign key table.
    .findAny();

Convert to JSON

// List all hares in JSON format
hares.stream()
    .map(Hare::toJson)
    .forEach(System.out::println);

Or collect the entire stream

// List all hares as one JSON object
String json = hares.stream()
    .collect(CollectorUtil.toJson());

Features

Here are some of the many features packed into the Speedment framework!

Database centric

Speedment is using the database as the source-of-truth, both when it comes to the domain model and the actual data itself. Perfect if you are tired of configuring and debuging complex ORMs. After all, your data is more important than programming tools, is it not?

Code generation

Speedment inspects your database and can automatically generate code that reflects the latest state of your database. Nice if you have changed the data structure (like columns or tables) in your database. Optionally, you can change the way code is generated using an intuitive UI or programatically using your own code.

Modular Design

Speedment is built with the ambition to be completely modular! If you don't like the current implementation of a certain function, plug in you own! Do you have a suggestion for an alternative way of solving a complex problem? Share it with the community!

Type Safety

When the database structure changes during development of a software there is always a risk that bugs sneak into the application. Thats why type-safety is such a big deal! With Speedment, you will notice if something is wrong seconds after you generate your code instead of weeks into the testing phase.

Null Protection

Ever seen a NullPointerException suddenly casted out of nowhere? Null-pointers have been called the billion-dollar-mistake of java, but at the same time they are used in almost every software project out there. To minimize the production risks of using null values, Speedment analyzes if null values are allowed by a column in the database and wraps the values as appropriate in Java 8 Optionals.

Using Maven

The easiest way to get started with Speedment and Maven is to use one of the existing archetypes. An archetype is similar to a template project. When you start a new project, it will add all the dependencies you need to your pom.xml-file so that you can begin program immetiatly.

If you do not want to use an archetype, for an example if you already have a project you want to use Speedment with, you can always write your pom.xml-file manually. Just add the following lines (between the ... marker lines) to your project's pom.xml file, and then assign values to the parameters in the <properties>-section of the file.

<build>
    <plugins>
        ...
        <plugin>
            <groupId>com.speedment</groupId>
            <artifactId>speedment-maven-plugin</artifactId>
            <version>${speedment.version}</version>
            <dependencies>
                <dependency>
                    <groupId>${db.groupId}</groupId>
                    <artifactId>${db.artifactId}</artifactId>
                    <version>${db.version}</version>
                </dependency>
            </dependencies> 
        </plugin>
        ...
    </plugins>
</build>
<dependencies>
    ...
    <dependency>
        <groupId>com.speedment</groupId>
        <artifactId>speedment</artifactId>
        <version>${speedment.version}</version>
    </dependency>
    <dependency>
        <groupId>${db.groupId}</groupId>
        <artifactId>${db.artifactId}</artifactId>
        <version>${db.version}</version>
    </dependency>
    ...
</dependencies>

To set which database connector you want to use to communicate with your database, please add one of the following to your <properties>-section in the pom.xml-file:

MySQL

<properties>
    <speedment.version>2.3.2</speedment.version>
	<db.groupId>mysql</db.groupId>
	<db.artifactId>mysql-connector-java</db.artifactId>
	<db.version>5.1.38</db.version>
</properties>

PostgreSQL

<properties>
    <speedment.version>2.3.2</speedment.version>
	<db.groupId>org.postgresql</db.groupId>
	<db.artifactId>postgresql</db.artifactId>
	<db.version>9.4-1206-jdbc4</db.version>
</properties>

MariaDB

<properties>
    <speedment.version>2.3.2</speedment.version>
	<db.groupId>org.mariadb.jdbc</db.groupId>
	<db.artifactId>mariadb-java-client</db.artifactId>
	<db.version>1.4.0</db.version>
</properties>

Make sure that you use the latest ${speedment.version} available.

Requirements

Speedment comes with support for the following databases out-of-the-box:

• MySQL
• MariaDB
• PostgreSQL

Support for commercial databases like Oracle DB can be added using enterprise plugins. Visit www.speedment.com for more information on commercial alternatives.

As of version 2.0, Speedment requires Java 8 or later. Make sure your IDE configured to use JDK 8 (version 1.8.0_40 or newer).

License

Speedment is available under the Apache 2 License.

Copyright

Copyright (c) 2015, Speedment, Inc. All Rights Reserved. Visit www.speedment.org for more info.