Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/speedment/speedment

Speedment is a Stream ORM Java Toolkit and Runtime
https://github.com/speedment/speedment

code-generator database java java-ee javafx orm spring spring-boot stream

Last synced: about 9 hours ago
JSON representation

Speedment is a Stream ORM Java Toolkit and Runtime

Host: GitHub
URL: https://github.com/speedment/speedment
Owner: speedment
License: apache-2.0
Created: 2015-01-19T16:41:52.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2023-11-07T17:59:16.000Z (about 1 year ago)
Last Synced: 2024-12-05T22:00:30.901Z (7 days ago)
Topics: code-generator, database, java, java-ee, javafx, orm, spring, spring-boot, stream
Language: Java
Homepage:
Size: 25.2 MB
Stars: 2,093
Watchers: 133
Forks: 229
Open Issues: 95
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-java - Speedment - Database access library that utilizes Java 8's Stream API for querying. (Projects / Database)
awesome-java-zh - Speedment - 利用Java 8的Stream API进行查询的数据库访问库。 (项目 / 数据库)
awesome-swedish-opensource - Speedment
awesome-java - Speedment - Database access library that utilizes Java 8's Stream API for querying. (Projects / Database)

README

        

Java Stream ORM

====================================================

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.speedment/runtime/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.speedment/runtime)

[![Javadocs](https://javadoc-badge.appspot.com/com.speedment.runtime/runtime-application.svg?label=javadoc)](https://www.javadoc.io/doc/com.speedment.runtime/runtime-application)

[![Build Status](https://travis-ci.org/speedment/speedment.svg?branch=develop-3.0)](https://travis-ci.org/speedment/speedment)

[![Hex.pm](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://raw.githubusercontent.com/speedment/speedment/master/LICENSE)

[![Join the chat at https://gitter.im/speedment/speedment](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/speedment/speedment?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Speedment is an open source Java Stream ORM toolkit and runtime. The toolkit analyzes the metadata of an existing SQL database and automatically creates a Java representation of the data model. This powerful ORM enables you to create scalable and efficient Java applications using **standard Java** streams with no need to type SQL or use any new API. 

Speedment was originally developed by researchers and engineers based in Palo Alto with the purpose to simplify and streamline the development of Java database applications by leveraging the Java Stream API. 

Speedment is licensed under the business-friendly Apache 2 license. Contribution from users is encouraged. Please feel free to request new features, suggest improvements and file bug reports. Read more about contributing [here](https://github.com/speedment/speedment/blob/master/CONTRIBUTING.md). 



## Quick Start

Assuming you have Maven installed and a relational database available, you can start using Speedment in a minute:

* [Start a New Speedment Maven Project](https://github.com/speedment/speedment/wiki/Start-a-New-Speedment-Maven-Project)

* [Connect to Your Database](https://github.com/speedment/speedment/wiki/Connect-to-Your-Database)

## Expressing SQL as Java Streams

There is a remarkable resemblance between Java streams and SQL as summarized in the simplified table. This means there is no need for manually writing SQL-queries any more. You can remain in a pure Java world!



#### Example

Search in a film database for a film with a length greater than 120 minutes:

```java

// Searches are optimized in the background!

Optional longFilm = films.stream()

    .filter(Film.LENGTH.greaterThan(120))

    .findAny();

``` 

Results in the following SQL query:

```sql

SELECT 

    `film_id`,`title`,`description`,`release_year`,

    `language_id`,`original_language_id`,`rental_duration`,`rental_rate`,

    `length`,`replacement_cost`,`rating`,`special_features`,

    `last_update` 

FROM 

     `sakila`.`film`

WHERE

    (`length` > 120)

```




## Features

Speedment is equipped with the features listed below and more. 

### View Database Tables as Standard Java Streams



* **Pure Java** - Stream API instead of SQL eliminates the need of a query language


* **Dynamic Joins** - Ability to perform joins as Java streams on the application side


* **Parallel Streams** - Workload can automatically be divided over several threads





### Short and Concise Type Safe Code 



* **Code Generation** - Automatic Java representation of the latest state of your database eliminates boilerplate code and the need of manually writing Java Entity classes while minimizing the risk for bugs.


* **Null Protection** - Minimizes the risk involved with database null values by wrapping to Java Optionals


* **Enum Integration** - Mapping of String columns to Java Enums increases memory efficiency and type safety




### Lazy Evaluation for Increased Performance

* **Streams are Lazy** - Content from the database is pulled as elements are needed and consumed


* **Pipeline Introspection** - Optimized performance by short circuiting of stream operations


## Tutorials

The tutorials are divided into three sections. The basics are covered in the first section without any expected prior knowledge of Speedment. This builds a foundation of knowledge needed to fully benefit from the following tutorials.

#### Basics

* [Tutorial 1 - Hello Speedment](https://speedment.github.io/speedment-doc/tutorials.html#tutorial-1---hello-speedment)

* [Tutorial 2 - A First Stream from Speedment](https://speedment.github.io/speedment-doc/tutorials.html#tutorial-1---hello-speedment)

#### Sample applications

* [Tutorial 3 - Speedment Spring Boot Integration; REST assured - it is easy](https://speedment.github.io/speedment-doc/tutorials.html#tutorial-1---hello-speedment)

* [Tutorial 4 - Speedment filters based on Json Web Tokens](https://speedment.github.io/speedment-doc/tutorials.html#tutorial-1---hello-speedment)

* [Tutorial 5 - Log errors in a database](https://speedment.github.io/speedment-doc/tutorials.html#tutorial-5---log-errors-in-a-database)

* [Tutorial 6 - Use Speedment with Java EE](https://speedment.github.io/speedment-doc/tutorials.html#tutorial-5---log-errors-in-a-database)

* [Tutorial 7 - Create Event Sourced Systems](https://speedment.github.io/speedment-doc/tutorials.html#tutorial-5---log-errors-in-a-database)

* [Tutorial 8 - Writing Your Own Extensions](https://speedment.github.io/speedment-doc/tutorials.html#tutorial-8---writing-your-own-extensions)

#### Extending Speedment

* [Tutorial 9 - Formatting Your Output as JSON](https://speedment.github.io/speedment-doc/tutorials.html#tutorial-9---formatting-your-output-as-json)

* [Tutorial 10 - Working with BLOBS and CLOBS](https://speedment.github.io/speedment-doc/tutorials.html#tutorial-10---working-with-blobs-and-clobs)

## Resources 

* **Documentation** - Read the [Speedment User Guide](https://speedment.github.io/speedment-doc/index.html).

* **JavaDocs** - Latest [Speedment JavaDocs](https://www.javadoc.io/doc/com.speedment/runtime-deploy/latest/index.html). 

* **Examples** - There are 15 detailed examples [here](https://github.com/speedment/speedment/tree/master/example-parent) and more can be found in the User Guide provided above. 

* **Gitter Chatroom** - Reach out to the Speedment developers and other community members via [the Gitter chatroom](https://gitter.im/speedment/speedment). 

* **Creating a Pull Request** - Pull requests and improvement suggestions from the community are gladly accepted. Find more information [here](https://github.com/speedment/speedment/blob/master/CONTRIBUTING.md).

## Requirements

### Java Version

Speedment requires `Java 8` or later. Make sure your IDE is configured to use JDK 8 (version 1.8.0_40 or newer).

### Database Connectors

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

* MySQL

* MariaDB

* PostgreSQL

* SQLite

Enterprise database connectors include: 

* AS400

* Cassandra

* DB2

* Informix

* Oracle

* Snowflake

* SQL Server

For more information, see [Speedment Licensing and Pricing](https://speedment.com/pricing/). 

## Licenses

* **Speedment Open Source** - This site covers the Speedment Open Source project available under the 

[Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0). 

* **Speedment Stream** - The same great features as Speedment OSS with support for commercial databases. Learn more at [speedment.com/stream](http://speedment.com/stream).

* **Speedment HyperStream** - An extension av Speedment Stream which also includes hypersonic query performance enabled by a unique in-JVM-memory management model. Learn more at [speedment.com/hyperStream](http://speedment.com/hyperstream).

## Copyright

Copyright (c) 2014-2019, Speedment, Inc. All Rights Reserved.

Visit [www.speedment.com](http://www.speedment.com/) for more info.

[![Analytics](https://ga-beacon.appspot.com/UA-64937309-1/speedment/main)](https://github.com/igrigorik/ga-beacon)

[Github activity visualized](https://www.youtube.com/watch?v=Rmc_3lLZQpM)